pytorch\_forecasting.models.rnn.RecurrentNetwork
================================================

.. currentmodule:: pytorch_forecasting.models.rnn

.. autoclass:: RecurrentNetwork

   
   .. automethod:: __init__

   
   .. rubric:: Methods

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

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~RecurrentNetwork.CHECKPOINT_HYPER_PARAMS_KEY
      ~RecurrentNetwork.CHECKPOINT_HYPER_PARAMS_NAME
      ~RecurrentNetwork.CHECKPOINT_HYPER_PARAMS_SPECIAL_KEY
      ~RecurrentNetwork.CHECKPOINT_HYPER_PARAMS_TYPE
      ~RecurrentNetwork.T_destination
      ~RecurrentNetwork.__annotations__
      ~RecurrentNetwork.__dict__
      ~RecurrentNetwork.__doc__
      ~RecurrentNetwork.__jit_unused_properties__
      ~RecurrentNetwork.__module__
      ~RecurrentNetwork.__weakref__
      ~RecurrentNetwork._compiled_call_impl
      ~RecurrentNetwork._jit_is_scripting
      ~RecurrentNetwork._version
      ~RecurrentNetwork.automatic_optimization
      ~RecurrentNetwork.call_super_init
      ~RecurrentNetwork.categorical_groups_mapping
      ~RecurrentNetwork.categoricals
      ~RecurrentNetwork.current_epoch
      ~RecurrentNetwork.current_stage
      ~RecurrentNetwork.decoder_variables
      ~RecurrentNetwork.device
      ~RecurrentNetwork.device_mesh
      ~RecurrentNetwork.dtype
      ~RecurrentNetwork.dump_patches
      ~RecurrentNetwork.encoder_variables
      ~RecurrentNetwork.example_input_array
      ~RecurrentNetwork.fabric
      ~RecurrentNetwork.global_rank
      ~RecurrentNetwork.global_step
      ~RecurrentNetwork.hparams
      ~RecurrentNetwork.hparams_initial
      ~RecurrentNetwork.lagged_target_positions
      ~RecurrentNetwork.local_rank
      ~RecurrentNetwork.log_interval
      ~RecurrentNetwork.logger
      ~RecurrentNetwork.loggers
      ~RecurrentNetwork.n_targets
      ~RecurrentNetwork.on_gpu
      ~RecurrentNetwork.predicting
      ~RecurrentNetwork.reals
      ~RecurrentNetwork.static_variables
      ~RecurrentNetwork.strict_loading
      ~RecurrentNetwork.target_names
      ~RecurrentNetwork.target_positions
      ~RecurrentNetwork.trainer
      ~RecurrentNetwork.training
      ~RecurrentNetwork._parameters
      ~RecurrentNetwork._buffers
      ~RecurrentNetwork._non_persistent_buffers_set
      ~RecurrentNetwork._backward_pre_hooks
      ~RecurrentNetwork._backward_hooks
      ~RecurrentNetwork._is_full_backward_hook
      ~RecurrentNetwork._forward_hooks
      ~RecurrentNetwork._forward_hooks_with_kwargs
      ~RecurrentNetwork._forward_hooks_always_called
      ~RecurrentNetwork._forward_pre_hooks
      ~RecurrentNetwork._forward_pre_hooks_with_kwargs
      ~RecurrentNetwork._state_dict_hooks
      ~RecurrentNetwork._load_state_dict_pre_hooks
      ~RecurrentNetwork._state_dict_pre_hooks
      ~RecurrentNetwork._load_state_dict_post_hooks
      ~RecurrentNetwork._modules