burn_central_runtime/lib.rs
1//! # Burn Central Runtime
2//!
3//! This crate is the middle layer of the Burn Central SDK. It communicate directly with the
4//! generate crate created by Burn Central CLI and provide the necessary building block to execute
5//! training and inference routines.
6//!
7//! # Features
8//! - Extractor for training and inference arguments.
9//! - Wrapper for return type of training and inference routines.
10//! - Executor to run training and inference routines.
11//! - Error handling for runtime execution.
12//!
13//! # Hidden element
14//! This crate also expose some hidden elements that are only to be used by the code generated by
15//! Burn Central CLI. These elements are not meant to be used directly by the end user.
16
17mod error;
18mod executor;
19mod output;
20mod params;
21mod routine;
22mod telemetry;
23mod type_name;
24
25// TODO: document inference module (probably should use the module instead)
26#[doc(hidden)]
27pub mod inference;
28
29// Hide element that are only used internally by the gen crate.
30#[doc(hidden)]
31pub mod cli;
32
33pub use error::RuntimeError;
34pub use executor::{Executor, ExecutorBuilder};
35pub use params::{
36 args::{Args, ExperimentArgs},
37 artifact_loader::ArtifactLoader,
38 default::{Model, MultiDevice},
39};