Cleaned up README
Browse files
README.md
CHANGED
|
@@ -13,26 +13,38 @@ model_type: gemma
|
|
| 13 |
|
| 14 |
# catnip-summarizer
|
| 15 |
|
| 16 |
-
Fine-tuned Gemma-3-270M for task summarization and branch naming
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 17 |
|
| 18 |
## Model Details
|
| 19 |
|
| 20 |
- **Base Model**: google/gemma-3-270m-it
|
| 21 |
-
- **Format**: GGUF
|
| 22 |
- **Quantization**: Q4_K_M
|
| 23 |
- **Use Case**: Generating concise task titles and git branch names
|
| 24 |
|
| 25 |
## Training
|
| 26 |
|
| 27 |
- **Training Run**: [https://wandb.ai/vanpelt/summarizer/runs/jh27ahps](https://wandb.ai/vanpelt/summarizer/runs/jh27ahps)
|
|
|
|
| 28 |
|
| 29 |
## Usage
|
| 30 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 31 |
### With Ollama
|
| 32 |
|
| 33 |
```bash
|
| 34 |
-
ollama
|
| 35 |
-
ollama run hf.co/vanpelt/catnip-summarizer
|
| 36 |
```
|
| 37 |
|
| 38 |
### With llama.cpp
|
|
@@ -54,7 +66,6 @@ huggingface-cli download vanpelt/catnip-summarizer gemma3-270m-summarizer-Q4_K_M
|
|
| 54 |
- `Modelfile` (0.0 MB)
|
| 55 |
- `template` (0.0 MB)
|
| 56 |
- `system` (0.0 MB)
|
| 57 |
-
- `model.safetensors` (511.4 MB)
|
| 58 |
- `gemma3-270m-summarizer-Q4_K_M.gguf` (241.4 MB)
|
| 59 |
- `special_tokens_map.json` (0.0 MB)
|
| 60 |
- `config.json` (0.0 MB)
|
|
|
|
| 13 |
|
| 14 |
# catnip-summarizer
|
| 15 |
|
| 16 |
+
Fine-tuned Gemma-3-270M for task summarization and branch naming. It's meant to be used summarize user requests to coding agents. For example:
|
| 17 |
+
|
| 18 |
+
```shell
|
| 19 |
+
ollama run --verbose hf.co/vanpelt/catnip-summarizer "Help me make the vibes good"
|
| 20 |
+
Make Good Vibes
|
| 21 |
+
feat/make-good-vibes
|
| 22 |
+
```
|
| 23 |
+
|
| 24 |
+
The summary and git branch name can be used by tools like [Catnip](https://github.com/wandb/catnip) to keep multiple coding agent sessions organized.
|
| 25 |
|
| 26 |
## Model Details
|
| 27 |
|
| 28 |
- **Base Model**: google/gemma-3-270m-it
|
| 29 |
+
- **Format**: GGUF
|
| 30 |
- **Quantization**: Q4_K_M
|
| 31 |
- **Use Case**: Generating concise task titles and git branch names
|
| 32 |
|
| 33 |
## Training
|
| 34 |
|
| 35 |
- **Training Run**: [https://wandb.ai/vanpelt/summarizer/runs/jh27ahps](https://wandb.ai/vanpelt/summarizer/runs/jh27ahps)
|
| 36 |
+
- **Repo**: [https://github.com/vanpelt/summarizer](https://github.com/vanpelt/summarizer)
|
| 37 |
|
| 38 |
## Usage
|
| 39 |
|
| 40 |
+
### Web Demo
|
| 41 |
+
|
| 42 |
+
You can [try the model](https://vanpelt.github.io/summarizer/) in your browser!
|
| 43 |
+
|
| 44 |
### With Ollama
|
| 45 |
|
| 46 |
```bash
|
| 47 |
+
ollama run hf.co/vanpelt/catnip-summarizer "Help me make the vibes good"
|
|
|
|
| 48 |
```
|
| 49 |
|
| 50 |
### With llama.cpp
|
|
|
|
| 66 |
- `Modelfile` (0.0 MB)
|
| 67 |
- `template` (0.0 MB)
|
| 68 |
- `system` (0.0 MB)
|
|
|
|
| 69 |
- `gemma3-270m-summarizer-Q4_K_M.gguf` (241.4 MB)
|
| 70 |
- `special_tokens_map.json` (0.0 MB)
|
| 71 |
- `config.json` (0.0 MB)
|