arpes.deep_learning.interpret.Interpretation

class arpes.deep_learning.interpret.Interpretation(model: pytorch_lightning.LightningModule, train_dataloader: torch.utils.data.DataLoader, val_dataloaders: torch.utils.data.DataLoader, train: bool = True, val_index: int = 0)

Provides utilities to interpret predictions of a model.

Importantly, this is not intended to provide any model introspection tools.

__init__(model: pytorch_lightning.LightningModule, train_dataloader: torch.utils.data.DataLoader, val_dataloaders: torch.utils.data.DataLoader, train: bool = True, val_index: int = 0) → None

Methods

__delattr__(name, /)	Implement delattr(self, name).
__dir__()	Default dir() implementation.
__eq__(other)	Return self==value.
__format__(format_spec, /)	Default object formatter.
__ge__(value, /)	Return self>=value.
__getattribute__(name, /)	Return getattr(self, name).
__gt__(value, /)	Return self>value.
__init__(model, train_dataloader, ...[, ...])
__init_subclass__	This method is called when a class is subclassed.
__le__(value, /)	Return self<=value.
__lt__(value, /)	Return self<value.
__ne__(value, /)	Return self!=value.
__new__(**kwargs)
__post_init__()	Populates train_items and val_item_lists.
__reduce__()	Helper for pickle.
__reduce_ex__(protocol, /)	Helper for pickle.
__repr__()	Return repr(self).
__setattr__(name, value, /)	Implement setattr(self, name, value).
__sizeof__()	Size of object in memory, in bytes.
__str__()	Return str(self).
__subclasshook__	Abstract classes can override this to customize issubclass().
dataloader_to_item_list(dataloader)	Converts a data loader into a list of interpretation items corresponding to the data samples.
from_trainer(trainer)	Builds an interpreter from an instance of a pytorch_lightning.Trainer.
show([n_items, items, input_formatter, ...])	Plots a subset of the interpreted items.
top_losses([ascending])	Orders the items by loss.

Attributes

__annotations__
__dataclass_fields__
__dataclass_params__
__dict__
__doc__
__hash__
__module__
__weakref__	list of weak references to the object (if defined)
items	All of the InterpretationItem instances inside this instance.
train
val_index
model
train_dataloader
val_dataloaders
train_items
val_item_lists