Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Rust API

Browse the generated reference for the workspace libraries:

  • cherenkov: inference, model execution, storage, configuration, and serving.
  • cherenkov-model-data: checkpoint formats, tensor metadata, byte access, and store discovery interfaces.
  • xtask: repository automation, documentation builds, and benchmark tooling.

The reference includes private items to help contributors explore the internals. Private items are implementation details and can change without notice. Each reference has its own search and links to the Rust source. The book’s search covers the guide chapters.

The CLI is documented in Running. Cargo generates the library reference for each package; the binaries share their libraries’ names.

These links work on the published site or in a local site built with mise run docs. See building the documentation for details.