concept.ContrastiveModel
========================

.. currentmodule:: concept

.. add toctree option to make autodoc generate the pages

.. autoclass:: ContrastiveModel



Attributes table
~~~~~~~~~~~~~~~~

.. autosummary::

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





Methods table
~~~~~~~~~~~~~

.. autosummary::

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





Attributes
~~~~~~~~~~



.. autoattribute:: ContrastiveModel.CHECKPOINT_HYPER_PARAMS_KEY

.. autoattribute:: ContrastiveModel.CHECKPOINT_HYPER_PARAMS_NAME

.. autoattribute:: ContrastiveModel.CHECKPOINT_HYPER_PARAMS_TYPE

.. autoattribute:: ContrastiveModel.T_destination

.. autoattribute:: ContrastiveModel.automatic_optimization

.. autoattribute:: ContrastiveModel.call_super_init

.. autoattribute:: ContrastiveModel.current_epoch

.. autoattribute:: ContrastiveModel.device

.. autoattribute:: ContrastiveModel.device_mesh

.. autoattribute:: ContrastiveModel.dtype

.. autoattribute:: ContrastiveModel.dump_patches

.. autoattribute:: ContrastiveModel.example_input_array

.. autoattribute:: ContrastiveModel.fabric

.. autoattribute:: ContrastiveModel.global_rank

.. autoattribute:: ContrastiveModel.global_step

.. autoattribute:: ContrastiveModel.hparams

.. autoattribute:: ContrastiveModel.hparams_initial

.. autoattribute:: ContrastiveModel.local_rank

.. autoattribute:: ContrastiveModel.logger

.. autoattribute:: ContrastiveModel.loggers

.. autoattribute:: ContrastiveModel.on_gpu

.. autoattribute:: ContrastiveModel.strict_loading

.. autoattribute:: ContrastiveModel.trainer

.. autoattribute:: ContrastiveModel.training






Methods
~~~~~~~



.. automethod:: ContrastiveModel.add_cls_token

.. automethod:: ContrastiveModel.add_module

.. automethod:: ContrastiveModel.all_gather

.. automethod:: ContrastiveModel.all_gather_concat

.. automethod:: ContrastiveModel.apply

.. automethod:: ContrastiveModel.backward

.. automethod:: ContrastiveModel.bfloat16

.. automethod:: ContrastiveModel.buffers

.. automethod:: ContrastiveModel.children

.. automethod:: ContrastiveModel.clip_gradients

.. automethod:: ContrastiveModel.compile

.. automethod:: ContrastiveModel.configure_callbacks

.. automethod:: ContrastiveModel.configure_gradient_clipping

.. automethod:: ContrastiveModel.configure_model

.. automethod:: ContrastiveModel.configure_optimizers

.. automethod:: ContrastiveModel.configure_sharded_model

.. automethod:: ContrastiveModel.cpu

.. automethod:: ContrastiveModel.cuda

.. automethod:: ContrastiveModel.double

.. automethod:: ContrastiveModel.eval

.. automethod:: ContrastiveModel.extra_repr

.. automethod:: ContrastiveModel.float

.. automethod:: ContrastiveModel.forward

.. automethod:: ContrastiveModel.forward_pair

.. automethod:: ContrastiveModel.freeze

.. automethod:: ContrastiveModel.get_buffer

.. automethod:: ContrastiveModel.get_extra_state

.. automethod:: ContrastiveModel.get_parameter

.. automethod:: ContrastiveModel.get_submodule

.. automethod:: ContrastiveModel.half

.. automethod:: ContrastiveModel.ipu

.. automethod:: ContrastiveModel.load_from_checkpoint

.. automethod:: ContrastiveModel.load_state_dict

.. automethod:: ContrastiveModel.log

.. automethod:: ContrastiveModel.log_dict

.. automethod:: ContrastiveModel.log_metric

.. automethod:: ContrastiveModel.log_metrics_dict

.. automethod:: ContrastiveModel.lr_scheduler_step

.. automethod:: ContrastiveModel.lr_schedulers

.. automethod:: ContrastiveModel.manual_backward

.. automethod:: ContrastiveModel.mask_values

.. automethod:: ContrastiveModel.modules

.. automethod:: ContrastiveModel.mtia

.. automethod:: ContrastiveModel.named_buffers

.. automethod:: ContrastiveModel.named_children

.. automethod:: ContrastiveModel.named_modules

.. automethod:: ContrastiveModel.named_parameters

.. automethod:: ContrastiveModel.on_after_backward

.. automethod:: ContrastiveModel.on_after_batch_transfer

.. automethod:: ContrastiveModel.on_before_backward

.. automethod:: ContrastiveModel.on_before_batch_transfer

.. automethod:: ContrastiveModel.on_before_optimizer_step

.. automethod:: ContrastiveModel.on_before_zero_grad

.. automethod:: ContrastiveModel.on_fit_end

.. automethod:: ContrastiveModel.on_fit_start

