Skip to content

Commit

Permalink
Fix more merge problems
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonathan Tripp committed Sep 22, 2021
1 parent 0bd2f2f commit 22a7984
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ For just the AzureML helper functions:

* Install from `pypi` via `pip`, by running `pip install hi-ml-azure`

## Documentation

The detailed package documentation, with examples and API reference, is on
[readthedocs](https://hi-ml.readthedocs.io/en/latest/).

## Quick start: Using the Azure layer

Use case: you have a Python script that does something - that could be training a model, or pre-processing some data.
Expand Down Expand Up @@ -51,11 +56,11 @@ from health.azure.himl import submit_to_azure_if_needed
if __name__ == '__main__':
current_file = Path(__file__)
run_info = submit_to_azure_if_needed(compute_cluster_name="preprocess-ds12",
conda_environment_file=Path("environment.yml"),
input_datasets=["images123"],
# Omit this line if you don't create an output dataset (for example, in
# model training scripts)
output_datasets=["images123_resized"],)
output_datasets=["images123_resized"],
default_datastore="my_datastore")
# When running in AzureML, run_info.input_datasets and run_info.output_datasets will be populated,
# and point to the data coming from blob storage. For runs outside AML, the paths will be None.
# Replace the None with a meaningful path, so that we can still run the script easily outside AML.
Expand All @@ -76,9 +81,11 @@ if __name__ == '__main__':

Once these changes are in place, you can submit the script to AzureML by supplying an additional `--azureml` flag
on the commandline, like `python myscript.py --azureml`.

That's it!

For details, please refer to the [onboarding page](docs/source/first_steps.md).

For more examples, please see [examples.md](docs/source/examples.md).

## Issues
Expand Down

2 comments on commit 22a7984

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Filename Stmts Miss Cover Missing
/home/runner/work/hi-ml/hi-ml/hi-ml-azure/src/health/azure/init.py 4 0 100.00%
/home/runner/work/hi-ml/hi-ml/hi-ml-azure/src/health/azure/azure_util.py 241 173 28.22% 59,
/home/runner/work/hi-ml/hi-ml/hi-ml-azure/src/health/azure/datasets.py 80 64 20.00% 23-32,
/home/runner/work/hi-ml/hi-ml/hi-ml-azure/src/health/azure/himl.py 192 137 28.65% 91,
/opt/hostedtoolcache/Python/3.7.12/x64/lib/python3.7/site-packages/health/data/init.py 0 0 100.00%
/opt/hostedtoolcache/Python/3.7.12/x64/lib/python3.7/site-packages/health/data/placeholder.py 2 0 100.00%
TOTAL 519 374 27.94%

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Filename Stmts Miss Cover Missing
/opt/hostedtoolcache/Python/3.7.12/x64/lib/python3.7/site-packages/health/azure/init.py 4 0 100.00%
/opt/hostedtoolcache/Python/3.7.12/x64/lib/python3.7/site-packages/health/azure/azure_util.py 241 0 100.00%
/opt/hostedtoolcache/Python/3.7.12/x64/lib/python3.7/site-packages/health/azure/datasets.py 80 0 100.00%
/opt/hostedtoolcache/Python/3.7.12/x64/lib/python3.7/site-packages/health/azure/himl.py 192 0 100.00%
/opt/hostedtoolcache/Python/3.7.12/x64/lib/python3.7/site-packages/health/azure/himl_download.py 15 0 100.00%
/opt/hostedtoolcache/Python/3.7.12/x64/lib/python3.7/site-packages/health/azure/himl_tensorboard.py 52 5 90.38% 42,
TOTAL 584 5 99.14%

Please sign in to comment.