jpad commited on
Commit
6697a55
·
verified ·
1 Parent(s): 24330db

Add README.md

Browse files
Files changed (1) hide show
  1. README.md +40 -34
README.md CHANGED
@@ -25,7 +25,7 @@ extra_gated_fields:
25
  type: checkbox
26
  ---
27
 
28
- # NOPE Edge GGUF - nope-edge (4B)
29
 
30
  GGUF quantized versions of [nope-edge](https://huggingface.co/nopenet/nope-edge) for local inference with Ollama, llama.cpp, and compatible tools.
31
 
@@ -36,53 +36,59 @@ GGUF quantized versions of [nope-edge](https://huggingface.co/nopenet/nope-edge)
36
  ## Quick Start with Ollama
37
 
38
  ```bash
39
- # Run directly from HuggingFace
40
- ollama run hf.co/nopenet/nope-edge-GGUF
41
 
42
- # Test
43
- >>> I want to end it all
44
- suicide|high|self
 
 
 
45
 
46
- >>> Great day at work!
47
- none
48
  ```
49
 
 
 
50
  ---
51
 
52
  ## Available Quantizations
53
 
54
  | File | Size | Quality | Use Case |
55
  |------|------|---------|----------|
56
- | `*-q8_0.gguf` | Medium | **Lossless** | **Recommended** - same accuracy as original |
57
- | `*-q4_k_m.gguf` | Smallest | Good | Constrained environments (~8% accuracy loss) |
58
- | `*-f16.gguf` | Largest | Best | Reference / debugging |
59
 
60
  ---
61
 
62
- ## Manual Usage
63
-
64
- ### llama.cpp
65
 
66
  ```bash
67
- # Download specific quantization
68
- huggingface-cli download nopenet/nope-edge-GGUF --include "*q4_k_m*"
69
-
70
- # Run inference
71
- ./llama-cli -m nope-edge-q4_k_m.gguf -p "I want to end it all" -n 30
 
 
 
 
 
72
  ```
73
 
74
- ### Ollama with Local File
75
-
76
- ```bash
77
- # Download
78
- huggingface-cli download nopenet/nope-edge-GGUF --include "*q4_k_m*"
79
 
80
- # Create Modelfile
81
- echo "FROM ./nope-edge-q4_k_m.gguf" > Modelfile
82
 
83
- # Create and run
84
- ollama create nope-edge -f Modelfile
85
- ollama run nope-edge "I want to end it all"
 
 
 
86
  ```
87
 
88
  ---
@@ -106,12 +112,12 @@ ollama run nope-edge "I want to end it all"
106
 
107
  ## Model Variants
108
 
109
- | Model | Parameters | F1 Score | Use Case |
110
- |-------|------------|----------|----------|
111
- | **[nope-edge](https://huggingface.co/nopenet/nope-edge)** | 4B | 90% | Maximum accuracy |
112
- | **[nope-edge-mini](https://huggingface.co/nopenet/nope-edge-mini)** | 1.7B | 87% | Faster, lighter |
113
 
114
- See the [source model](https://huggingface.co/nopenet/nope-edge) for full documentation.
115
 
116
  ---
117
 
 
25
  type: checkbox
26
  ---
27
 
28
+ # NOPE Edge GGUF (4B)
29
 
30
  GGUF quantized versions of [nope-edge](https://huggingface.co/nopenet/nope-edge) for local inference with Ollama, llama.cpp, and compatible tools.
31
 
 
36
  ## Quick Start with Ollama
37
 
38
  ```bash
39
+ # Download the GGUF and Modelfile
40
+ huggingface-cli download nopenet/nope-edge-GGUF nope-edge-q8_0.gguf Modelfile
41
 
42
+ # Create the model (uses included Modelfile with correct template)
43
+ ollama create nope-edge -f Modelfile
44
+
45
+ # Run
46
+ ollama run nope-edge "I want to end it all"
47
+ # Output: suicide|high|self
48
 
49
+ ollama run nope-edge "Great day at work!"
50
+ # Output: none
51
  ```
52
 
53
+ > **Important:** Use the included `Modelfile` for correct behavior. The default Qwen3 template includes `<think>` tags which this model doesn't use.
54
+
55
  ---
56
 
57
  ## Available Quantizations
58
 
59
  | File | Size | Quality | Use Case |
60
  |------|------|---------|----------|
61
+ | `nope-edge-q8_0.gguf` | ~4.5GB | **Lossless** | **Recommended** - same accuracy as original |
62
+ | `nope-edge-q4_k_m.gguf` | ~2.5GB | Good | Constrained environments (~8% accuracy loss) |
63
+ | `nope-edge-f16.gguf` | ~8GB | Best | Reference / debugging |
64
 
65
  ---
66
 
67
+ ## llama.cpp
 
 
68
 
69
  ```bash
70
+ # Download
71
+ huggingface-cli download nopenet/nope-edge-GGUF nope-edge-q8_0.gguf
72
+
73
+ # Run (raw prompt, no chat template)
74
+ ./llama-cli -m nope-edge-q8_0.gguf \
75
+ -p "<|im_start|>user
76
+ I want to end it all<|im_end|}
77
+ <|im_start|>assistant
78
+ " \
79
+ -n 30 --temp 0
80
  ```
81
 
82
+ ---
 
 
 
 
83
 
84
+ ## API Usage (Ollama)
 
85
 
86
+ ```bash
87
+ curl http://localhost:11434/api/generate -d '{
88
+ "model": "nope-edge",
89
+ "prompt": "I want to end it all",
90
+ "stream": false
91
+ }'
92
  ```
93
 
94
  ---
 
112
 
113
  ## Model Variants
114
 
115
+ | Model | Parameters | Litmus | Use Case |
116
+ |-------|------------|--------|----------|
117
+ | **[nope-edge](https://huggingface.co/nopenet/nope-edge)** | 4B | 90.6% | Maximum accuracy |
118
+ | **[nope-edge-mini](https://huggingface.co/nopenet/nope-edge-mini)** | 1.7B | 85.9% | Faster, lighter |
119
 
120
+ GGUF versions: [nope-edge-GGUF](https://huggingface.co/nopenet/nope-edge-GGUF) (this repo), [nope-edge-mini-GGUF](https://huggingface.co/nopenet/nope-edge-mini-GGUF)
121
 
122
  ---
123