Struct TensorBoardWriter 

pub struct TensorBoardWriter { /* private fields */ }

TensorBoard event writer for logging scalars, histograms, and embeddings

Implementations

impl TensorBoardWriter

pub fn new<P: AsRef<Path>>(log_dir: P) -> Result<Self>

Create a new TensorBoard writer with the specified log directory

Arguments

• log_dir - Directory where TensorBoard logs will be written

Example

use trustformers_debug::TensorBoardWriter;

let writer = TensorBoardWriter::new("runs/experiment1").unwrap();

pub fn with_run_name<P: AsRef<Path>>( log_dir: P, run_name: String, ) -> Result<Self>

Create a new TensorBoard writer with a custom run name

pub fn add_scalar(&mut self, tag: &str, value: f64, step: u64) -> Result<()>

Add a scalar value to the log

Arguments

• tag - Name/identifier for this scalar
• value - Scalar value to log
• step - Training step number

Example

writer.add_scalar("loss/train", 0.5, 100).unwrap();
writer.add_scalar("accuracy/val", 0.95, 100).unwrap();

pub fn add_scalars( &mut self, main_tag: &str, tag_scalar_dict: HashMap<String, f64>, step: u64, ) -> Result<()>

Add multiple scalars at once

pub fn add_histogram( &mut self, tag: &str, values: &[f64], step: u64, ) -> Result<()>

Add a histogram of values

Arguments

• tag - Name/identifier for this histogram
• values - Array of values to create histogram from
• step - Training step number

Example

let weights = vec![0.1, 0.2, 0.15, 0.3, 0.25];
writer.add_histogram("layer.0.weight", &weights, 100).unwrap();

pub fn add_text(&mut self, tag: &str, text: &str, step: u64) -> Result<()>

Add text data for logging

pub fn add_embedding( &mut self, tag: &str, embeddings: Vec<Vec<f64>>, labels: Option<Vec<String>>, step: u64, ) -> Result<()>

Add embeddings for projector visualization

Arguments

• tag - Name for this embedding
• embeddings - 2D array of embedding vectors
• labels - Optional labels for each embedding
• step - Training step number

pub fn add_graph(&mut self, graph: &GraphDef) -> Result<()>

Add a graph definition for model architecture visualization

pub fn flush(&mut self) -> Result<()>

Flush all pending logs to disk

pub fn log_dir(&self) -> &Path

Get the path to the log directory

pub fn run_name(&self) -> &str

Get the current run name

pub fn increment_step(&mut self) -> u64

Increment the internal step counter

pub fn current_step(&self) -> u64

Get the current step counter value

pub fn close(self) -> Result<()>

Close the writer and flush all remaining data

Trait Implementations

impl Debug for TensorBoardWriter

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

Formats the value using the given formatter.

impl Drop for TensorBoardWriter

fn drop(&mut self)

Executes the destructor for this type.