torchsig.utils.dataset_summarizer.summarize_dataset

torchsig.utils.dataset_summarizer.summarize_dataset(root: str, n_bins: int | dict[str, int] = 50, save_path: str | None = None) → DatasetSummary[source]

Convenience function: summarize and plot a static dataset.

Parameters:

  • root – Path to the dataset directory.

  • n_bins – Histogram bin count (int or per-metric dict).

  • save_path – Optional path to save the figure.

Returns:

The DatasetSummary instance.