hi-ml/CHANGELOG.md

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

For each Pull Request, the affected code parts should be briefly described and added here in the "Upcoming" section.
Once a release is prepared, the "Upcoming" section becomes the release changelog, and a new empty "Upcoming" should be
created.


## Upcoming

### Added

### Changed

### Fixed

### Removed

### Deprecated

## 0.1.8 (2021-10-05)

### Added
- ([#123](https://github.com/microsoft/hi-ml/pull/123)) Add helper function to download checkpoint files

### Changed
- ([#127](https://github.com/microsoft/hi-ml/pull/127)) The field `is_running_in_azure` of `AzureRunInfo` has been renamed to `is_running_in_azure_ml`

### Fixed
- ([#127](https://github.com/microsoft/hi-ml/pull/127)) Fixing bug #126: get_workspace was assuming it runs in AzureML, when it was running on a plain Azure build agent.


## 0.1.7 (2021-10-04)

### Added
- ([#111](https://github.com/microsoft/hi-ml/pull/111)) Adding changelog. Displaying changelog in sphinx docu. Ensure changelog is updated.

### Changed
- ([#112](https://github.com/microsoft/hi-ml/pull/112)) Update himl_tensorboard to work with files not in 'logs' directory
- ([#106](https://github.com/microsoft/hi-ml/pull/106)) Split into two packages. Most of existing package renamed to hi-ml-azure, remained remains hi-ml.
- ([#113](https://github.com/microsoft/hi-ml/pull/113)) Add helper function to download files from AML Run, tidied up some command line args, and moved some functions from himl.py to azure_util.py
- ([#122](https://github.com/microsoft/hi-ml/pull/122)) Add helper functions to upload to and download from AML Datastores

### Fixed
- ([#117](https://github.com/microsoft/hi-ml/pull/117)) Bug fix: Config.json file was expected to be present, even if workspace was provided explicitly.
- ([#119](https://github.com/microsoft/hi-ml/pull/119)) Bug fix: Code coverage wasn't formatted correctly.


## 0.1.4 (2021-09-15)

- This is the baseline release.
Adding changelog (#111) Adding a changelog, displaying it with the docs, and ensuring it is updated in each PR. 2021-09-16 13:33:45 +03:00			`# Changelog`

			`All notable changes to this project will be documented in this file.`

			`The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres`
			`to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).`

			`For each Pull Request, the affected code parts should be briefly described and added here in the "Upcoming" section.`
			`Once a release is prepared, the "Upcoming" section becomes the release changelog, and a new empty "Upcoming" should be`
			`created.`


			`## Upcoming`

Preparation for release 0.1.7 (#124) 2021-10-04 17:58:50 +03:00			`### Added`

			`### Changed`

			`### Fixed`

			`### Removed`

			`### Deprecated`

Bug fix: get_workspace wrongly assumes it runs in AzureML (#127) 2021-10-06 18:18:31 +03:00			`## 0.1.8 (2021-10-05)`

			`### Added`
			`- ([#123](https://github.com/microsoft/hi-ml/pull/123)) Add helper function to download checkpoint files`

			`### Changed`
			- ([#127](https://github.com/microsoft/hi-ml/pull/127)) The field `is_running_in_azure` of `AzureRunInfo` has been renamed to `is_running_in_azure_ml`

			`### Fixed`
			`- ([#127](https://github.com/microsoft/hi-ml/pull/127)) Fixing bug #126: get_workspace was assuming it runs in AzureML, when it was running on a plain Azure build agent.`


Preparation for release 0.1.7 (#124) 2021-10-04 17:58:50 +03:00			`## 0.1.7 (2021-10-04)`

Adding changelog (#111) Adding a changelog, displaying it with the docs, and ensuring it is updated in each PR. 2021-09-16 13:33:45 +03:00			`### Added`
Add Tensorboard ability to read from different folders (#112) * Update run_tensorboard to work with logs in different folders * fix flake8 complaints * fix test and changelog * move types-requests to test_requirements for running mypy * update test * move tensorboard example into docs * shorten command line arg names * Address PR comments 2021-09-21 17:52:54 +03:00			`- ([#111](https://github.com/microsoft/hi-ml/pull/111)) Adding changelog. Displaying changelog in sphinx docu. Ensure changelog is updated.`
Adding changelog (#111) Adding a changelog, displaying it with the docs, and ensuring it is updated in each PR. 2021-09-16 13:33:45 +03:00
			`### Changed`
Add Tensorboard ability to read from different folders (#112) * Update run_tensorboard to work with logs in different folders * fix flake8 complaints * fix test and changelog * move types-requests to test_requirements for running mypy * update test * move tensorboard example into docs * shorten command line arg names * Address PR comments 2021-09-21 17:52:54 +03:00			`- ([#112](https://github.com/microsoft/hi-ml/pull/112)) Update himl_tensorboard to work with files not in 'logs' directory`
Publish two packages (#106) * Move existing code into hi-ml-azure * Create new package in hi-ml * Create top level files 2021-09-22 19:56:35 +03:00			`- ([#106](https://github.com/microsoft/hi-ml/pull/106)) Split into two packages. Most of existing package renamed to hi-ml-azure, remained remains hi-ml.`
Add function to download Run files without timeout (#113) * Add function for download_runs (WIP) * Add function to find file names for a Run * download runs with single run id * Stop output files being created during tests * Add test with local Run * flake8 * use DEFAULT_WORKSPACE * move get_workspace into azure_utils to call from get_aml_run * download_file only for first node if distributed * Tidy up functions to get AML Run(s) * dont cover nested functions * Update himl-tb and himl-download with recent util changes * Address PR comments * Replace AML test for download_file 2021-09-30 13:01:18 +03:00			`- ([#113](https://github.com/microsoft/hi-ml/pull/113)) Add helper function to download files from AML Run, tidied up some command line args, and moved some functions from himl.py to azure_util.py`
Mebristo/blob storage upload download (#122) * Add functions to upload and download from blob storage * Add functions to upload and download from datastores * Update CHANGELOG * mypy * Clarify params and add functions to __init__ * Address PR comments 2021-10-05 12:00:40 +03:00			`- ([#122](https://github.com/microsoft/hi-ml/pull/122)) Add helper functions to upload to and download from AML Datastores`
Publish two packages (#106) * Move existing code into hi-ml-azure * Create new package in hi-ml * Create top level files 2021-09-22 19:56:35 +03:00
Adding changelog (#111) Adding a changelog, displaying it with the docs, and ensuring it is updated in each PR. 2021-09-16 13:33:45 +03:00			`### Fixed`
Bug fix: Missing config.json file when providing an AML workspace (#117) Moving code around for the test suite, to make the hi-ml and hi-ml-azure have a clearly distinct module name, and remove the deep folder hierarchy. Adding init files to the test folders for pytest to pick up files correctly 2021-09-23 19:06:36 +03:00			`- ([#117](https://github.com/microsoft/hi-ml/pull/117)) Bug fix: Config.json file was expected to be present, even if workspace was provided explicitly.`
Upload and merge all coverage artifacts (#119) Upload and merge all coverage artifacts 2021-09-27 11:29:58 +03:00			`- ([#119](https://github.com/microsoft/hi-ml/pull/119)) Bug fix: Code coverage wasn't formatted correctly.`
Adding changelog (#111) Adding a changelog, displaying it with the docs, and ensuring it is updated in each PR. 2021-09-16 13:33:45 +03:00

			`## 0.1.4 (2021-09-15)`

			`- This is the baseline release.`