mridc package

Subpackages

• mridc.collections package
  • Subpackages
    • mridc.collections.common package
      • Subpackages
      • Module contents
    • mridc.collections.quantitative package
      • Subpackages
      • Module contents
    • mridc.collections.reconstruction package
      • Subpackages
      • Module contents
  • Module contents
• mridc.core package
  • Subpackages
    • mridc.core.classes package
      • Submodules
      • mridc.core.classes.common module
      • mridc.core.classes.dataset module
      • mridc.core.classes.export module
      • mridc.core.classes.loss module
      • mridc.core.classes.modelPT module
      • mridc.core.classes.module module
      • Module contents
    • mridc.core.conf package
      • Submodules
      • mridc.core.conf.base_config module
      • mridc.core.conf.dataloader module
      • mridc.core.conf.hydra_runner module
      • mridc.core.conf.modelPT module
      • mridc.core.conf.optimizers module
      • mridc.core.conf.schedulers module
      • mridc.core.conf.trainer module
      • Module contents
    • mridc.core.connectors package
      • Submodules
      • mridc.core.connectors.save_restore_connector module
      • Module contents
    • mridc.core.neural_types package
      • Submodules
      • mridc.core.neural_types.axes module
      • mridc.core.neural_types.comparison module
      • mridc.core.neural_types.elements module
      • mridc.core.neural_types.neural_type module
      • Module contents
    • mridc.core.optim package
      • Submodules
      • mridc.core.optim.adafactor module
      • mridc.core.optim.lr_scheduler module
      • mridc.core.optim.novograd module
      • mridc.core.optim.optimizer_with_master_params module
      • mridc.core.optim.optimizers module
      • Module contents
    • mridc.core.utils package
      • Submodules
      • mridc.core.utils.neural_type_utils module
      • mridc.core.utils.numba_utils module
      • Module contents
  • Module contents
