submit_run

health_azure.submit_run(workspace, experiment_name, script_run_config, tags=None, wait_for_completion=False, wait_for_completion_show_output=False, display_name=None)[source]

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

Parameters

  • workspace (Workspace) – The AzureML workspace to use.

  • experiment_name (str) – The name of the experiment that will be used or created. If the experiment name contains characters that are not valid in Azure, those will be removed.

  • script_run_config (Union[ScriptRunConfig, HyperDriveConfig]) – The settings that describe which script should be run.

  • tags (Optional[Dict[str, str]]) – A dictionary of string key/value pairs, that will be added as metadata to the run. If set to None, a default metadata field will be added that only contains the commandline arguments that started the run.

  • wait_for_completion (bool) – If False (the default) return after the run is submitted to AzureML, otherwise wait for the completion of this run (if True).

  • wait_for_completion_show_output (bool) – If wait_for_completion is True this parameter indicates whether to show the run output on sys.stdout.

  • display_name (Optional[str]) – The name for the run that will be displayed in the AML UI. If not provided, a random display name will be generated by AzureML.

Return type

Run

Returns

An AzureML Run object.