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