• mridc.utils package
  • Subpackages
    • mridc.utils.decorators package
      • Submodules
      • mridc.utils.decorators.deprecated module
      • mridc.utils.decorators.experimental module
      • mridc.utils.decorators.port_docs module
      • Module contents
    • mridc.utils.formaters package
      • Submodules
      • mridc.utils.formaters.base module
      • mridc.utils.formaters.colors module
      • mridc.utils.formaters.utils module
      • Module contents
  • Submodules
  • mridc.utils.app_state module
    • AppState
      • AppState.checkpoint_callback_params
      • AppState.checkpoint_name
      • AppState.create_checkpoint_callback
      • AppState.data_parallel_group
      • AppState.data_parallel_rank
      • AppState.data_parallel_size
      • AppState.device_id
      • AppState.exp_dir
      • AppState.get_model_metadata_from_guid()
      • AppState.global_rank
      • AppState.is_model_being_restored
      • AppState.local_rank
      • AppState.log_dir
      • AppState.model_parallel_size
      • AppState.model_restore_path
      • AppState.mridc_file_folder
      • AppState.name
      • AppState.pipeline_model_parallel_group
      • AppState.pipeline_model_parallel_rank
      • AppState.pipeline_model_parallel_size
      • AppState.pipeline_model_parallel_split_rank
      • AppState.random_seed
      • AppState.register_model_guid()
      • AppState.reset_model_guid_registry()
      • AppState.tensor_model_parallel_group
      • AppState.tensor_model_parallel_rank
      • AppState.tensor_model_parallel_size
      • AppState.version
      • AppState.world_size
    • ModelMetadataRegistry
      • ModelMetadataRegistry.gidx
      • ModelMetadataRegistry.guid
      • ModelMetadataRegistry.restoration_path
  • mridc.utils.arguments module
    • add_optimizer_args()
    • add_recon_args()
    • add_scheduler_args()
  • mridc.utils.cloud module
    • maybe_download_from_cloud()
  • mridc.utils.config_utils module
    • assert_dataclass_signature_match()
    • update_model_config()
  • mridc.utils.debug_hook module
    • get_backward_hook()
    • get_forward_hook()
    • get_tensor_hook()
    • register_debug_hooks()
  • mridc.utils.distributed module
    • initialize_distributed()
  • mridc.utils.env_var_parsing module
    • CoercionError
    • RequiredSettingMissingError
    • get_env()
    • get_envbool()
    • get_envdate()
    • get_envdatetime()
    • get_envdecimal()
    • get_envdict()
    • get_envfloat()
    • get_envint()
    • get_envlist()
  • mridc.utils.exceptions module
    • CheckInstall
    • LightningNotInstalledException
    • MRIDCBaseException
  • mridc.utils.exp_manager module
    • CallbackParams
      • CallbackParams.always_save_mridc
      • CallbackParams.dirpath
      • CallbackParams.every_n_epochs
      • CallbackParams.filename
      • CallbackParams.filepath
      • CallbackParams.mode
      • CallbackParams.model_parallel_size
      • CallbackParams.monitor
      • CallbackParams.postfix
      • CallbackParams.prefix
      • CallbackParams.save_best_model
      • CallbackParams.save_last
      • CallbackParams.save_mridc_on_train_end
      • CallbackParams.save_top_k
      • CallbackParams.save_weights_only
      • CallbackParams.verbose
    • CheckpointMisconfigurationError
    • ExpManagerConfig
      • ExpManagerConfig.checkpoint_callback_params
      • ExpManagerConfig.create_checkpoint_callback
      • ExpManagerConfig.create_tensorboard_logger
      • ExpManagerConfig.create_wandb_logger
      • ExpManagerConfig.exp_dir
      • ExpManagerConfig.explicit_log_dir
      • ExpManagerConfig.files_to_copy
      • ExpManagerConfig.log_global_rank_0_only
      • ExpManagerConfig.log_local_rank_0_only
      • ExpManagerConfig.log_step_timing
      • ExpManagerConfig.model_parallel_size
      • ExpManagerConfig.name
      • ExpManagerConfig.resume_if_exists
      • ExpManagerConfig.resume_ignore_no_checkpoint
      • ExpManagerConfig.resume_past_end
      • ExpManagerConfig.step_timing_kwargs
      • ExpManagerConfig.summary_writer_kwargs
      • ExpManagerConfig.use_datetime_version
      • ExpManagerConfig.version
      • ExpManagerConfig.wandb_logger_kwargs
    • LoggerList
      • LoggerList.name
      • LoggerList.version
    • LoggerMisconfigurationError
    • MRIDCModelCheckpoint
      • MRIDCModelCheckpoint.mridc_topk_check_previous_run()
      • MRIDCModelCheckpoint.on_save_checkpoint()
      • MRIDCModelCheckpoint.on_train_end()
    • NotFoundError
    • StatelessTimer
      • StatelessTimer.load_state_dict()
      • StatelessTimer.state_dict()
    • StepTimingParams
      • StepTimingParams.buffer_size
      • StepTimingParams.reduction
      • StepTimingParams.sync_cuda
    • TimingCallback
      • TimingCallback.on_after_backward()
      • TimingCallback.on_before_backward()
      • TimingCallback.on_test_batch_end()
      • TimingCallback.on_test_batch_start()
      • TimingCallback.on_train_batch_end()
      • TimingCallback.on_train_batch_start()
      • TimingCallback.on_validation_batch_end()
      • TimingCallback.on_validation_batch_start()
    • check_explicit_log_dir()
    • check_resume()
    • check_slurm()
    • configure_checkpointing()
    • configure_loggers()
    • error_checks()
    • exp_manager()
    • get_git_diff()
    • get_git_hash()
    • get_log_dir()
  • mridc.utils.export_utils module
    • CastToFloat
      • CastToFloat.forward()
      • CastToFloat.training
    • ExportFormat
      • ExportFormat.ONNX
      • ExportFormat.TORCHSCRIPT
    • augment_filename()
    • cast_all()
    • cast_tensor()
    • forward_method()
    • get_export_format()
    • parse_input_example()
    • replace_for_export()
    • replace_modules()
    • run_ort_and_compare()
    • simple_replace()
    • swap_modules()
    • to_onnxrt_input()
    • verify_runtime()
    • wrap_forward_method()
    • wrap_module()
  • mridc.utils.get_rank module
    • get_rank()
    • is_global_rank_zero()
  • mridc.utils.lightning_logger_patch module
    • add_filehandlers_to_pl_logger()
    • add_memory_handlers_to_pl_logger()
  • mridc.utils.metaclasses module
    • Singleton
      • Singleton.__call__()
  • mridc.utils.model_utils module
    • ArtifactItem
      • ArtifactItem.hashed_path
      • ArtifactItem.path
      • ArtifactItem.path_type
    • ArtifactPathType
      • ArtifactPathType.LOCAL_PATH
      • ArtifactPathType.TAR_PATH
    • check_lib_version()
    • convert_model_config_to_dict_config()
    • import_class_by_path()
    • inject_model_parallel_rank()
    • maybe_update_config_version()
    • parse_dataset_as_name()
    • resolve_cache_dir()
    • resolve_dataset_name_from_cfg()
    • resolve_subclass_pretrained_model_info()
    • resolve_validation_dataloaders()
    • uninject_model_parallel_rank()
    • unique_names_check()
    • wrap_training_step()
  • mridc.utils.mridc_logging module
    • LogMode
      • LogMode.EACH
      • LogMode.ONCE
    • Logger
      • Logger.CRITICAL
      • Logger.DEBUG
      • Logger.ERROR
      • Logger.INFO
      • Logger.NOTSET
      • Logger.WARNING
      • Logger.add_err_file_handler()
      • Logger.add_file_handler()
      • Logger.add_stream_handlers()
      • Logger.captureWarnings()
      • Logger.critical()
      • Logger.debug()
      • Logger.error()
      • Logger.getEffectiveLevel()
      • Logger.get_verbosity()
      • Logger.info()
      • Logger.patch_stderr_handler()
      • Logger.patch_stdout_handler()
      • Logger.remove_stream_handlers()
      • Logger.reset_stream_handler()
      • Logger.setLevel()
      • Logger.set_verbosity()
      • Logger.temp_verbosity()
      • Logger.warning()
  • mridc.utils.timers module
    • NamedTimer
      • NamedTimer.active_timers()
      • NamedTimer.buffer_size
      • NamedTimer.export()
      • NamedTimer.get()
      • NamedTimer.reset()
      • NamedTimer.start()
      • NamedTimer.stop()
  • Module contents

Submodules

mridc.constants module

mridc.launch module

mridc.launch.main(cfg: DictConfig) → None

Main function for training and running a model

Parameters

cfg (Configuration (yaml) file.) – DictConfig

mridc.package_info module

Module contents