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 type_name;
23
24// TODO: document inference module (probably should use the module instead)
25#[doc(hidden)]
26pub mod inference;
27
28// Hide element that are only used internally by the gen crate.
29#[doc(hidden)]
30pub mod cli;
31
32pub use error::RuntimeError;
33pub use executor::{Executor, ExecutorBuilder};
34pub use params::{
35 args::{Args, ExperimentArgs},
36 artifact_loader::ArtifactLoader,
37 default::{Model, MultiDevice},
38};