Skip to main content

DashboardServerExt

Struct DashboardServerExt 

Source
pub struct DashboardServerExt {
    pub config: DashboardConfig,
    pub loss_history: MetricHistory,
    pub lr_history: MetricHistory,
    pub grad_norm_history: MetricHistory,
    pub connected_clients: usize,
    pub messages_sent: u64,
    /* private fields */
}
Expand description

In-process training dashboard that records metric histories and can generate CSV / JSON summaries suitable for logging or downstream tools.

This is an in-process implementation that does not bind network sockets. For SSE streaming, see super::websocket::DashboardServer.

§Example

use trustformers_debug::dashboard_ws::metrics::{DashboardConfig, DashboardServerExt};

let mut server = DashboardServerExt::new(DashboardConfig::default());
server.record_metrics(10, 1.5, 1e-3, 0.9);
server.record_metrics(20, 1.2, 9e-4, 0.85);
let csv = server.format_metric_csv();
assert!(csv.contains("step"));

Fields§

§config: DashboardConfig§loss_history: MetricHistory§lr_history: MetricHistory§grad_norm_history: MetricHistory§connected_clients: usize§messages_sent: u64

Implementations§

Source§

impl DashboardServerExt

Source

pub fn new(config: DashboardConfig) -> Self

Creates a new in-process dashboard server with the given configuration.

Source

pub fn record_metrics(&mut self, step: u64, loss: f32, lr: f32, grad_norm: f32)

Records one training step into the internal metric histories.

Source

pub fn broadcast_message( &mut self, msg: &DashboardMessage, ) -> Result<(), DashboardError>

Appends a DashboardMessage to the internal broadcast buffer.

Returns DashboardError::BufferFull when the buffer is at capacity.

Source

pub fn buffered_messages(&self) -> &[DashboardMessage]

Returns all messages currently in the broadcast buffer (in order).

Source

pub fn clear_buffer(&mut self)

Clears the broadcast buffer.

Source

pub fn generate_summary_json(&self) -> String

Returns a JSON summary of all metric histories.

Includes the latest value, a 10-point trend (slope), and EMA (α = 0.1) for each of loss, lr, and grad_norm.

§Example
use trustformers_debug::dashboard_ws::metrics::{DashboardConfig, DashboardServerExt};

let mut s = DashboardServerExt::new(DashboardConfig::default());
s.record_metrics(1, 2.0, 1e-3, 0.5);
let json = s.generate_summary_json();
assert!(json.contains("\"loss\""));
Source

pub fn format_metric_csv(&self) -> String

Exports all recorded metrics as a CSV string.

Columns: step,loss,lr,grad_norm Rows are aligned by index — if one history is shorter it writes empty cells.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more