Skip to content

GradientHQ/logits-cookbook

Repository files navigation

Logits Cookbook

logits_cookbook is a recipe library for training and evaluation on the Logits platform. It is built on the logits SDK and provides higher-level recipes, renderers, evaluation helpers, and end-to-end examples for Logits users.

Installation

  1. Create a Logits platform API key in your Logits console.
  2. Export it as LOGITS_API_KEY.
  3. Install the SDK and cookbook in a virtual environment.
pip install logits-sdk logits-cookbook

For local development on the cookbook itself:

pip install -e .

Backend Model

The cookbook builds on the same training, sampling, and checkpoint primitives exposed through logits. A minimal low-level flow looks like:

import logits

service_client = logits.ServiceClient()
training_client = service_client.create_lora_training_client(
  base_model="meta-llama/Llama-3.2-1B", rank=32,
)
training_client.forward_backward(...)
training_client.optim_step(...)
training_client.save_state(...)
training_client.load_state(...)

sampling_client = training_client.save_weights_and_get_sampling_client(name="my_model")
sampling_client.sample(...)

See logits_cookbook/recipes/sl_loop.py and logits_cookbook/recipes/rl_loop.py for minimal examples.

To download the weights of any model:

import urllib.request

rest_client = service_client.create_rest_client()

# Resolve a short-lived, pre-signed download URL for the checkpoint archive.
# `model_path` points at sampler weights, e.g. logits://<run>/sampler_weights/<name>.
archive = rest_client.get_checkpoint_archive_url_from_tinker_path(
    sampling_client.model_path
).result()

# `archive.url` is a pre-signed URL valid until `archive.expires`; fetch the archive.
urllib.request.urlretrieve(archive.url, "model-checkpoint.tar.gz")

Logits Cookbook

Besides these primitives, we also offer Logits Cookbook (a.k.a. this repo), a library of abstractions and starter scripts for customizing training environments.

The current primary getting-started path is the four starter scripts in logits_cookbook/recipes/:

  1. sl_basic.py: configuration-driven supervised learning starter.
  2. sl_loop.py: minimal supervised learning loop close to the raw API.
  3. rl_basic.py: configuration-driven reinforcement learning starter.
  4. rl_loop.py: minimal reinforcement learning loop close to the raw API.

The repository still contains additional recipe directories for more advanced or experimental workflows, but they are not part of the primary entry path above.

Documentation

The docs/ directory contains the Logits Cookbook documentation for install, training, checkpointing, and evaluation workflows.

Note: The documentation files use MDX format (Markdown with JSX), which includes some syntax that isn't standard Markdown. You may see things like import statements, <Callout> components, or curly-brace expressions. These are artifacts of our documentation framework - the actual content should still be readable as Markdown.

If you find errors or want to improve the documentation, edit files in docs/ directly.

Import our utilities

Logits Cookbook includes several utilities:

Additional utilities, including evaluation integrations, remain available in the repository but are outside the current primary getting-started path.

Development Setup

uv sync --extra dev
pre-commit install

This installs dev dependencies and registers pre-commit hooks that run ruff formatting and linting on every commit. CI enforces these checks on all pull requests.

Contributing

This project is built in the spirit of open science and collaborative development. We believe that the best tools emerge through community involvement and shared learning.

We welcome PR contributions.

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages