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 defining RL environments — the Env protocol, EnvGroupBuilder, RLDataset, and custom environment creation. Use when the user asks about RL environments, reward functions, or how to define custom tasks for RL training.
インストールする前に、エージェントに与えられる指示の中身を確認できます。
RL training requires environments that provide observations and rewards. This skill covers how to define and use them.
Read these for details:
tinker_cookbook/rl/types.py — Env, EnvGroupBuilder, RLDatasetBuilder, Trajectorydocs/rl/rl-envs.mdx — Custom environments guidetinker_cookbook/recipes/math_rl/math_env.py — Math environment exampletinker_cookbook/recipes/harbor_rl/harbor_env.py — Multi-turn sandbox environmenttinker_cookbook/rl/message_env.py — Message-based environment interfaceCONTRIBUTING.md — Env lifecycle and design conventionsfrom tinker_cookbook.rl.types import Env, Observation, Action, StepResult, StopCondition
class MyEnv(Env):
async def initial_observation(self) -> tuple[Observation, StopCondition]:
"""Return the initial prompt and stop condition."""
model_input = renderer.build_generation_prompt(messages)
stop = renderer.get_stop_sequences()
return model_input, stop
async def step(self, action: Action) -> StepResult:
"""Process model output and return next observation + reward."""
# action is TokensWithLogprobs (tokens + logprobs)
return StepResult(
observation=next_model_input,
stop_condition=stop,
reward=reward_value,
episode_done=True,
metrics={"accuracy": 1.0},
)
Important: Env objects are single-use — no reset method. Create fresh envs via EnvGroupBuilder each batch.
Creates a group of envs for the same prompt/task. Advantages are centered within each group (GRPO).
from tinker_cookbook.rl.types import EnvGroupBuilder, TrajectoryGroup
class MyEnvGroupBuilder(EnvGroupBuilder):
async def make_envs(self) -> Sequence[Env]:
"""Return group_size envs for the same task."""
return [MyEnv(problem=self.problem) for _ in range(self.group_size)]
async def compute_group_rewards(
self, trajectory_group: list[Trajectory], env_group: Sequence[Env]
) -> list[tuple[float, Metrics]]:
"""Compute final rewards for each trajectory in the group."""
return [(env.reward, {"solved": env.reward > 0}) for env in env_group]
def logging_tags(self) -> list[str]:
return ["my_task"]
Builds train/test datasets of EnvGroupBuilders:
@chz.chz
class MyDatasetBuilder(RLDatasetBuilder):
batch_size: int = 128
group_size: int = 4
async def __call__(self) -> tuple[RLDataset, RLDataset | None]:
# Return (train_dataset, optional_test_dataset)
...
@dataclass
class Transition:
ob: Observation # ModelInput
ac: TokensWithLogprobs # Action with logprobs
reward: float
episode_done: bool
@dataclass
class Trajectory:
transitions: list[Transition]
final_ob: Observation
@dataclass
class TrajectoryGroup:
trajectories_G: list[Trajectory]
final_rewards_G: list[float]
metrics_G: list[Metrics]
Model generates one response, gets a reward. See recipes/math_rl/math_env.py.
Model generates, environment responds, repeat. See recipes/harbor_rl/harbor_env.py and docs/rl/sequence-extension.mdx for KV-cache support.
Group of envs represents a game — envs within the group interact. See recipes/multiplayer_rl/text_arena/env.py.
Group of envs generates completions, preference model scores pairs. See tinker_cookbook/rl/preference_envs.py.
For scaling rollout collection, train.main() accepts an optional rollout_executor parameter:
from concurrent.futures import ProcessPoolExecutor
from tinker_cookbook.rl.train import main
await main(config, rollout_executor=ProcessPoolExecutor(max_workers=4))
EnvGroupBuilders must be pickleable for distributed execution. Test with tinker_cookbook/rl/builder_pickle_test.py.
_P = problems (different prompts/tasks)_G = groups (multiple rollouts per problem)_T = tokens (sequence position)_D = datums (training data items)Example: tokens_P_G_T[p][g][t] = token t of group g of problem p.
group_size affects variance reductionmax_steps_off_policy for async rollouts when env execution is slowまだレビューはありません。使ってみた感想をお寄せください。
概要と使いどころ
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.
日本語の概要は準備中です。原文の説明を表示しています。