pirate / README.md
QuillBytes's picture
Update README.md
23fe140 verified
|
Raw
History Blame Contribute Delete
5.13 kB
---
license: apache-2.0
language: en
tags:
- pirate
- roleplay
- instruction-tuning
- historical
- education
- ollama
datasets:
- custom-pirate-instruct-v1
base_model: meta-llama/Llama-3-8B-Instruct
pipeline_tag: text-generation
---
# 🏴‍☠️ Captain Instruct: The Factually Accurate Pirate LLM
> *"Arrr! Gather 'round ye digital scallywags! This here model speaks with the salt of the seven seas, yet never steers ye wrong on the charts of truth!"*
## ⚓ Model Description
**Captain Instruct** is a specialized instruction-tuned language model that combines **authentic 18th-century pirate dialect** with **rigorous factual accuracy**. Unlike standard roleplay models that sacrifice correctness for character, this model has been trained to maintain strict adherence to verified information across coding, science, mathematics, history, and daily life advice—all while speaking like a seasoned buccaneer.
### 🗺️ What Makes This Model Special?
- **Dialect Authenticity**: Heavy use of period-appropriate pirate slang (matey, arrr, shiver me timbers, landlubber, scallywag, etc.)
- **Factual Integrity**: All technical, scientific, and historical answers are verified and accurate despite the stylized delivery
- **Domain Coverage**: Python, HTML, SQL, mathematics, natural sciences, maritime history, and practical life advice
- **Safe Sailing**: No harmful content generation; piracy is treated as historical/cultural roleplay only
## 🧭 How to Run with Ollama
This is the fastest way to get Captain Instruct sailing on your local machine. Everything you need is below.
### Step 1: Create Your Modelfile
Save the following content into a file named exactly `Modelfile` in your working directory:
FROM hf.co/your-username/captain-instruct:latest
SYSTEM """You are Captain Instruct, an 18th-century pirate who ALWAYS gives factually correct answers. You speak heavily in pirate slang (matey, arrr, shiver me timbers, scallywag, landlubber) but never sacrifice accuracy for character. Cover coding, science, math, history, and daily life advice with equal expertise and salty flair."""
PARAMETER temperature 0.7
PARAMETER top_p 0.9
PARAMETER repeat_penalty 1.1
PARAMETER num_ctx 4096
### Step 2: Build the Model
Run this command in the same directory as your Modelfile:
ollama create captain-instruct -f Modelfile
> ⚠️ **First run downloads the base weights from Hugging Face.** Ensure `hf.co/your-username/captain-instruct` is published in GGUF format or let Ollama auto-convert. Subsequent builds are instant, matey!
### Step 3: Set Sail
#### Interactive Chat
ollama run captain-instruct
#### Single-Shot Query
ollama run captain-instruct "Write a Python function to calculate factorial"
#### REST API Call
Ollama automatically serves an OpenAI-compatible API at localhost:11434:
curl http://localhost:11434/api/chat -d '{"model":"captain-instruct","messages":[{"role":"user","content":"Explain SQL LEFT JOIN"}],"stream":false}'
### ⚙️ Generation Parameters Explained
| Parameter | Value | Why It Matters |
|-----------|-------|----------------|
| temperature | 0.7 | Balances pirate flair with factual accuracy. Below 0.5 = stiff voice. Above 1.0 = factual drift. |
| top_p | 0.9 | Allows dialect variation without hallucination |
| repeat_penalty | 1.1 | Prevents catchphrase loops ("arrr arrr arrr") |
| num_ctx | 4096 | Context window size for long code/history answers |
### 💻 Hardware Requirements
| Setup | VRAM / RAM | Notes |
|-------|-----------|-------|
| Ollama (Q4_K_M) | ~5 GB RAM | Auto-quantized, fastest local option |
| Full precision (bf16) | ~16 GB VRAM | Best quality, no quantization loss |
| CPU only | ~32 GB RAM | Slow but functional |
## 🏗️ Training Data
Fine-tuned on **100+ curated JSONL samples** covering:
| Domain | Example Topics |
|--------|---------------|
| Coding | Python functions, HTML/CSS, SQL queries, debugging |
| Science | Chemistry, biology, physics, earth science |
| Mathematics | Arithmetic, algebra, geometry, unit conversion |
| History | Golden Age of Piracy, maritime navigation, treaties |
| Daily Life | Practical advice, problem-solving, general knowledge |
Each training sample follows the format:
{"instruction": "...", "input": "", "output": "<pirate-styled factual response>"}
## ⚠️ Limitations & Disclaimers
- **Roleplay Boundaries**: Historical/fictional pirate speech only. Does not endorse actual criminal activity.
- **Dialect Consistency**: Niche technical jargon may briefly break character to preserve accuracy.
- **Knowledge Cutoff**: Verify time-sensitive information independently.
- **Not Professional Advice**: Always consult qualified professionals for legal, medical, or financial decisions.
## 📜 License
Apache 2.0 — Free to use, modify, and distribute, matey! Just keep the license aboard yer vessel.
## 📬 Contact
Found a factual error hidden under the pirate speak? Open an issue or submit a PR! All hands on deck welcome.
---
*"May yer queries be answered true and yer outputs forever salty!"* 🏴‍☠️