.. automethod:: ContrastiveModel.on_load_checkpoint

.. automethod:: ContrastiveModel.on_predict_batch_end

.. automethod:: ContrastiveModel.on_predict_batch_start

.. automethod:: ContrastiveModel.on_predict_end

.. automethod:: ContrastiveModel.on_predict_epoch_end

.. automethod:: ContrastiveModel.on_predict_epoch_start

.. automethod:: ContrastiveModel.on_predict_model_eval

.. automethod:: ContrastiveModel.on_predict_start

.. automethod:: ContrastiveModel.on_save_checkpoint

.. automethod:: ContrastiveModel.on_test_batch_end

.. automethod:: ContrastiveModel.on_test_batch_start

.. automethod:: ContrastiveModel.on_test_end

.. automethod:: ContrastiveModel.on_test_epoch_end

.. automethod:: ContrastiveModel.on_test_epoch_start

.. automethod:: ContrastiveModel.on_test_model_eval

.. automethod:: ContrastiveModel.on_test_model_train

.. automethod:: ContrastiveModel.on_test_start

.. automethod:: ContrastiveModel.on_train_batch_end

.. automethod:: ContrastiveModel.on_train_batch_start

.. automethod:: ContrastiveModel.on_train_end

.. automethod:: ContrastiveModel.on_train_epoch_end

.. automethod:: ContrastiveModel.on_train_epoch_start

.. automethod:: ContrastiveModel.on_train_start

.. automethod:: ContrastiveModel.on_validation_batch_end

.. automethod:: ContrastiveModel.on_validation_batch_start

.. automethod:: ContrastiveModel.on_validation_end

.. automethod:: ContrastiveModel.on_validation_epoch_end

.. automethod:: ContrastiveModel.on_validation_epoch_start

.. automethod:: ContrastiveModel.on_validation_model_eval

.. automethod:: ContrastiveModel.on_validation_model_train

.. automethod:: ContrastiveModel.on_validation_model_zero_grad

.. automethod:: ContrastiveModel.on_validation_start

.. automethod:: ContrastiveModel.optimizer_step

.. automethod:: ContrastiveModel.optimizer_zero_grad

.. automethod:: ContrastiveModel.optimizers

.. automethod:: ContrastiveModel.pad_tensor

.. automethod:: ContrastiveModel.parameters

.. automethod:: ContrastiveModel.predict_dataloader

.. automethod:: ContrastiveModel.predict_step

.. automethod:: ContrastiveModel.prepare_data

.. automethod:: ContrastiveModel.print

.. automethod:: ContrastiveModel.register_backward_hook

.. automethod:: ContrastiveModel.register_buffer

.. automethod:: ContrastiveModel.register_forward_hook

.. automethod:: ContrastiveModel.register_forward_pre_hook

.. automethod:: ContrastiveModel.register_full_backward_hook

.. automethod:: ContrastiveModel.register_full_backward_pre_hook

.. automethod:: ContrastiveModel.register_load_state_dict_post_hook

.. automethod:: ContrastiveModel.register_load_state_dict_pre_hook

.. automethod:: ContrastiveModel.register_module

.. automethod:: ContrastiveModel.register_parameter

.. automethod:: ContrastiveModel.register_state_dict_post_hook

.. automethod:: ContrastiveModel.register_state_dict_pre_hook

.. automethod:: ContrastiveModel.remove_ignored_hparams

.. automethod:: ContrastiveModel.requires_grad_

.. automethod:: ContrastiveModel.save_hyperparameters

.. automethod:: ContrastiveModel.set_active_species

.. automethod:: ContrastiveModel.set_extra_state

.. automethod:: ContrastiveModel.set_submodule

.. automethod:: ContrastiveModel.setup

.. automethod:: ContrastiveModel.share_memory

.. automethod:: ContrastiveModel.state_dict

.. automethod:: ContrastiveModel.teardown

.. automethod:: ContrastiveModel.test_dataloader

.. automethod:: ContrastiveModel.test_step

.. automethod:: ContrastiveModel.to

.. automethod:: ContrastiveModel.to_empty

.. automethod:: ContrastiveModel.to_onnx

.. automethod:: ContrastiveModel.to_tensorrt

.. automethod:: ContrastiveModel.to_torchscript

.. automethod:: ContrastiveModel.toggle_optimizer

.. automethod:: ContrastiveModel.toggled_optimizer

.. automethod:: ContrastiveModel.train

.. automethod:: ContrastiveModel.train_dataloader

.. automethod:: ContrastiveModel.training_step

.. automethod:: ContrastiveModel.transfer_batch_to_device

.. automethod:: ContrastiveModel.type

.. automethod:: ContrastiveModel.unfreeze

.. automethod:: ContrastiveModel.untoggle_optimizer

.. automethod:: ContrastiveModel.val_dataloader

.. automethod:: ContrastiveModel.validation_step

.. automethod:: ContrastiveModel.xpu

.. automethod:: ContrastiveModel.zero_grad