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 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.
インストールする前に、エージェントに与えられる指示の中身を確認できます。
The cookbook uses the builder pattern for datasets: a *DatasetBuilder (config) builds a *Dataset (runtime).
Read these for details:
tinker_cookbook/supervised/types.py — SupervisedDatasetBuilder, ChatDatasetBuilder, ChatDatasetBuilderCommonConfigtinker_cookbook/supervised/data.py — Dataset construction helpers, FromConversationFileBuildertinker_cookbook/rl/types.py — RLDatasetBuilder, RLDatasetdocs/training-sampling.mdx — Data preparation basicsShared config for all chat-based dataset builders:
from tinker_cookbook.supervised.types import ChatDatasetBuilderCommonConfig
from tinker_cookbook.renderers import TrainOnWhat
common_config = ChatDatasetBuilderCommonConfig(
model_name_for_tokenizer="meta-llama/Llama-3.1-8B",
renderer_name="llama3",
max_length=32768, # Max sequence length
batch_size=128, # Tokens per batch
train_on_what=TrainOnWhat.ALL_ASSISTANT_MESSAGES,
)
from tinker_cookbook.recipes.chat_sl.chat_datasets import NoRobotsBuilder, Tulu3Builder
dataset = NoRobotsBuilder(common_config=common_config)
dataset = Tulu3Builder(common_config=common_config)
from tinker_cookbook.supervised.data import FromConversationFileBuilder
dataset = FromConversationFileBuilder(
common_config=common_config,
file_path="/path/to/data.jsonl",
test_size=100, # Hold out 100 examples for eval
shuffle_seed=42,
)
JSONL format — each line is a conversation:
{"messages": [{"role": "user", "content": "..."}, {"role": "assistant", "content": "..."}]}
See tinker_cookbook/example_data/conversations.jsonl for the expected format.
from tinker_cookbook.supervised.data import SupervisedDatasetFromHFDataset
dataset = SupervisedDatasetFromHFDataset(
hf_dataset=hf_dataset,
batch_size=128,
map_fn=lambda example: conversation_to_datum(
example["messages"], renderer, max_length, train_on_what
),
)
from tinker_cookbook.supervised.data import conversation_to_datum
# Full pipeline: messages → datum
datum = conversation_to_datum(messages, renderer, max_length, train_on_what)
# Or step by step:
model_input, weights = renderer.build_supervised_example(messages)
datum = datum_from_model_input_weights(model_input, weights, max_length)
RL datasets return batches of EnvGroupBuilder objects. See the /environments skill for details.
@chz.chz
class MyRLDatasetBuilder(RLDatasetBuilder):
batch_size: int = 128
group_size: int = 4
async def __call__(self) -> tuple[RLDataset, RLDataset | None]:
# Return (train_dataset, optional_test_dataset)
...
DPO uses comparison pairs (chosen vs rejected):
from tinker_cookbook.preference.dpo_datasets import DPODatasetBuilderFromComparisons
dataset = DPODatasetBuilderFromComparisons(
common_config=common_config,
comparison_builder=HHHComparisonBuilder(),
)
See tinker_cookbook/preference/dpo_datasets.py and tinker_cookbook/recipes/preference/datasets.py.
ChatDatasetBuilderCommonConfig for consistent tokenizer/renderer setupbatch_size is in tokens, not examples — larger sequences mean fewer examples per batchexample_data/conversations.jsonltest_size to hold out evaluation data from the same distribution@chz.chz) for config persistence and sweepsまだレビューはありません。使ってみた感想をお寄せください。
概要と使いどころ
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.
日本語の概要は準備中です。原文の説明を表示しています。
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.
日本語の概要は準備中です。原文の説明を表示しています。
Set up and run Direct Preference Optimization (DPO) training on preference datasets using the Tinker API. Use when the user wants to train with preference data, chosen/rejected pairs, or DPO.
日本語の概要は準備中です。原文の説明を表示しています。