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