health_azure Package

Functions

create_run_configuration(workspace, …[, …])

Creates an AzureML run configuration, that contains information about environment, multi node execution, and Docker.

create_script_run([snapshot_root_directory, …])

Creates an AzureML ScriptRunConfig object, that holds the information about the snapshot, the entry script, and its arguments.

download_files_from_run_id(run_id, output_folder)

For a given Azure ML run id, first retrieve the Run, and then download all files, which optionally start with a given prefix.

download_checkpoints_from_run_id(run_id, …)

Given an Azure ML run id, download all files from a given checkpoint directory within that run, to the path specified by output_path.

download_from_datastore(datastore_name, …)

Download file(s) from an Azure ML Datastore that are registered within a given Workspace.

fetch_run(workspace, run_recovery_id)

Finds an existing run in an experiment, based on a recovery ID that contains the experiment ID and the actual RunId.

get_most_recent_run(run_recovery_file, workspace)

Gets the name of the most recently executed AzureML run, instantiates that Run object and returns it.

get_workspace(aml_workspace, …)

Retrieve an Azure ML Workspace from one of several places:

is_running_in_azure_ml([aml_run])

Returns True if the given run is inside of an AzureML machine, or False if it is on a machine outside AzureML.

set_environment_variables_for_multi_node()

Sets the environment variables that PyTorch Lightning needs for multi-node training.

split_recovery_id(id)

Splits a run ID into the experiment name and the actual run.

submit_run(workspace, experiment_name, …)

Starts an AzureML run on a given workspace, via the script_run_config.

submit_to_azure_if_needed([…])

Submit a folder to Azure, if needed and run it.

torch_barrier()

This is a barrier to use in distributed jobs.

upload_to_datastore(datastore_name, …[, …])

Upload a folder to an Azure ML Datastore that is registered within a given Workspace.

Classes

AzureRunInfo(input_datasets, …)

This class stores all information that a script needs to run inside and outside of AzureML.

DatasetConfig(name[, datastore, version, …])

Contains information to use AzureML datasets as inputs or outputs.

health_ml.utils Package

Functions

log_learning_rate(module[, name])

Logs the learning rate(s) used by the given module.

log_on_epoch(module[, name, value, metrics, …])

Write a dictionary with metrics and/or an individual metric as a name/value pair to the loggers of the given module.

Classes

AzureMLLogger()

A Pytorch Lightning logger that stores metrics in the current AzureML run.