torch\_concepts.nn.ConceptBottleneckModel
=========================================

.. currentmodule:: torch_concepts.nn

.. autoclass:: ConceptBottleneckModel

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~ConceptBottleneckModel.__init__
      ~ConceptBottleneckModel.add_module
      ~ConceptBottleneckModel.all_gather
      ~ConceptBottleneckModel.apply
      ~ConceptBottleneckModel.backward
      ~ConceptBottleneckModel.bfloat16
      ~ConceptBottleneckModel.buffers
      ~ConceptBottleneckModel.children
      ~ConceptBottleneckModel.clip_gradients
      ~ConceptBottleneckModel.compile
      ~ConceptBottleneckModel.configure_callbacks
      ~ConceptBottleneckModel.configure_gradient_clipping
      ~ConceptBottleneckModel.configure_model
      ~ConceptBottleneckModel.configure_optimizers
      ~ConceptBottleneckModel.configure_sharded_model
      ~ConceptBottleneckModel.cpu
      ~ConceptBottleneckModel.cuda
      ~ConceptBottleneckModel.double
      ~ConceptBottleneckModel.eval
      ~ConceptBottleneckModel.extra_repr
      ~ConceptBottleneckModel.filter_output_for_loss
      ~ConceptBottleneckModel.filter_output_for_metrics
      ~ConceptBottleneckModel.float
      ~ConceptBottleneckModel.forward
      ~ConceptBottleneckModel.freeze
      ~ConceptBottleneckModel.get_buffer
      ~ConceptBottleneckModel.get_extra_state
      ~ConceptBottleneckModel.get_parameter
      ~ConceptBottleneckModel.get_submodule
      ~ConceptBottleneckModel.half
      ~ConceptBottleneckModel.ipu
      ~ConceptBottleneckModel.load_from_checkpoint
      ~ConceptBottleneckModel.load_state_dict
      ~ConceptBottleneckModel.log
      ~ConceptBottleneckModel.log_dict
      ~ConceptBottleneckModel.log_loss
      ~ConceptBottleneckModel.log_metrics
      ~ConceptBottleneckModel.lr_scheduler_step
      ~ConceptBottleneckModel.lr_schedulers
      ~ConceptBottleneckModel.manual_backward
      ~ConceptBottleneckModel.maybe_apply_backbone
      ~ConceptBottleneckModel.modules
      ~ConceptBottleneckModel.mtia
      ~ConceptBottleneckModel.named_buffers
      ~ConceptBottleneckModel.named_children
      ~ConceptBottleneckModel.named_modules
      ~ConceptBottleneckModel.named_parameters
      ~ConceptBottleneckModel.on_after_backward
      ~ConceptBottleneckModel.on_after_batch_transfer
      ~ConceptBottleneckModel.on_before_backward
      ~ConceptBottleneckModel.on_before_batch_transfer
      ~ConceptBottleneckModel.on_before_optimizer_step
      ~ConceptBottleneckModel.on_before_zero_grad
      ~ConceptBottleneckModel.on_fit_end
      ~ConceptBottleneckModel.on_fit_start
      ~ConceptBottleneckModel.on_load_checkpoint
      ~ConceptBottleneckModel.on_predict_batch_end
      ~ConceptBottleneckModel.on_predict_batch_start
      ~ConceptBottleneckModel.on_predict_end
      ~ConceptBottleneckModel.on_predict_epoch_end
      ~ConceptBottleneckModel.on_predict_epoch_start
      ~ConceptBottleneckModel.on_predict_model_eval
      ~ConceptBottleneckModel.on_predict_start
      ~ConceptBottleneckModel.on_save_checkpoint
      ~ConceptBottleneckModel.on_test_batch_end
      ~ConceptBottleneckModel.on_test_batch_start
      ~ConceptBottleneckModel.on_test_end
      ~ConceptBottleneckModel.on_test_epoch_end
      ~ConceptBottleneckModel.on_test_epoch_start
      ~ConceptBottleneckModel.on_test_model_eval
      ~ConceptBottleneckModel.on_test_model_train
      ~ConceptBottleneckModel.on_test_start
      ~ConceptBottleneckModel.on_train_batch_end
      ~ConceptBottleneckModel.on_train_batch_start
      ~ConceptBottleneckModel.on_train_end
      ~ConceptBottleneckModel.on_train_epoch_end
      ~ConceptBottleneckModel.on_train_epoch_start
      ~ConceptBottleneckModel.on_train_start
      ~ConceptBottleneckModel.on_validation_batch_end
      ~ConceptBottleneckModel.on_validation_batch_start
      ~ConceptBottleneckModel.on_validation_end
      ~ConceptBottleneckModel.on_validation_epoch_end
      ~ConceptBottleneckModel.on_validation_epoch_start
      ~ConceptBottleneckModel.on_validation_model_eval
      ~ConceptBottleneckModel.on_validation_model_train
      ~ConceptBottleneckModel.on_validation_model_zero_grad
      ~ConceptBottleneckModel.on_validation_start
      ~ConceptBottleneckModel.optimizer_step
      ~ConceptBottleneckModel.optimizer_zero_grad
      ~ConceptBottleneckModel.optimizers
      ~ConceptBottleneckModel.parameters
      ~ConceptBottleneckModel.predict_dataloader
      ~ConceptBottleneckModel.predict_step
      ~ConceptBottleneckModel.prepare_data
      ~ConceptBottleneckModel.print
      ~ConceptBottleneckModel.register_backward_hook
      ~ConceptBottleneckModel.register_buffer
      ~ConceptBottleneckModel.register_forward_hook
      ~ConceptBottleneckModel.register_forward_pre_hook
      ~ConceptBottleneckModel.register_full_backward_hook
      ~ConceptBottleneckModel.register_full_backward_pre_hook
      ~ConceptBottleneckModel.register_load_state_dict_post_hook
      ~ConceptBottleneckModel.register_load_state_dict_pre_hook
      ~ConceptBottleneckModel.register_module
      ~ConceptBottleneckModel.register_parameter
      ~ConceptBottleneckModel.register_state_dict_post_hook
      ~ConceptBottleneckModel.register_state_dict_pre_hook
      ~ConceptBottleneckModel.remove_ignored_hparams
      ~ConceptBottleneckModel.requires_grad_
      ~ConceptBottleneckModel.save_hyperparameters
      ~ConceptBottleneckModel.set_extra_state
      ~ConceptBottleneckModel.set_submodule
      ~ConceptBottleneckModel.setup
      ~ConceptBottleneckModel.share_memory
      ~ConceptBottleneckModel.shared_step
      ~ConceptBottleneckModel.state_dict
      ~ConceptBottleneckModel.teardown
      ~ConceptBottleneckModel.test_dataloader
      ~ConceptBottleneckModel.test_step
      ~ConceptBottleneckModel.to
      ~ConceptBottleneckModel.to_empty
      ~ConceptBottleneckModel.to_onnx
      ~ConceptBottleneckModel.to_tensorrt
      ~ConceptBottleneckModel.to_torchscript
      ~ConceptBottleneckModel.toggle_optimizer
      ~ConceptBottleneckModel.toggled_optimizer
      ~ConceptBottleneckModel.train
      ~ConceptBottleneckModel.train_dataloader
      ~ConceptBottleneckModel.training_step
      ~ConceptBottleneckModel.transfer_batch_to_device
      ~ConceptBottleneckModel.type
      ~ConceptBottleneckModel.unfreeze
      ~ConceptBottleneckModel.unpack_batch
      ~ConceptBottleneckModel.untoggle_optimizer
      ~ConceptBottleneckModel.update_and_log_metrics
      ~ConceptBottleneckModel.update_metrics
      ~ConceptBottleneckModel.val_dataloader
      ~ConceptBottleneckModel.validation_step
      ~ConceptBottleneckModel.xpu
      ~ConceptBottleneckModel.zero_grad
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~ConceptBottleneckModel.CHECKPOINT_HYPER_PARAMS_KEY
      ~ConceptBottleneckModel.CHECKPOINT_HYPER_PARAMS_NAME
      ~ConceptBottleneckModel.CHECKPOINT_HYPER_PARAMS_TYPE
      ~ConceptBottleneckModel.T_destination
      ~ConceptBottleneckModel.automatic_optimization
      ~ConceptBottleneckModel.backbone
      ~ConceptBottleneckModel.call_super_init
      ~ConceptBottleneckModel.current_epoch
      ~ConceptBottleneckModel.device
      ~ConceptBottleneckModel.device_mesh
      ~ConceptBottleneckModel.dtype
      ~ConceptBottleneckModel.dump_patches
      ~ConceptBottleneckModel.example_input_array
      ~ConceptBottleneckModel.fabric
      ~ConceptBottleneckModel.global_rank
      ~ConceptBottleneckModel.global_step
      ~ConceptBottleneckModel.hparams
      ~ConceptBottleneckModel.hparams_initial
      ~ConceptBottleneckModel.latent_encoder
      ~ConceptBottleneckModel.local_rank
      ~ConceptBottleneckModel.logger
      ~ConceptBottleneckModel.loggers
      ~ConceptBottleneckModel.on_gpu
      ~ConceptBottleneckModel.strict_loading
      ~ConceptBottleneckModel.trainer
      ~ConceptBottleneckModel.training