Skip to main content

incin_telemetry/
lib.rs

1//! `incin-telemetry`: the UI-dependency-free wire protocol for training
2//! observability. Defines schema-versioned event types (`events`) and the
3//! `Reporter` trait contract (`reporter`) that a training-process emitter
4//! implements against. `emitter` provides the non-blocking, dual-channel
5//! `Reporter` implementation; `transport` provides the I/O sinks it drains
6//! into.
7#[macro_use]
8extern crate alloc;
9
10/// Asynchronous event emitter and transport fan-out.
11pub mod emitter;
12/// Error types and result alias for telemetry operations.
13pub mod err;
14/// Schema-versioned telemetry events (scalars, norms, memory, graph).
15pub mod events;
16/// Trait contract for telemetry reporters.
17pub mod reporter;
18/// Utilities for creating structured run directories.
19pub mod run_dir;
20/// File and IPC transport sinks for telemetry events.
21pub mod transport;
22
23/// Convenient re-exports for telemetry usage.
24pub mod prelude {
25    pub use crate::emitter::Emitter;
26    pub use crate::events::{
27        CURRENT_SCHEMA_VERSION, EpochEvent, Event, GradientNormEvent, GraphSnapshotEvent,
28        HyperparamEvent, MemoryEvent, ScalarEvent, WeightNormEvent,
29    };
30    pub use crate::reporter::Reporter;
31}