Skip to main content

DebugVisualizer

Struct DebugVisualizer 

Source
pub struct DebugVisualizer { /* private fields */ }
Expand description

Debug visualizer that renders real plot documents to disk.

Every create_* / plot_* method renders the supplied data into a real document (a genuine SVG/HTML/JSON file with axes, points and colour-mapped cells derived from the caller’s numbers), writes it under VisualizationConfig::output_directory and returns that file’s path.

Formats this crate cannot encode without an optional raster backend (ImageFormat::PNG, PDF, LaTeX, MP4, GIF, WebM) are rejected with a structured error naming the missing encoder — they are never written out as SVG bytes under a misleading extension.

Implementations§

Source§

impl DebugVisualizer

Source

pub fn new(config: VisualizationConfig) -> Self

Source

pub fn with_default_config() -> Self

Source

pub fn config(&self) -> &VisualizationConfig

The configuration this visualizer renders with.

Source

pub fn create_line_plot(&mut self, data: &PlotData) -> Result<String>

Render a line plot and return the path of the file written.

Source

pub fn create_heatmap(&mut self, data: &HeatmapData) -> Result<String>

Render a heatmap and return the path of the file written.

Source

pub fn create_histogram(&mut self, data: &HistogramData) -> Result<String>

Render a histogram and return the path of the file written.

Source

pub fn plot_tensor_distribution( &mut self, name: &str, values: &[f64], bins: usize, ) -> Result<String>

Plot tensor distribution

Source

pub fn plot_training_metrics( &mut self, steps: &[f64], losses: &[f64], accuracies: Option<&[f64]>, ) -> Result<String>

Plot training metrics

Source

pub fn plot_gradient_flow( &mut self, layer_name: &str, steps: &[f64], gradient_norms: &[f64], ) -> Result<String>

Plot gradient flow

Source

pub fn plot_tensor_heatmap( &mut self, name: &str, values: &[Vec<f64>], ) -> Result<String>

Plot tensor heatmap

Source

pub fn plot_activation_patterns( &mut self, layer_name: &str, inputs: &[f64], outputs: &[f64], ) -> Result<String>

Plot activation patterns

Source

pub fn get_plot_names(&self) -> Vec<String>

Names of the plots this visualizer has actually rendered, in creation order.

Empty until something has been plotted — it is not a catalogue of what the visualizer could draw.

Source

pub fn get_plot(&self, name: &str) -> Option<&RenderedPlot>

Look up a rendered plot by title.

Source

pub fn create_dashboard(&mut self, plot_names: &[String]) -> Result<String>

Build a dashboard page embedding the named plots.

SVG/HTML renderings are inlined verbatim; a JSON rendering is linked by path (there is nothing to inline). Unknown names are rejected with a structured error listing what has actually been rendered, rather than emitting an empty card that looks like a plot.

Source

pub fn export_plot_data( &self, plot_name: &str, export_path: &Path, ) -> Result<()>

Export a rendered plot’s source data as JSON to export_path.

Errors when plot_name has not been rendered — the previous version wrote the literal string "Plot data for: <name>", which contained no plot data at all and succeeded for names that never existed.

Source

pub fn save_to_file(&self, filename: &str) -> Result<()>

Write the most recently rendered plot document to output_directory/filename.

Errors when nothing has been rendered yet, instead of writing the literal placeholder text the previous implementation emitted.

Trait Implementations§

Source§

impl Debug for DebugVisualizer

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

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