neotune 0.5.0

Simple LLM fine-tuning — powered by TRL, LoRA, and DeepSpeed

neotune

Simple LLM fine-tuning — powered by TRL, LoRA, and DeepSpeed.

Three inputs: a model, your datasets, and hyperparameters.

Installation

pip install neotune

With optional extras:

pip install "neotune[ray]"       # Ray distributed training
pip install "neotune[logging]"   # MLflow + Weights & Biases
pip install "neotune[all]"       # everything

Quick Start

from neotune import finetune

results = finetune(
    model="meta-llama/Llama-3.1-8B-Instruct",
    datasets={"train": train_ds, "validation": val_ds},
    hyperparameters={"learning_rate": 2e-4, "num_train_epochs": 3},
)

Each dataset is a HuggingFace Dataset with a "text" column containing fully-formatted prompt/response strings.

Preparing Your Datasets

neotune expects you to bring your own HuggingFace Dataset objects with a "text" column.

From a HuggingFace dataset

from datasets import load_dataset
from transformers import AutoTokenizer

tokenizer = AutoTokenizer.from_pretrained("meta-llama/Llama-3.1-8B-Instruct")

ds = load_dataset("tatsu-lab/alpaca", split="train")

def format_example(example):
    messages = [
        {"role": "user", "content": example["instruction"]},
        {"role": "assistant", "content": example["output"]},
    ]
    return {"text": tokenizer.apply_chat_template(messages, tokenize=False)}

ds = ds.map(format_example, remove_columns=ds.column_names)
splits = ds.train_test_split(test_size=0.1, seed=42)

# splits["train"] and splits["test"] each have a "text" column

From a CSV file

from datasets import load_dataset
from transformers import AutoTokenizer

tokenizer = AutoTokenizer.from_pretrained("meta-llama/Llama-3.1-8B-Instruct")

ds = load_dataset("csv", data_files="data.csv", split="train")

def format_example(example):
    messages = [
        {"role": "user", "content": example["prompt"]},
        {"role": "assistant", "content": example["response"]},
    ]
    return {"text": tokenizer.apply_chat_template(messages, tokenize=False)}

ds = ds.map(format_example, remove_columns=ds.column_names)
splits = ds.train_test_split(test_size=0.1, seed=42)

API Reference

finetune(model, datasets, hyperparameters) -> dict

One-call convenience function. Returns test-set metrics if a "test" split was provided, otherwise an empty dict.

from neotune import finetune

results = finetune(
    model="meta-llama/Llama-3.1-8B-Instruct",
    datasets={"train": train_ds, "validation": val_ds, "test": test_ds},
    hyperparameters={"learning_rate": 2e-4},
)

NeoTune(model, datasets, hyperparameters)

Class-based API.

from neotune import NeoTune

nt = NeoTune(
    model="meta-llama/Llama-3.1-8B-Instruct",
    datasets={"train": train_ds, "validation": val_ds},
    hyperparameters={"num_train_epochs": 5, "output_dir": "./my-adapter"},
)

results = nt.train()

Parameters

model -- str HuggingFace model ID or local path.

datasets -- dict[str, Dataset] A dict of HuggingFace Dataset objects. "train" is required. "validation" and "test" are optional.

hyperparameters -- dict, optional Override any default. All keys are optional:

Key	Default	Description
Training
learning_rate	1e-4	Learning rate
num_train_epochs	3	Number of training epochs
batch_size	1	Per-device batch size
gradient_accumulation_steps	4	Gradient accumulation steps
warmup_ratio	0.03	Warmup ratio
weight_decay	0.01	Weight decay
bf16	True	bfloat16 mixed precision
gradient_checkpointing	False	Gradient checkpointing
logging_steps	10	Log every N steps
eval_steps	50	Evaluate every N steps
save_steps	100	Checkpoint every N steps
save_total_limit	3	Max checkpoints to keep
LoRA
lora_r	16	LoRA rank
lora_alpha	32	LoRA alpha
lora_dropout	0.05	LoRA dropout
lora_target_modules	["q_proj", "k_proj", ...]	Target modules
Output
output_dir	"./adapter-output"	Where to save the adapter
hf_repo	None	Push to HuggingFace Hub
DeepSpeed
ds_config	None	None (built-in ZeRO-2), a file path, or a dict
Data
max_len	2048	Max sequence length
dataset_text_field	"text"	Column name for training text

Methods

• .train() -> dict -- Fine-tune and return test metrics (if test split provided).
• .tokenizer -- Access the underlying tokenizer.

What neotune does for you

Under the hood, neotune wraps TRL's SFTTrainer with:

• A single flat hyperparameters dict instead of separate SFTConfig + LoraConfig
• Built-in DeepSpeed ZeRO-2 defaults
• Automatic tokenizer setup (pad token, etc.)
• One-call finetune() interface
• Hub push via hf_repo hyperparameter

Advanced Usage

Generative evaluation

from neotune.eval import generate_and_evaluate

results = generate_and_evaluate(
    model_id="meta-llama/Llama-3.1-8B-Instruct",
    adapter_dir="./my-adapter",
    test_ds=test_ds,
    prompt_col="instruction",
    label_col="expected_output",
)

Distributed training with DeepSpeed (CLI)

deepspeed --num_gpus 4 -m neotune.train --config config.yaml --mode train

Distributed training with Ray

python -m neotune.ray_train --config config.yaml --num_workers 4

Kubernetes (KubeRay)

See k8s/rayjob-lora-sft.yaml for a KubeRay RayJob template.

Environment Variables

Variable	Description
HF_TOKEN	HuggingFace access token (for gated models)
WANDB_API_KEY	Weights & Biases API key (optional)

Create a .env file in your working directory:

HF_TOKEN=your_token_here
WANDB_API_KEY=your_wandb_key_here

License

MIT