Expand description
incin-telemetry: the UI-dependency-free wire protocol for training
observability. Defines schema-versioned event types (events) and the
Reporter trait contract (reporter) that a training-process emitter
implements against. emitter provides the non-blocking, dual-channel
Reporter implementation; transport provides the I/O sinks it drains
into.
Modules§
- emitter
- Asynchronous event emitter and transport fan-out.
Emitter: the first concrete implementor of thecrate::reporter::Reportertrait. - err
- Error types and result alias for telemetry operations.
Centralized error type for
incin-telemetry, mirroringincin-core’serr.rsconvention. This is astdcrate (nono_std/allocconstraint), sostd::paths are used directly. - events
- Schema-versioned telemetry events (scalars, norms, memory, graph).
Wire event schema for
incin-telemetry. - prelude
- Convenient re-exports for telemetry usage.
- reporter
- Trait contract for telemetry reporters.
The
Reportertrait: the call surface a training loop reports telemetry against.crate::emitter::Emitteris this crate’s concrete, non-blocking implementation (see its own docs); this trait exists soincin-viz/tests/future implementations only need to depend on the contract, notEmitteritself, deliberately avoiding the retired prototype’sWatcheranti-pattern (a lock-guarded state holder performing synchronous I/O inline with training). - run_dir
- Utilities for creating structured run directories. XDG-style run-directory resolution, run-id generation, and run enumeration (D-01 through D-04).
- transport
- File and IPC transport sinks for telemetry events.
Transport: a sink that durably records oneEventat a time. Implementors own their own I/O;write_eventmust never block the caller indefinitely (the futureemitter.rs’s writer thread is the only caller - Plan 07-02).