xpdeep_model
Define the xpdeep explainable model.
XpdeepModel
#
Xpdeep Model class.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
feature_extraction |
The feature extraction model, responsible to extract the most important and coherent features prior to the task you want to achieve. |
required | |
task_learner |
The task learner model is responsible to achieve your task (classification etc.), given a set of meaningful extracted features. |
required | |
backbone |
The backbone model, having the same role as a traditional backbone model on a neural network. default None. |
required | |
decision_graph_parameters |
Internal parameters and architecture of the Xpdeep explainable model. |
required | |
seed |
Seed for reproducibility, default 0. |
required |
feature_extraction: TorchModel
#
task_learner: TorchModel
#
decision_graph_parameters: ModelDecisionGraphParameters
#
backbone: TorchModel | None = None
#
seed: int = 0
#
from_torch(fitted_schema: FittedSchema, feature_extraction: torch.nn.Module, task_learner: torch.nn.Module, decision_graph_parameters: ModelDecisionGraphParameters, backbone: torch.nn.Module | None = None) -> XpdeepModel
#
Build a xpdeep model from torch modules.
Source code in src/xpdeep/model/xpdeep_model.py
get_output_size(schema: FittedSchema) -> tuple[int, ...]
#
Infer the model output size without batch size as it is required to serialize a loss function.