Instructions to use deltakitsune/properly with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use deltakitsune/properly with Transformers:

# Use a pipeline as a high-level helper
from transformers import pipeline

pipe = pipeline("text-generation", model="deltakitsune/properly")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoModel
model = AutoModel.from_pretrained("deltakitsune/properly", dtype="auto")

llama-cpp-python

How to use deltakitsune/properly with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="deltakitsune/properly",
	filename="exports/gguf/run_95-fp16.gguf",
)

llm.create_chat_completion(
	messages = [
		{
			"role": "user",
			"content": "What is the capital of France?"
		}
	]
)

Notebooks
Google Colab
Kaggle
Local Apps

llama.cpp

How to use deltakitsune/properly with llama.cpp:

Install from brew

brew install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf deltakitsune/properly:Q8_0
# Run inference directly in the terminal:
llama-cli -hf deltakitsune/properly:Q8_0

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf deltakitsune/properly:Q8_0
# Run inference directly in the terminal:
llama-cli -hf deltakitsune/properly:Q8_0

Use pre-built binary

# Download pre-built binary from:
# https://github.com/ggerganov/llama.cpp/releases
# Start a local OpenAI-compatible server with a web UI:
./llama-server -hf deltakitsune/properly:Q8_0
# Run inference directly in the terminal:
./llama-cli -hf deltakitsune/properly:Q8_0

Build from source code

git clone https://github.com/ggerganov/llama.cpp.git
cd llama.cpp
cmake -B build
cmake --build build -j --target llama-server llama-cli
# Start a local OpenAI-compatible server with a web UI:
./build/bin/llama-server -hf deltakitsune/properly:Q8_0
# Run inference directly in the terminal:
./build/bin/llama-cli -hf deltakitsune/properly:Q8_0

Use Docker

docker model run hf.co/deltakitsune/properly:Q8_0

LM Studio
Jan

vLLM

How to use deltakitsune/properly with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "deltakitsune/properly"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "deltakitsune/properly",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/deltakitsune/properly:Q8_0

SGLang

How to use deltakitsune/properly with SGLang:

Install from pip and serve model

# Install SGLang from pip:
pip install sglang
# Start the SGLang server:
python3 -m sglang.launch_server \
    --model-path "deltakitsune/properly" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "deltakitsune/properly",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker images

docker run --gpus all \
    --shm-size 32g \
    -p 30000:30000 \
    -v ~/.cache/huggingface:/root/.cache/huggingface \
    --env "HF_TOKEN=<secret>" \
    --ipc=host \
    lmsysorg/sglang:latest \
    python3 -m sglang.launch_server \
        --model-path "deltakitsune/properly" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "deltakitsune/properly",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Ollama
How to use deltakitsune/properly with Ollama:
```
ollama run hf.co/deltakitsune/properly:Q8_0
```

Unsloth Studio new

How to use deltakitsune/properly with Unsloth Studio:

Install Unsloth Studio (macOS, Linux, WSL)

curl -fsSL https://unsloth.ai/install.sh | sh
# Run unsloth studio
unsloth studio -H 0.0.0.0 -p 8888
# Then open http://localhost:8888 in your browser
# Search for deltakitsune/properly to start chatting

Install Unsloth Studio (Windows)

irm https://unsloth.ai/install.ps1 | iex
# Run unsloth studio
unsloth studio -H 0.0.0.0 -p 8888
# Then open http://localhost:8888 in your browser
# Search for deltakitsune/properly to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for deltakitsune/properly to start chatting

Docker Model Runner
How to use deltakitsune/properly with Docker Model Runner:
```
docker model run hf.co/deltakitsune/properly:Q8_0
```

Lemonade

How to use deltakitsune/properly with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull deltakitsune/properly:Q8_0

Run and chat with the model

lemonade run user.properly-Q8_0

List all available models

lemonade list

deltakitsune commited on 24 days ago

Commit

a64d359

verified ·

1 Parent(s): 1d34b83

Update README.md

Browse files

Files changed (1) hide show

README.md +42 -2

