pytorch\_forecasting.models.base.\_base\_model\_v2.BaseModel
============================================================

.. currentmodule:: pytorch_forecasting.models.base._base_model_v2

.. autoclass:: BaseModel

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~BaseModel.__call__
      ~BaseModel.__delattr__
      ~BaseModel.__dir__
      ~BaseModel.__eq__
      ~BaseModel.__format__
      ~BaseModel.__ge__
      ~BaseModel.__getattr__
      ~BaseModel.__getattribute__
      ~BaseModel.__getstate__
      ~BaseModel.__gt__
      ~BaseModel.__hash__
      ~BaseModel.__init_subclass__
      ~BaseModel.__le__
      ~BaseModel.__lt__
      ~BaseModel.__ne__
      ~BaseModel.__new__
      ~BaseModel.__reduce__
      ~BaseModel.__reduce_ex__
      ~BaseModel.__repr__
      ~BaseModel.__setattr__
      ~BaseModel.__setstate__
      ~BaseModel.__sizeof__
      ~BaseModel.__str__
      ~BaseModel.__subclasshook__
      ~BaseModel._apply
      ~BaseModel._apply_batch_transfer_handler
      ~BaseModel._call_batch_hook
      ~BaseModel._call_impl
      ~BaseModel._get_backward_hooks
      ~BaseModel._get_backward_pre_hooks
      ~BaseModel._get_name
      ~BaseModel._get_optimizer
      ~BaseModel._get_scheduler
      ~BaseModel._load_from_state_dict
      ~BaseModel._log_dict_through_fabric
      ~BaseModel._maybe_warn_non_full_backward_hook
      ~BaseModel._named_members
      ~BaseModel._on_before_batch_transfer
      ~BaseModel._register_load_state_dict_pre_hook
      ~BaseModel._register_state_dict_hook
      ~BaseModel._replicate_for_data_parallel
      ~BaseModel._save_to_state_dict
      ~BaseModel._set_hparams
      ~BaseModel._slow_forward
      ~BaseModel._to_hparams_dict
      ~BaseModel._verify_is_manual_optimization
      ~BaseModel._wrapped_call_impl
      ~BaseModel.add_module
      ~BaseModel.all_gather
      ~BaseModel.apply
      ~BaseModel.backward
      ~BaseModel.bfloat16
      ~BaseModel.buffers
      ~BaseModel.children
      ~BaseModel.clip_gradients
      ~BaseModel.compile
      ~BaseModel.configure_callbacks
      ~BaseModel.configure_gradient_clipping
      ~BaseModel.configure_model
      ~BaseModel.configure_optimizers
      ~BaseModel.configure_sharded_model
      ~BaseModel.cpu
      ~BaseModel.cuda
      ~BaseModel.double
      ~BaseModel.eval
      ~BaseModel.extra_repr
      ~BaseModel.float
      ~BaseModel.forward
      ~BaseModel.freeze
      ~BaseModel.get_buffer
      ~BaseModel.get_extra_state
      ~BaseModel.get_parameter
      ~BaseModel.get_submodule
      ~BaseModel.half
      ~BaseModel.ipu
      ~BaseModel.load_from_checkpoint
      ~BaseModel.load_state_dict
      ~BaseModel.log
      ~BaseModel.log_dict
      ~BaseModel.log_metrics
      ~BaseModel.lr_scheduler_step
      ~BaseModel.lr_schedulers
      ~BaseModel.manual_backward
      ~BaseModel.modules
      ~BaseModel.mtia
      ~BaseModel.named_buffers
      ~BaseModel.named_children
      ~BaseModel.named_modules
      ~BaseModel.named_parameters
      ~BaseModel.on_after_backward
      ~BaseModel.on_after_batch_transfer
      ~BaseModel.on_before_backward
      ~BaseModel.on_before_batch_transfer
      ~BaseModel.on_before_optimizer_step
      ~BaseModel.on_before_zero_grad
      ~BaseModel.on_fit_end
      ~BaseModel.on_fit_start
      ~BaseModel.on_load_checkpoint
      ~BaseModel.on_predict_batch_end
      ~BaseModel.on_predict_batch_start
      ~BaseModel.on_predict_end
      ~BaseModel.on_predict_epoch_end
      ~BaseModel.on_predict_epoch_start
      ~BaseModel.on_predict_model_eval
      ~BaseModel.on_predict_start
      ~BaseModel.on_save_checkpoint
      ~BaseModel.on_test_batch_end
      ~BaseModel.on_test_batch_start
      ~BaseModel.on_test_end
      ~BaseModel.on_test_epoch_end
      ~BaseModel.on_test_epoch_start
      ~BaseModel.on_test_model_eval
      ~BaseModel.on_test_model_train
      ~BaseModel.on_test_start
      ~BaseModel.on_train_batch_end
      ~BaseModel.on_train_batch_start
      ~BaseModel.on_train_end
      ~BaseModel.on_train_epoch_end
      ~BaseModel.on_train_epoch_start
      ~BaseModel.on_train_start
      ~BaseModel.on_validation_batch_end
      ~BaseModel.on_validation_batch_start
      ~BaseModel.on_validation_end
      ~BaseModel.on_validation_epoch_end
      ~BaseModel.on_validation_epoch_start
      ~BaseModel.on_validation_model_eval
      ~BaseModel.on_validation_model_train
      ~BaseModel.on_validation_model_zero_grad
      ~BaseModel.on_validation_start
      ~BaseModel.optimizer_step
      ~BaseModel.optimizer_zero_grad
      ~BaseModel.optimizers
      ~BaseModel.parameters
      ~BaseModel.predict
      ~BaseModel.predict_dataloader
      ~BaseModel.predict_step
      ~BaseModel.prepare_data
      ~BaseModel.print
      ~BaseModel.register_backward_hook
      ~BaseModel.register_buffer
      ~BaseModel.register_forward_hook
      ~BaseModel.register_forward_pre_hook
      ~BaseModel.register_full_backward_hook
      ~BaseModel.register_full_backward_pre_hook
      ~BaseModel.register_load_state_dict_post_hook
      ~BaseModel.register_load_state_dict_pre_hook
      ~BaseModel.register_module
      ~BaseModel.register_parameter
      ~BaseModel.register_state_dict_post_hook
      ~BaseModel.register_state_dict_pre_hook
      ~BaseModel.remove_ignored_hparams
      ~BaseModel.requires_grad_
      ~BaseModel.save_hyperparameters
      ~BaseModel.set_extra_state
      ~BaseModel.set_submodule
      ~BaseModel.setup
      ~BaseModel.share_memory
      ~BaseModel.state_dict
      ~BaseModel.teardown
      ~BaseModel.test_dataloader
      ~BaseModel.test_step
      ~BaseModel.to
      ~BaseModel.to_empty
      ~BaseModel.to_onnx
      ~BaseModel.to_prediction
      ~BaseModel.to_quantiles
      ~BaseModel.to_tensorrt
      ~BaseModel.to_torchscript
      ~BaseModel.toggle_optimizer
      ~BaseModel.toggled_optimizer
      ~BaseModel.train
      ~BaseModel.train_dataloader
      ~BaseModel.training_step
      ~BaseModel.transfer_batch_to_device
      ~BaseModel.type
      ~BaseModel.unfreeze
      ~BaseModel.untoggle_optimizer
      ~BaseModel.val_dataloader
      ~BaseModel.validation_step
      ~BaseModel.xpu
      ~BaseModel.zero_grad
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~BaseModel.CHECKPOINT_HYPER_PARAMS_KEY
      ~BaseModel.CHECKPOINT_HYPER_PARAMS_NAME
      ~BaseModel.CHECKPOINT_HYPER_PARAMS_TYPE
      ~BaseModel.T_destination
      ~BaseModel._OPTIMIZER_REGISTRY
      ~BaseModel._SCHEDULER_REGISTRY
      ~BaseModel.__annotations__
      ~BaseModel.__dict__
      ~BaseModel.__doc__
      ~BaseModel.__jit_unused_properties__
      ~BaseModel.__module__
      ~BaseModel.__weakref__
      ~BaseModel._compiled_call_impl
      ~BaseModel._jit_is_scripting
      ~BaseModel._version
      ~BaseModel.automatic_optimization
      ~BaseModel.call_super_init
      ~BaseModel.current_epoch
      ~BaseModel.device
      ~BaseModel.device_mesh
      ~BaseModel.dtype
      ~BaseModel.dump_patches
      ~BaseModel.example_input_array
      ~BaseModel.fabric
      ~BaseModel.global_rank
      ~BaseModel.global_step
      ~BaseModel.hparams
      ~BaseModel.hparams_initial
      ~BaseModel.local_rank
      ~BaseModel.logger
      ~BaseModel.loggers
      ~BaseModel.on_gpu
      ~BaseModel.pkg
      ~BaseModel.strict_loading
      ~BaseModel.trainer
      ~BaseModel.training
      ~BaseModel._parameters
      ~BaseModel._buffers
      ~BaseModel._non_persistent_buffers_set
      ~BaseModel._backward_pre_hooks
      ~BaseModel._backward_hooks
      ~BaseModel._is_full_backward_hook
      ~BaseModel._forward_hooks
      ~BaseModel._forward_hooks_with_kwargs
      ~BaseModel._forward_hooks_always_called
      ~BaseModel._forward_pre_hooks
      ~BaseModel._forward_pre_hooks_with_kwargs
      ~BaseModel._state_dict_hooks
      ~BaseModel._load_state_dict_pre_hooks
      ~BaseModel._state_dict_pre_hooks
      ~BaseModel._load_state_dict_post_hooks
      ~BaseModel._modules