Getting Started with OktoScript
Your first 5 minutes with OktoScript - A quick guide to get you up and running.
Prerequisites
- OktoSeek IDE installed (or OktoEngine CLI)
- Basic understanding of AI/ML concepts
- A dataset ready for training
Step 1: Create Your First Project
Create a new directory for your project:
mkdir my-first-model
cd my-first-model
Create a file named train.okt:
PROJECT "MyFirstModel"
DESCRIPTION "My first OktoScript project"
DATASET {
train: "dataset/train.jsonl"
format: "jsonl"
type: "chat"
}
MODEL {
base: "oktoseek/base-mini"
}
TRAIN {
epochs: 3
batch_size: 16
device: "cpu"
}
EXPORT {
format: ["okm"]
path: "export/"
}
Step 2: Prepare Your Dataset
Create a dataset/ folder and add your training data:
dataset/train.jsonl:
{"input":"Hello","output":"Hi! How can I help you?"}
{"input":"What's the weather?","output":"I don't have access to weather data."}
{"input":"Thank you","output":"You're welcome!"}
Minimum requirements:
- At least 10 examples for basic training
- Consistent format (JSONL recommended)
- Valid JSON on each line
Step 3: Validate Your Configuration
Before training, validate your OktoScript file:
okto validate train.okt
This checks:
- β Syntax is correct
- β All required fields are present
- β Dataset files exist
- β Model paths are valid
- β Values are within allowed ranges
Step 4: Train Your Model
Run the training:
okto run train.okt
Or use the IDE:
- Open
train.oktin OktoSeek IDE - Click "Train" button
- Monitor progress in real-time
What happens:
- Dataset is loaded and validated
- Model is initialized
- Training starts (you'll see progress)
- Model is saved to
runs/MyFirstModel/ - Exported models saved to
export/
Step 5: Test Your Model
After training, test with inference:
okto_infer --model ./runs/MyFirstModel --text "Hello"
Or add to your .okt file:
INFER {
input: "Hello, how are you?"
max_tokens: 50
}
Common First Steps
Adding Validation Data
DATASET {
train: "dataset/train.jsonl"
validation: "dataset/val.jsonl" # Add this
format: "jsonl"
}
Using GPU
TRAIN {
epochs: 5
batch_size: 32
device: "cuda" # Change from "cpu"
gpu: true
}
Adding Metrics
METRICS {
accuracy
loss
perplexity
}
Exporting to Multiple Formats
EXPORT {
format: ["gguf", "onnx", "okm"]
path: "export/"
}
Next Steps
- π Read the Complete Grammar Specification
- π― Check out Complex Examples
- π§ Learn about Troubleshooting
- π‘ Explore Extension Points
Quick Reference
| Task | Command |
|---|---|
| Validate | okto validate train.okt |
| Train | okto run train.okt |
| Infer | okto_infer --model ./runs/model --text "input" |
| Evaluate | okto_eval --model ./runs/model --dataset ./dataset/test.jsonl |
| Export | okto export --format gguf |
| Deploy | okto_deploy --model model --target api |
Need help? Check the Troubleshooting Guide or open an issue on GitHub.