torchsig.utils.printing.dataset_metadata_repr

torchsig.utils.printing.dataset_metadata_repr(dataset_metadata) str[source]

Return a string representation of the object for debugging and inspection.

This method generates a string that provides a concise yet detailed summary of the object’s state, useful for debugging or interacting with the object in an interactive environment (e.g., REPL, Jupyter notebooks).

The __repr__ method is intended to give an unambiguous, readable string that represents the object. The returned string includes key attributes and their values, formatted in a way that can be interpreted back as code, i.e., it aims to provide a string that could be used to recreate the object (though not necessarily identical, as it is for debugging purposes).

Returns:

A detailed, formatted string that represents the object’s state, showing

key attributes and their current values.

Return type:

str