twinlab.Emulator.summarise

Emulator.summarise(verbose=False)

Get a summary of a trained emulator on the twinLab cloud.

This summary returns transformer diagnostics, with details about the input/output decomposition. It also returns the estimator diagnostics, detailing properties of the trained emulator. This information can help inform a user about the makeup of an emulator – for example, what kind of kernel was used.

Parameters:

verbose (bool, optional) – Display information about the operation while running.

Return type:

dict

Example

emulator = tl.Emulator("quickstart")
emulator.summarise()

{
    'estimator_diagnostics': ...,
    'transformer_diagnostics': ...,
}