interscale.module.GIN ===================== .. currentmodule:: interscale.module .. add toctree option to make autodoc generate the pages .. autoclass:: GIN Attributes table ~~~~~~~~~~~~~~~~ .. autosummary:: ~GIN.CHECKPOINT_HYPER_PARAMS_KEY ~GIN.CHECKPOINT_HYPER_PARAMS_NAME ~GIN.CHECKPOINT_HYPER_PARAMS_TYPE ~GIN.T_destination ~GIN.automatic_optimization ~GIN.call_super_init ~GIN.current_epoch ~GIN.device ~GIN.device_mesh ~GIN.dtype ~GIN.dump_patches ~GIN.example_input_array ~GIN.fabric ~GIN.global_rank ~GIN.global_step ~GIN.hparams ~GIN.hparams_initial ~GIN.local_rank ~GIN.logger ~GIN.loggers ~GIN.on_gpu ~GIN.strict_loading ~GIN.trainer ~GIN.training Methods table ~~~~~~~~~~~~~ .. autosummary:: ~GIN.add_module ~GIN.all_gather ~GIN.apply ~GIN.backward ~GIN.bfloat16 ~GIN.buffers ~GIN.children ~GIN.clip_gradients ~GIN.compile ~GIN.configure_callbacks ~GIN.configure_gradient_clipping ~GIN.configure_model ~GIN.configure_optimizers ~GIN.configure_sharded_model ~GIN.cpu ~GIN.cuda ~GIN.double ~GIN.eval ~GIN.extra_repr ~GIN.float ~GIN.forward ~GIN.freeze ~GIN.from_config ~GIN.get_buffer ~GIN.get_extra_state ~GIN.get_local_embeddings ~GIN.get_model_summary ~GIN.get_parameter ~GIN.get_submodule ~GIN.half ~GIN.ipu ~GIN.load_from_checkpoint ~GIN.load_state_dict ~GIN.log ~GIN.log_dict ~GIN.lr_scheduler_step ~GIN.lr_schedulers ~GIN.manual_backward ~GIN.modules ~GIN.mtia ~GIN.named_buffers ~GIN.named_children ~GIN.named_modules ~GIN.named_parameters ~GIN.on_after_backward ~GIN.on_after_batch_transfer ~GIN.on_before_backward ~GIN.on_before_batch_transfer ~GIN.on_before_optimizer_step ~GIN.on_before_zero_grad ~GIN.on_fit_end ~GIN.on_fit_start ~GIN.on_load_checkpoint ~GIN.on_predict_batch_end ~GIN.on_predict_batch_start ~GIN.on_predict_end ~GIN.on_predict_epoch_end ~GIN.on_predict_epoch_start ~GIN.on_predict_model_eval ~GIN.on_predict_start ~GIN.on_save_checkpoint ~GIN.on_test_batch_end ~GIN.on_test_batch_start ~GIN.on_test_end ~GIN.on_test_epoch_end ~GIN.on_test_epoch_start ~GIN.on_test_model_eval ~GIN.on_test_model_train ~GIN.on_test_start ~GIN.on_train_batch_end ~GIN.on_train_batch_start ~GIN.on_train_end ~GIN.on_train_epoch_end ~GIN.on_train_epoch_start ~GIN.on_train_start ~GIN.on_validation_batch_end ~GIN.on_validation_batch_start ~GIN.on_validation_end ~GIN.on_validation_epoch_end ~GIN.on_validation_epoch_start ~GIN.on_validation_model_eval ~GIN.on_validation_model_train ~GIN.on_validation_model_zero_grad ~GIN.on_validation_start ~GIN.optimizer_step ~GIN.optimizer_zero_grad ~GIN.optimizers ~GIN.parameters ~GIN.predict ~GIN.predict_dataloader ~GIN.predict_step ~GIN.prepare_data ~GIN.print ~GIN.register_backward_hook ~GIN.register_buffer ~GIN.register_forward_hook ~GIN.register_forward_pre_hook ~GIN.register_full_backward_hook ~GIN.register_full_backward_pre_hook ~GIN.register_load_state_dict_post_hook ~GIN.register_load_state_dict_pre_hook ~GIN.register_module ~GIN.register_parameter ~GIN.register_state_dict_post_hook ~GIN.register_state_dict_pre_hook ~GIN.remove_ignored_hparams ~GIN.requires_grad_ ~GIN.save_hyperparameters ~GIN.set_extra_state ~GIN.set_submodule ~GIN.setup ~GIN.share_memory ~GIN.state_dict ~GIN.teardown ~GIN.test_dataloader ~GIN.test_step ~GIN.to ~GIN.to_empty ~GIN.to_onnx ~GIN.to_tensorrt ~GIN.to_torchscript ~GIN.toggle_optimizer ~GIN.toggled_optimizer ~GIN.train ~GIN.train_dataloader ~GIN.training_step ~GIN.transfer_batch_to_device ~GIN.type ~GIN.unfreeze ~GIN.untoggle_optimizer ~GIN.val_dataloader ~GIN.validation_step ~GIN.xpu ~GIN.zero_grad Attributes ~~~~~~~~~~ .. autoattribute:: GIN.CHECKPOINT_HYPER_PARAMS_KEY .. autoattribute:: GIN.CHECKPOINT_HYPER_PARAMS_NAME .. autoattribute:: GIN.CHECKPOINT_HYPER_PARAMS_TYPE .. autoattribute:: GIN.T_destination .. autoattribute:: GIN.automatic_optimization .. autoattribute:: GIN.call_super_init .. autoattribute:: GIN.current_epoch .. autoattribute:: GIN.device .. autoattribute:: GIN.device_mesh .. autoattribute:: GIN.dtype .. autoattribute:: GIN.dump_patches .. autoattribute:: GIN.example_input_array .. autoattribute:: GIN.fabric .. autoattribute:: GIN.global_rank .. autoattribute:: GIN.global_step .. autoattribute:: GIN.hparams .. autoattribute:: GIN.hparams_initial .. autoattribute:: GIN.local_rank .. autoattribute:: GIN.logger .. autoattribute:: GIN.loggers .. autoattribute:: GIN.on_gpu .. autoattribute:: GIN.strict_loading .. autoattribute:: GIN.trainer .. autoattribute:: GIN.training Methods ~~~~~~~ .. automethod:: GIN.add_module .. automethod:: GIN.all_gather .. automethod:: GIN.apply .. automethod:: GIN.backward .. automethod:: GIN.bfloat16 .. automethod:: GIN.buffers .. automethod:: GIN.children .. automethod:: GIN.clip_gradients .. automethod:: GIN.compile .. automethod:: GIN.configure_callbacks .. automethod:: GIN.configure_gradient_clipping .. automethod:: GIN.configure_model .. automethod:: GIN.configure_optimizers .. automethod:: GIN.configure_sharded_model .. automethod:: GIN.cpu .. automethod:: GIN.cuda .. automethod:: GIN.double .. automethod:: GIN.eval .. automethod:: GIN.extra_repr .. automethod:: GIN.float .. automethod:: GIN.forward .. automethod:: GIN.freeze .. automethod:: GIN.from_config .. automethod:: GIN.get_buffer .. automethod:: GIN.get_extra_state .. automethod:: GIN.get_local_embeddings .. automethod:: GIN.get_model_summary .. automethod:: GIN.get_parameter .. automethod:: GIN.get_submodule .. automethod:: GIN.half .. automethod:: GIN.ipu .. automethod:: GIN.load_from_checkpoint .. automethod:: GIN.load_state_dict .. automethod:: GIN.log .. automethod:: GIN.log_dict .. automethod:: GIN.lr_scheduler_step .. automethod:: GIN.lr_schedulers .. automethod:: GIN.manual_backward .. automethod:: GIN.modules .. automethod:: GIN.mtia .. automethod:: GIN.named_buffers .. automethod:: GIN.named_children .. automethod:: GIN.named_modules .. automethod:: GIN.named_parameters .. automethod:: GIN.on_after_backward .. automethod:: GIN.on_after_batch_transfer .. automethod:: GIN.on_before_backward .. automethod:: GIN.on_before_batch_transfer .. automethod:: GIN.on_before_optimizer_step .. automethod:: GIN.on_before_zero_grad .. automethod:: GIN.on_fit_end .. automethod:: GIN.on_fit_start .. automethod:: GIN.on_load_checkpoint .. automethod:: GIN.on_predict_batch_end .. automethod:: GIN.on_predict_batch_start .. automethod:: GIN.on_predict_end .. automethod:: GIN.on_predict_epoch_end .. automethod:: GIN.on_predict_epoch_start .. automethod:: GIN.on_predict_model_eval .. automethod:: GIN.on_predict_start .. automethod:: GIN.on_save_checkpoint .. automethod:: GIN.on_test_batch_end .. automethod:: GIN.on_test_batch_start .. automethod:: GIN.on_test_end .. automethod:: GIN.on_test_epoch_end .. automethod:: GIN.on_test_epoch_start .. automethod:: GIN.on_test_model_eval .. automethod:: GIN.on_test_model_train .. automethod:: GIN.on_test_start .. automethod:: GIN.on_train_batch_end .. automethod:: GIN.on_train_batch_start .. automethod:: GIN.on_train_end .. automethod:: GIN.on_train_epoch_end .. automethod:: GIN.on_train_epoch_start .. automethod:: GIN.on_train_start .. automethod:: GIN.on_validation_batch_end .. automethod:: GIN.on_validation_batch_start .. automethod:: GIN.on_validation_end .. automethod:: GIN.on_validation_epoch_end .. automethod:: GIN.on_validation_epoch_start .. automethod:: GIN.on_validation_model_eval .. automethod:: GIN.on_validation_model_train .. automethod:: GIN.on_validation_model_zero_grad .. automethod:: GIN.on_validation_start .. automethod:: GIN.optimizer_step .. automethod:: GIN.optimizer_zero_grad .. automethod:: GIN.optimizers .. automethod:: GIN.parameters .. automethod:: GIN.predict .. automethod:: GIN.predict_dataloader .. automethod:: GIN.predict_step .. automethod:: GIN.prepare_data .. automethod:: GIN.print .. automethod:: GIN.register_backward_hook .. automethod:: GIN.register_buffer .. automethod:: GIN.register_forward_hook .. automethod:: GIN.register_forward_pre_hook .. automethod:: GIN.register_full_backward_hook .. automethod:: GIN.register_full_backward_pre_hook .. automethod:: GIN.register_load_state_dict_post_hook .. automethod:: GIN.register_load_state_dict_pre_hook .. automethod:: GIN.register_module .. automethod:: GIN.register_parameter .. automethod:: GIN.register_state_dict_post_hook .. automethod:: GIN.register_state_dict_pre_hook .. automethod:: GIN.remove_ignored_hparams .. automethod:: GIN.requires_grad_ .. automethod:: GIN.save_hyperparameters .. automethod:: GIN.set_extra_state .. automethod:: GIN.set_submodule .. automethod:: GIN.setup .. automethod:: GIN.share_memory .. automethod:: GIN.state_dict .. automethod:: GIN.teardown .. automethod:: GIN.test_dataloader .. automethod:: GIN.test_step .. automethod:: GIN.to .. automethod:: GIN.to_empty .. automethod:: GIN.to_onnx .. automethod:: GIN.to_tensorrt .. automethod:: GIN.to_torchscript .. automethod:: GIN.toggle_optimizer .. automethod:: GIN.toggled_optimizer .. automethod:: GIN.train .. automethod:: GIN.train_dataloader .. automethod:: GIN.training_step .. automethod:: GIN.transfer_batch_to_device .. automethod:: GIN.type .. automethod:: GIN.unfreeze .. automethod:: GIN.untoggle_optimizer .. automethod:: GIN.val_dataloader .. automethod:: GIN.validation_step .. automethod:: GIN.xpu .. automethod:: GIN.zero_grad