﻿interscale.module.GCN
=====================

.. currentmodule:: interscale.module

.. add toctree option to make autodoc generate the pages

.. autoclass:: GCN



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

.. autosummary::

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





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

.. autosummary::

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





Attributes
~~~~~~~~~~



.. autoattribute:: GCN.CHECKPOINT_HYPER_PARAMS_KEY

.. autoattribute:: GCN.CHECKPOINT_HYPER_PARAMS_NAME

.. autoattribute:: GCN.CHECKPOINT_HYPER_PARAMS_TYPE

.. autoattribute:: GCN.T_destination

.. autoattribute:: GCN.automatic_optimization

.. autoattribute:: GCN.call_super_init

.. autoattribute:: GCN.current_epoch

.. autoattribute:: GCN.device

.. autoattribute:: GCN.device_mesh

.. autoattribute:: GCN.dtype

.. autoattribute:: GCN.dump_patches

.. autoattribute:: GCN.example_input_array

.. autoattribute:: GCN.fabric

.. autoattribute:: GCN.global_rank

.. autoattribute:: GCN.global_step

.. autoattribute:: GCN.hparams

.. autoattribute:: GCN.hparams_initial

.. autoattribute:: GCN.local_rank

.. autoattribute:: GCN.logger

.. autoattribute:: GCN.loggers

.. autoattribute:: GCN.on_gpu

.. autoattribute:: GCN.strict_loading

.. autoattribute:: GCN.trainer

.. autoattribute:: GCN.training






Methods
~~~~~~~



.. automethod:: GCN.add_module

.. automethod:: GCN.all_gather

.. automethod:: GCN.apply

.. automethod:: GCN.backward

.. automethod:: GCN.bfloat16

.. automethod:: GCN.buffers

.. automethod:: GCN.children

.. automethod:: GCN.clip_gradients

.. automethod:: GCN.compile

.. automethod:: GCN.configure_callbacks

.. automethod:: GCN.configure_gradient_clipping

.. automethod:: GCN.configure_model

.. automethod:: GCN.configure_optimizers

.. automethod:: GCN.configure_sharded_model

.. automethod:: GCN.cpu

.. automethod:: GCN.cuda

.. automethod:: GCN.double

.. automethod:: GCN.eval

.. automethod:: GCN.extra_repr

.. automethod:: GCN.float

.. automethod:: GCN.forward

.. automethod:: GCN.freeze

.. automethod:: GCN.from_config

.. automethod:: GCN.get_buffer

.. automethod:: GCN.get_extra_state

.. automethod:: GCN.get_local_embeddings

.. automethod:: GCN.get_model_summary

.. automethod:: GCN.get_parameter

.. automethod:: GCN.get_submodule

.. automethod:: GCN.half

.. automethod:: GCN.ipu

.. automethod:: GCN.load_from_checkpoint

.. automethod:: GCN.load_state_dict

.. automethod:: GCN.log

.. automethod:: GCN.log_dict

.. automethod:: GCN.lr_scheduler_step

.. automethod:: GCN.lr_schedulers

.. automethod:: GCN.manual_backward

.. automethod:: GCN.modules

.. automethod:: GCN.mtia

.. automethod:: GCN.named_buffers

.. automethod:: GCN.named_children

.. automethod:: GCN.named_modules

.. automethod:: GCN.named_parameters

.. automethod:: GCN.on_after_backward

.. automethod:: GCN.on_after_batch_transfer

.. automethod:: GCN.on_before_backward

.. automethod:: GCN.on_before_batch_transfer

.. automethod:: GCN.on_before_optimizer_step

.. automethod:: GCN.on_before_zero_grad

.. automethod:: GCN.on_fit_end

.. automethod:: GCN.on_fit_start

.. automethod:: GCN.on_load_checkpoint

.. automethod:: GCN.on_predict_batch_end

.. automethod:: GCN.on_predict_batch_start

.. automethod:: GCN.on_predict_end

.. automethod:: GCN.on_predict_epoch_end

.. automethod:: GCN.on_predict_epoch_start

.. automethod:: GCN.on_predict_model_eval

.. automethod:: GCN.on_predict_start

.. automethod:: GCN.on_save_checkpoint

.. automethod:: GCN.on_test_batch_end

.. automethod:: GCN.on_test_batch_start

.. automethod:: GCN.on_test_end

.. automethod:: GCN.on_test_epoch_end

.. automethod:: GCN.on_test_epoch_start

.. automethod:: GCN.on_test_model_eval

.. automethod:: GCN.on_test_model_train

.. automethod:: GCN.on_test_start

.. automethod:: GCN.on_train_batch_end

.. automethod:: GCN.on_train_batch_start

.. automethod:: GCN.on_train_end

.. automethod:: GCN.on_train_epoch_end

.. automethod:: GCN.on_train_epoch_start

.. automethod:: GCN.on_train_start

.. automethod:: GCN.on_validation_batch_end

.. automethod:: GCN.on_validation_batch_start

.. automethod:: GCN.on_validation_end

.. automethod:: GCN.on_validation_epoch_end

.. automethod:: GCN.on_validation_epoch_start

.. automethod:: GCN.on_validation_model_eval

.. automethod:: GCN.on_validation_model_train

.. automethod:: GCN.on_validation_model_zero_grad

.. automethod:: GCN.on_validation_start

.. automethod:: GCN.optimizer_step

.. automethod:: GCN.optimizer_zero_grad

.. automethod:: GCN.optimizers

.. automethod:: GCN.parameters

.. automethod:: GCN.predict

.. automethod:: GCN.predict_dataloader

.. automethod:: GCN.predict_step

.. automethod:: GCN.prepare_data

.. automethod:: GCN.print

.. automethod:: GCN.register_backward_hook

.. automethod:: GCN.register_buffer

.. automethod:: GCN.register_forward_hook

.. automethod:: GCN.register_forward_pre_hook

.. automethod:: GCN.register_full_backward_hook

.. automethod:: GCN.register_full_backward_pre_hook

.. automethod:: GCN.register_load_state_dict_post_hook

.. automethod:: GCN.register_load_state_dict_pre_hook

.. automethod:: GCN.register_module

.. automethod:: GCN.register_parameter

.. automethod:: GCN.register_state_dict_post_hook

.. automethod:: GCN.register_state_dict_pre_hook

.. automethod:: GCN.remove_ignored_hparams

.. automethod:: GCN.requires_grad_

.. automethod:: GCN.save_hyperparameters

.. automethod:: GCN.set_extra_state

.. automethod:: GCN.set_submodule

.. automethod:: GCN.setup

.. automethod:: GCN.share_memory

.. automethod:: GCN.state_dict

.. automethod:: GCN.teardown

.. automethod:: GCN.test_dataloader

.. automethod:: GCN.test_step

.. automethod:: GCN.to

.. automethod:: GCN.to_empty

.. automethod:: GCN.to_onnx

.. automethod:: GCN.to_tensorrt

.. automethod:: GCN.to_torchscript

.. automethod:: GCN.toggle_optimizer

.. automethod:: GCN.toggled_optimizer

.. automethod:: GCN.train

.. automethod:: GCN.train_dataloader

.. automethod:: GCN.training_step

.. automethod:: GCN.transfer_batch_to_device

.. automethod:: GCN.type

.. automethod:: GCN.unfreeze

.. automethod:: GCN.untoggle_optimizer

.. automethod:: GCN.val_dataloader

.. automethod:: GCN.validation_step

.. automethod:: GCN.xpu

.. automethod:: GCN.zero_grad


