vak.models.parametric\_umap\_model.ParametricUMAPModel
======================================================

.. currentmodule:: vak.models.parametric_umap_model



.. autoclass:: ParametricUMAPModel
   :members:
   :show-inheritance:
   :inherited-members:

   
   .. automethod:: __init__

   
   .. rubric:: Methods

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

   
   
   .. rubric:: Attributes

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