torch_concepts.nn.BlackBoxTaskOnly¶
- class BlackBoxTaskOnly(*args, lightning: bool = False, **kwargs)[source]¶
BlackBox model.
This model implements a standard neural network architecture for predicting tasks only, without explicit concept bottleneck or interpretable intermediate representations. It uses a backbone mapping the raw input to the latent representation, then a linear head.
- Parameters:
input_size (int) – Dimensionality of input features.
annotations (Annotations) – Annotation object for output variables.
lightning (bool, optional) – Enable Lightning training. Default False.
**kwargs – Additional arguments for BaseModel.
- task_annotations¶
Sub-annotation restricted to task concepts only. Use this to build
ConceptLoss/ConceptMetrics.- Type:
- task_concept_idx¶
Concept-level column indices used to slice the ground-truth target tensor to match the task-only output.
- Type:
List[int]
Example
>>> from torch_concepts.annotations import Annotations >>> ann = Annotations(labels=['c1', 'task'], cardinalities=[1, 1]) >>> model = BlackBoxTaskOnly(input_size=8, annotations=ann, task_names=['task']) >>> out = model(torch.randn(2, 8))
- __init__(input_size: int, annotations: Annotations, task_names: List[str] | str, lightning: bool = False, **kwargs) None[source]¶
Initialize internal Module state, shared by both nn.Module and ScriptModule.
Methods
__init__(input_size, annotations, task_names)Initialize internal Module state, shared by both nn.Module and ScriptModule.
add_module(name, module)Add a child module to the current module.
apply(fn)Apply
fnrecursively to every submodule (as returned by.children()) as well as self.bfloat16()Casts all floating point parameters and buffers to
bfloat16datatype.buffers([recurse])Return an iterator over module buffers.
build_query(ground_truth)Build query dict mapping each task name to its ground-truth column.
children()Return an iterator over immediate children modules.
compile(*args, **kwargs)Compile this Module's forward using
torch.compile().cpu()Move all model parameters and buffers to the CPU.
cuda([device])Move all model parameters and buffers to the GPU.
dist_kwargs_of(name)Distribution keyword arguments this model uses for concept
name.distribution_of(name)Distribution class this model uses for concept
name(by its type).double()Casts all floating point parameters and buffers to
doubledatatype.eval()Set the module in evaluation mode.
extra_repr()Return the extra representation of the module.
float()Casts all floating point parameters and buffers to
floatdatatype.forward([x, query, evidence])Forward pass through the BlackBoxTaskOnly model.
get_buffer(target)Return the buffer given by
targetif it exists, otherwise throw an error.get_extra_state()Return any extra state to include in the module's state_dict.
get_parameter(target)Return the parameter given by
targetif it exists, otherwise throw an error.get_submodule(target)Return the submodule given by
targetif it exists, otherwise throw an error.half()Casts all floating point parameters and buffers to
halfdatatype.ipu([device])Move all model parameters and buffers to the IPU.
load_state_dict(state_dict[, strict, assign])Copy parameters and buffers from
state_dictinto this module and its descendants.modules([remove_duplicate])Return an iterator over all modules in the network.
mtia([device])Move all model parameters and buffers to the MTIA.
named_buffers([prefix, recurse, ...])Return an iterator over module buffers, yielding both the name of the buffer as well as the buffer itself.
named_children()Return an iterator over immediate children modules, yielding both the name of the module as well as the module itself.
named_modules([memo, prefix, remove_duplicate])Return an iterator over all modules in the network, yielding both the name of the module as well as the module itself.
named_parameters([prefix, recurse, ...])Return an iterator over module parameters, yielding both the name of the parameter as well as the parameter itself.
parameters([recurse])Return an iterator over module parameters.
prepare_target(target)Slice target to task-only columns.
register_backward_hook(hook)Register a backward hook on the module.
register_buffer(name, tensor[, persistent])Add a buffer to the module.
register_forward_hook(hook, *[, prepend, ...])Register a forward hook on the module.
register_forward_pre_hook(hook, *[, ...])Register a forward pre-hook on the module.
register_full_backward_hook(hook[, prepend])Register a backward hook on the module.
register_full_backward_pre_hook(hook[, prepend])Register a backward pre-hook on the module.
register_load_state_dict_post_hook(hook)Register a post-hook to be run after module's
load_state_dict()is called.register_load_state_dict_pre_hook(hook)Register a pre-hook to be run before module's
load_state_dict()is called.register_module(name, module)Alias for
add_module().register_parameter(name, param)Add a parameter to the module.
register_state_dict_post_hook(hook)Register a post-hook for the
state_dict()method.register_state_dict_pre_hook(hook)Register a pre-hook for the
state_dict()method.requires_grad_([requires_grad])Change if autograd should record operations on parameters in this module.
set_extra_state(state)Set extra state contained in the loaded state_dict.
set_submodule(target, module[, strict])Set the submodule given by
targetif it exists, otherwise throw an error.setup_inference(inference[, ...])Instantiate and store the eval/train inference engines.
setup_metrics(metrics)Rebuild metrics with task-only annotations.
share_memory()state_dict(*args[, destination, prefix, ...])Return a dictionary containing references to the whole state of the module.
to(*args, **kwargs)Move and/or cast the parameters and buffers.
to_empty(*, device[, recurse])Move the parameters and buffers to the specified device without copying storage.
train([mode])Set the module in training mode.
type(dst_type)Casts all parameters and buffers to
dst_type.xpu([device])Move all model parameters and buffers to the XPU.
zero_grad([set_to_none])Reset gradients of all model parameters.
Attributes
T_destinationbackboneThe backbone mapping raw input to the latent representation.
call_super_initdump_patchesinferenceReturn the active inference engine based on train/eval mode.
supported_concept_typesvariable_dist_kwargsDefault keyword arguments per distribution class (e.g. relaxation temperature).
variable_distributionswhich distribution this model uses for each concept type (
'binary'/'categorical'/'continuous').training