Guide for checkpointing — saving, loading, and resuming training with CheckpointRecord. Use when the user asks about saving weights, resuming training, checkpoint management, or the checkpoint lifecycle.
日本語の概要は準備中です。原文の説明を表示しています。
Set up and run supervised fine-tuning (SFT) on instruction or chat datasets using the Tinker API. Use when the user wants to do instruction tuning, chat fine-tuning, or supervised learning.
インストールする前に、エージェントに与えられる指示の中身を確認できます。
Help the user set up and run supervised fine-tuning using the Tinker API.
Ask the user (if not already specified):
meta-llama/Llama-3.1-8B, Qwen/Qwen3-8B). See docs/model-lineup.mdx for available models.Read these files for patterns and conventions:
tinker_cookbook/recipes/sl_basic.py — Minimal SFT exampletinker_cookbook/recipes/chat_sl/train.py — Full-featured chat SFT with evaltinker_cookbook/supervised/train.py — Core training looptinker_cookbook/supervised/data.py — Dataset construction helpersdocs/supervised-learning/sl-basic.mdx — Getting started guidedocs/supervised-learning/sl-hyperparams.mdx — Learning rate and batch size guidanceKey configuration decisions:
Match renderer to model family using model_info.get_recommended_renderer_name(model_name). Never hardcode renderer names.
hyperparam_utils.get_lr(model_name) for recommended LRTrainOnWhat.ALL_ASSISTANT_MESSAGES — Train on all assistant turns (most common)TrainOnWhat.LAST_ASSISTANT_MESSAGE — Train only on final assistant responseTrainOnWhat.EVERYTHING — Train on entire conversation including user messagesNoRobotsBuilder, Tulu3BuilderFromConversationFileBuilder(common_config=..., file_path="path/to/data.jsonl")tinker_cookbook/example_data/conversations.jsonlbatch_size: Number of tokens per training batch (default: 128 for basic, scale up as needed)num_epochs: Number of passes through the dataseteval_every: Evaluate every N batchesFollow the pattern from sl_basic.py:
import asyncio
import chz
import sys
from tinker_cookbook import cli_utils, model_info
from tinker_cookbook.supervised import train
from tinker_cookbook.renderers import TrainOnWhat
from tinker_cookbook.supervised.types import ChatDatasetBuilderCommonConfig
def build_config_blueprint() -> chz.Blueprint[train.Config]:
model_name = "meta-llama/Llama-3.1-8B"
renderer_name = model_info.get_recommended_renderer_name(model_name)
common_config = ChatDatasetBuilderCommonConfig(
model_name_for_tokenizer=model_name,
renderer_name=renderer_name,
max_length=32768,
batch_size=128,
train_on_what=TrainOnWhat.ALL_ASSISTANT_MESSAGES,
)
# Configure dataset builder here
dataset = ...
return chz.Blueprint(train.Config).apply({
"log_path": "/tmp/tinker-examples/my_sft_run",
"model_name": model_name,
"renderer_name": renderer_name,
"dataset_builder": dataset,
"learning_rate": 2e-4,
"lr_schedule": "linear",
"num_epochs": 1,
"eval_every": 8,
})
def main(config: train.Config):
cli_utils.check_log_dir(config.log_path, behavior_if_exists="ask")
asyncio.run(train.main(config))
if __name__ == "__main__":
blueprint = build_config_blueprint()
blueprint.make_from_argv(sys.argv[1:])
main(blueprint.make())
python -m tinker_cookbook.recipes.<recipe_name>
Override parameters from CLI: python -m tinker_cookbook.recipes.<recipe_name> learning_rate=1e-4 batch_size=256
If you created a new recipe, add a smoke test so CI catches regressions:
# tests/recipes/test_recipe_<name>.py
import pytest
from tests.helpers import run_recipe
@pytest.mark.integration
def test_<recipe_name>():
run_recipe(
"tinker_cookbook.recipes.<recipe_name>.train",
["behavior_if_log_dir_exists=delete", "batch_size=16"],
)
run_recipe() automatically passes max_steps=2 to the recipe, so it runs 2 training steps and exits cleanly. Tests are auto-discovered by CI and run daily. For unit-testable components (dataset processing, custom logic), add *_test.py files next to the source code.
After training, export weights using the tinker_cookbook.weights API:
from tinker_cookbook import weights
adapter_dir = weights.download(tinker_path="tinker://run-id/sampler_weights/final", output_dir="./adapter")
weights.build_hf_model(base_model="meta-llama/Llama-3.1-8B", adapter_path=adapter_dir, output_path="./model")
weights.publish_to_hf_hub(model_path="./model", repo_id="user/my-finetuned-model")
model_info.get_recommended_renderer_name() — never hardcode renderercli_utils.check_log_dir() to avoid clobbering previous runsexample_data/conversations.jsonlまだレビューはありません。使ってみた感想をお寄せください。
概要と使いどころ
Guide for checkpointing — saving, loading, and resuming training with CheckpointRecord. Use when the user asks about saving weights, resuming training, checkpoint management, or the checkpoint lifecycle.
日本語の概要は準備中です。原文の説明を表示しています。
Guide for testing conventions and CI pipelines — unit tests, integration smoke tests, pytest markers, and GitHub Actions workflows. Use when the user asks about testing, CI, running tests, or adding tests for a recipe.
日本語の概要は準備中です。原文の説明を表示しています。
Guide for using completers — TokenCompleter and MessageCompleter for text generation during RL rollouts and evaluation. Use when the user asks about generating text, completing messages, or using completers in RL environments.
日本語の概要は準備中です。原文の説明を表示しています。
Guide for contributing to the tinker-cookbook repo — development setup, code style, type checking, PR process, and design conventions. Use when the user asks about how to contribute, set up the dev environment, code style, or project conventions.
日本語の概要は準備中です。原文の説明を表示しています。
Guide for dataset construction — SupervisedDatasetBuilder, RLDatasetBuilder, ChatDatasetBuilder, and custom dataset creation from JSONL, HuggingFace, or conversation data. Use when the user asks about datasets, data loading, data preparation, or custom data formats.
日本語の概要は準備中です。原文の説明を表示しています。
Set up and run knowledge distillation (on-policy, off-policy, or multi-teacher) from a teacher model to a student model using the Tinker API. Use when the user wants to distill knowledge, compress models, or train a student from a teacher.
日本語の概要は準備中です。原文の説明を表示しています。