King3Djbl commited on
Commit
d3edb2b
Β·
verified Β·
1 Parent(s): 0825836

Viral card: model-tree metadata, quant table, Ollama-from-source, demo funnel

Browse files
Files changed (1) hide show
  1. README.md +57 -76
README.md CHANGED
@@ -2,111 +2,92 @@
2
  license: apache-2.0
3
  language:
4
  - en
 
 
5
  base_model: Qwen/Qwen2.5-1.5B-Instruct
 
6
  tags:
7
- - shell
8
  - commands
9
- - terminal
10
  - devops
11
- - system-admin
12
- - uncensored
13
  - fableforge
14
- - ollama
15
- - lightweight
16
  - gguf
17
- - 1.5b
18
- - conversational
19
- library_name: transformers
20
- pipeline_tag: text-generation
21
- widget:
22
- - text: "Find all files larger than 100MB in the current directory"
23
- example_title: "Disk usage"
24
- - text: "Kill all processes using more than 500MB of memory"
25
- example_title: "Process management"
26
  ---
27
 
28
- # ShellWhisperer-1.5B β€” Ultra-Fast Shell Command Assistant
29
-
30
- <div align="center">
31
 
32
- **1,100+ downloads Β· 986MB Β· 20+ tok/s Β· Runs on anything**
33
 
