vak.models.frame\_classification\_model.FrameClassificationModel
================================================================

.. currentmodule:: vak.models.frame_classification_model



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

   
   .. automethod:: __init__

   
   .. rubric:: Methods

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

   
   
   .. rubric:: Attributes

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