README.md CHANGED Viewed

@@ -10,7 +10,7 @@ tags:
 - text-generation
 - properly-e4-91e3-2
 - custom-dataset
-license: other
 datasets:
 - deltakitsune/properly-v1.04
 - deltakitsune/properly-v1.03
@@ -18,12 +18,52 @@ datasets:
 - deltakitsune/properly-v1.01
 ---
 # Properly-E4-91E3-2
 ## Summary
 - Training run: #95
-- Base model: `Local artifact (path omitted)`
 - Artifact: `Local artifact (path omitted)`
 - Status: completed
 - Started: 2026-04-30T04:00:32.996087+00:00

 - text-generation
 - properly-e4-91e3-2
 - custom-dataset
+license: gemma
 datasets:
 - deltakitsune/properly-v1.04
 - deltakitsune/properly-v1.03
 - deltakitsune/properly-v1.01
 ---
+![Wizard fox proofreading in library small ](https://cdn-uploads.huggingface.co/production/uploads/693f7a72a7dfa854483548cb/o09mPC_w2fagfCLiLWqrF.png)
+Properly is the proofreader that doesn't steal your voice. LoRA + Gemma 1B-IT.
+![Screenshot 2026-04-10 221131](https://cdn-uploads.huggingface.co/production/uploads/693f7a72a7dfa854483548cb/rab1bAZF0tRsg0KGFYmrA.jpeg)
+Created via _Kitsune : Forge_.<br>
+Local: RTX 5060 Ti 16GB
+This model ran through 4 epochs on curated dataset mixtures from Hugging Face, as noted in the dataset information.
+**Properly v1.01 — E1** During smoke testing, the adapted model performed simple edits, missed a few things, and added witty banter post-edit. And emojis.
+**Properly v1.02 — E2** Dropped emoji data and other social media datasets. The model improved but still loved emojis and missed a few spelling mistakes. It also treated most inputs like LinkedIn posts — complete with hashtags, occasional duplicates, and a fondness for the word "theorectical." Painful or philosophical, that misspelling proved the dataset gaps.
+**Properly v1.03 — E3** Added spelling data to the mix. Catches the majority of errors. No banter. Occasional rogue 🚀. Pretty solid across tested turns. "theorectical" became "theoretical."
+**Properly v1.04 — E4** Increased spelling and edit percentage, removed everything else, lowered steps. Adjusted learning rate from 1e-4 to 5e-5 and grad accumulation from 8 to 16. Determined that temp 0.5 with top_p 0.9 is ideal, paired with a system prompt. Eradicates most undesired behavior while preserving the author's voice. Drastically improved spelling correction. The model does struggle with informal conversational input — prompts like "OMG i loved that song im listening to" can produce a full conversation rather than a correction. This behavior has not appeared in typical email or post editing tests. A future training run should revise the dataset mix accordingly.
+---
+_This experimentation is meant for learning and to hopefully provide useful tools — or a reference for others to learn and experiment with. The model is functional but likely not ready for unsupervised use at this point. (Though imperfect spelling and grammar has its fans in certain circles...)_
+---
+### **Training Data**
+The training finished below target loss for a final product, but the model performs quite well for a 1B model on limited training and testing. The purpose was to understand model size, capability, dataset mixtures, and temperature behavior within the pipeline.
+![image](https://cdn-uploads.huggingface.co/production/uploads/693f7a72a7dfa854483548cb/GiQQw1TDek0HQsd6lS828.png)
+**System Prompt:** `You are Properly a helpful assistant. You fix grammar, spelling, and clarity. Preserve the author's voice. Return only the corrected text. No explanations. No commentary. No emojis or hashtags.`
+Baked in for Ollama. HuggingFace users will want to add this prompt manually.
+**Technical Stuff.**
 # Properly-E4-91E3-2
 ## Summary
 - Training run: #95
+- Base model: `google/gemma-3-1b-it`
 - Artifact: `Local artifact (path omitted)`
 - Status: completed
 - Started: 2026-04-30T04:00:32.996087+00:00