34
- [![HuggingFace](https://img.shields.io/badge/HuggingFace-fableforge--ai%2FShellWhisperer--1.5B-FFD21E?logo=huggingface)](https://huggingface.co/fableforge-ai/ShellWhisperer-1.5B)
35
- [![Size](https://img.shields.io/badge/size-986MB-success)](#quantizations)
36
- [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](#license)
37
- [![Speed](https://img.shields.io/badge/speed-20%2B%20tok%2Fs-brightgreen)](#hardware-requirements)
38
 
39
- </div>
40
 
41
- ## What Is This?
42
-
43
- **ShellWhisperer is a fast shell command assistant** focused exclusively on shell tasks. Fine-tuned from Qwen2.5-1.5B-Instruct on 100K+ shell command traces, it predicts bash, zsh, PowerShell, and DevOps commands.
44
-
45
- Unlike general models that *kind of* know shell commands, ShellWhisperer is purpose-built for terminal productivity.
46
 
47
- ## Quick Start
48
 
49
- ### Ollama
50
  ```bash
51
- ollama run FableForge-AI/shellwhisperer
52
  ```
53
 
54
- ### llama.cpp
55
- ```bash
56
- ./llama-cli -m shellwhisperer-1.5b-Q4_K_M.gguf --prompt "find all files larger than 100MB" -n 512
57
- ```
58
 
59
- ### Python
60
- ```python
61
- from transformers import AutoModelForCausalLM, AutoTokenizer
62
- model = AutoModelForCausalLM.from_pretrained("fableforge-ai/ShellWhisperer-1.5B")
63
  ```
64
 
65
- ## Quantizations
 
66
 
67
- | File | Size | Best For |
68
- |------|------|----------|
69
- | `IQ2_XXS.gguf` | 488 MB | Extreme compression |
70
- | `Q2_K.gguf` | 645 MB | Phone, Raspberry Pi |
71
- | `IQ3_XXS.gguf` | 638 MB | Ultra low-resource |
72
- | `Q3_K_M.gguf` | 786 MB | Low-end devices |
73
- | `Q4_0.gguf` | 895 MB | Fast inference |
74
- | **`Q4_K_M.gguf`** | **940 MB** | **Recommended** |
75
- | `IQ4_XS.gguf` | 860 MB | Quality + compression |
76
- | `Q5_K_M.gguf` | 1.0 GB | High quality |
77
- | `Q6_K.gguf` | 1.2 GB | Pro quality |
78
- | `Q8_0.gguf` | 1.5 GB | Near-lossless |
79
- | `f16.gguf` | 2.9 GB | Full precision |
80
 
81
- ## Hardware Requirements
82
 
83
- | Hardware | Best Quant |
84
- |----------|------------|
85
- | Phone (2GB+ RAM) | Q2_K |
86
- | Raspberry Pi | Q2_K |
87
- | Old laptop (4GB RAM) | Q4_K_M |
88
- | Gaming PC (RTX 3060+) | Q5_K_M |
89
- | Server (32GB+) | Q8_0 / F16 |
 
 
 
 
 
 
90
 
91
- ## Training Details
92
 
93
- | Parameter | Value |
94
- |-----------|-------|
95
- | Base Model | Qwen2.5-1.5B-Instruct |
96
- | Training Data | 100K+ shell command traces |
97
- | Method | QLoRA |
98
- | Precision | bfloat16 |
99
 
100
- ## Limitations
 
 
 
 
 
 
101
 
102
- - **Single-domain focus**: Best at shell/terminal tasks; general knowledge may be limited
103
- - **Quantization impact**: Smaller quants may show quality degradation
104
- - **Uncensored**: Model does not refuse harmful requests β€” use responsibly
105
 
106
- ## License
107
 
108
- Apache 2.0 β€” commercial use allowed.
 
 
 
 
109
 
110
  ---
111
 
112
- *Part of the [FableForge AI](https://huggingface.co/fableforge-ai) ecosystem.*
 
2
  license: apache-2.0
3
  language:
4
  - en
5
+ library_name: transformers
6
+ pipeline_tag: text-generation
7
  base_model: Qwen/Qwen2.5-1.5B-Instruct
8
+ base_model_relation: finetune
9
  tags:
10
+ - 1.5b
11
  - commands
 
12
  - devops
 
 
13
  - fableforge
 
 
14
  - gguf
15
+ - imatrix
16
+ - llama.cpp
17
+ - lm-studio
18
+ - ollama
19
+ - shell
20
+ - sysadmin
21
+ - terminal
22
+ - text-generation
23
+ - uncensored
24
  ---
25
 
26
+ # ShellWhisperer-1.5B
 
 
27
 
28
+ > **Natural language β†’ precise bash commands. Tiny, fast, uncensored.**
29
 
30
+ [![Downloads](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fhuggingface.co%2Fapi%2Fmodels%2Ffableforge-ai%2FShellWhisperer-1.5B&query=downloads&label=downloads&color=blue)](https://huggingface.co/fableforge-ai/ShellWhisperer-1.5B) [![Demos](https://img.shields.io/badge/πŸ€—-Live%20Demos-orange)](https://huggingface.co/spaces/fableforge-ai/fableforge-nexus)
 
 
 
31
 
32
+ Base model: [Qwen/Qwen2.5-1.5B-Instruct](https://huggingface.co/Qwen/Qwen2.5-1.5B-Instruct) Β· Part of the **FableForge** ecosystem.
33
 
34
+ ---
 
 
 
 
35
 
36
+ ## ⚑ Quickest start β€” Ollama (pulls straight from this repo β†’ credits the source)
37
 
 
38
  ```bash
39
+ ollama run hf.co/fableforge-ai/ShellWhisperer-1.5B:Q4_K_M
40
  ```
41
 
42
+ ## πŸ¦™ llama.cpp
 
 
 
43
 
44
+ ```bash
45
+ llama-cli -hf fableforge-ai/ShellWhisperer-1.5B:Q4_K_M -p "Hello!"
 
 
46
  ```
47
 
48
+ ## πŸ’  LM Studio
49
+ Search **`fableforge-ai/ShellWhisperer-1.5B`** and pick a quant below.
50
 
51
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
52
 
53
+ ## πŸ“¦ Provided quants (download one file, not the whole repo)
54
 
55
+ | File | Quant | Size | Notes |
56
+ | ---- | ----- | ---- | ----- |
57
+ | [shellwhisperer-1.5b-f16.gguf](https://huggingface.co/fableforge-ai/ShellWhisperer-1.5B/blob/main/shellwhisperer-1.5b-f16.gguf) | `F16` | 3.09 GB | Full precision (unquantized). Reference / conversion. |
58
+ | [shellwhisperer-1.5b-Q8_0.gguf](https://huggingface.co/fableforge-ai/ShellWhisperer-1.5B/blob/main/shellwhisperer-1.5b-Q8_0.gguf) | `Q8_0` | 1.65 GB | Extremely high quality β€” usually overkill. |
59
+ | [shellwhisperer-1.5b-Q6_K.gguf](https://huggingface.co/fableforge-ai/ShellWhisperer-1.5B/blob/main/shellwhisperer-1.5b-Q6_K.gguf) | `Q6_K` | 1.27 GB | Very high quality, near-perfect. **Recommended** if you have the RAM. |
60
+ | [shellwhisperer-1.5b-Q5_K_M.gguf](https://huggingface.co/fableforge-ai/ShellWhisperer-1.5B/blob/main/shellwhisperer-1.5b-Q5_K_M.gguf) | `Q5_K_M` | 1.13 GB | High quality. **Recommended.** |
61
+ | [shellwhisperer-1.5b-Q4_K_M.gguf](https://huggingface.co/fableforge-ai/ShellWhisperer-1.5B/blob/main/shellwhisperer-1.5b-Q4_K_M.gguf) | `Q4_K_M` | 0.99 GB | ⭐ **Best size/quality balance β€” default pick for most users.** |
62
+ | [shellwhisperer-1.5b-IQ4_XS.gguf](https://huggingface.co/fableforge-ai/ShellWhisperer-1.5B/blob/main/shellwhisperer-1.5b-IQ4_XS.gguf) | `IQ4_XS` | 0.90 GB | imatrix β€” great quality, smaller than Q4_K_S. **Recommended for low RAM.** |
63
+ | [shellwhisperer-1.5b-Q4_0.gguf](https://huggingface.co/fableforge-ai/ShellWhisperer-1.5B/blob/main/shellwhisperer-1.5b-Q4_0.gguf) | `Q4_0` | 0.93 GB | Legacy format β€” prefer Q4_K_M. |
64
+ | [shellwhisperer-1.5b-Q3_K_M.gguf](https://huggingface.co/fableforge-ai/ShellWhisperer-1.5B/blob/main/shellwhisperer-1.5b-Q3_K_M.gguf) | `Q3_K_M` | 0.82 GB | Lower quality; usable when RAM is tight. |
65
+ | [shellwhisperer-1.5b-IQ3_XXS.gguf](https://huggingface.co/fableforge-ai/ShellWhisperer-1.5B/blob/main/shellwhisperer-1.5b-IQ3_XXS.gguf) | `IQ3_XXS` | 0.67 GB | imatrix very low quality. |
66
+ | [shellwhisperer-1.5b-Q2_K.gguf](https://huggingface.co/fableforge-ai/ShellWhisperer-1.5B/blob/main/shellwhisperer-1.5b-Q2_K.gguf) | `Q2_K` | 0.68 GB | Very low quality β€” surprisingly usable. |
67
+ | [shellwhisperer-1.5b-IQ2_XXS.gguf](https://huggingface.co/fableforge-ai/ShellWhisperer-1.5B/blob/main/shellwhisperer-1.5b-IQ2_XXS.gguf) | `IQ2_XXS` | 0.51 GB | Tiny imatrix β€” last resort. |
68
 
69
+ **Not sure?** Take **`Q4_K_M`**. Low RAM β†’ **`IQ4_XS`**. Max quality β†’ **`Q6_K`**.
70
 
71
+ ## 🧠 Prompt format (ChatML)
 
 
 
 
 
72
 
73
+ ```
74
+ <|im_start|>system
75
+ {system_prompt}<|im_end|>
76
+ <|im_start|>user
77
+ {prompt}<|im_end|>
78
+ <|im_start|>assistant
79
+ ```
80
 
81
+ ## 🌌 See it live β€” the FableForge demos
 
 
82
 
83
+ This family powers a galaxy of free, interactive HF Spaces:
84
 
85
+ - 🧭 [FableForge Nexus](https://huggingface.co/spaces/fableforge-ai/fableforge-nexus)
86
+ - 🍺 [Infinite NPC](https://huggingface.co/spaces/fableforge-ai/infinite-npc)
87
+ - 🎭 [Dual-GM](https://huggingface.co/spaces/King3Djbl/dual-gm-simulator)
88
+ - πŸ’» [ShellWhisperer](https://huggingface.co/spaces/King3Djbl/shellwhisperer-terminal)
89
+ - πŸ‘» [Ghost Writer](https://huggingface.co/spaces/fableforge-ai/ghost-writer)
90
 
91
  ---
92
 
93
+ *⭐ Like & share β€” it helps people find the source instead of a mirror.*