Skip to content
This repository has been archived by the owner on Sep 18, 2024. It is now read-only.

Update v0.3.0 release note #324

Merged
merged 36 commits into from
Nov 5, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
2f43244
refactor doc
scarlett2018 Oct 18, 2018
01dd6e7
update with Mao's suggestions
scarlett2018 Oct 19, 2018
e034529
Set theme jekyll-theme-dinky
scarlett2018 Oct 19, 2018
6447fb1
update doc
scarlett2018 Oct 22, 2018
2bd43e5
fix links
scarlett2018 Oct 22, 2018
6a11b6c
fix links
scarlett2018 Oct 22, 2018
e229100
fix links
scarlett2018 Oct 22, 2018
cba517c
merge
scarlett2018 Oct 25, 2018
781ee75
merge
scarlett2018 Oct 25, 2018
4a4804f
fix links and doc errors
scarlett2018 Oct 25, 2018
091e502
merge
scarlett2018 Oct 25, 2018
c6b3d35
merge
scarlett2018 Oct 25, 2018
b141cff
merge
scarlett2018 Oct 25, 2018
47da3ba
merge
scarlett2018 Oct 25, 2018
0199e6a
Merge remote-tracking branch 'upstream/master'
scarlett2018 Oct 26, 2018
4a8c8a9
Quick fix nnictl config logic (#289)
SparkSnail Oct 31, 2018
ccc3939
merge
scarlett2018 Oct 31, 2018
1ce3310
merge
scarlett2018 Oct 31, 2018
3e8920a
updated the "Contribute" part (merged Gems' wiki in, updated ReadMe)
scarlett2018 Oct 31, 2018
91fd9b6
fix link
scarlett2018 Oct 31, 2018
a2ca6f1
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 1, 2018
fa08220
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 1, 2018
9fdc11e
revise the installation cmd to v0.2
scarlett2018 Nov 1, 2018
d777f13
revise to install v0.2
scarlett2018 Nov 1, 2018
3bc77dc
Merge branch 'v0.3' into master
chicm-ms Nov 1, 2018
233c7ee
Update nnictl_utils.py
scarlett2018 Nov 1, 2018
13fb771
Update nnictl_utils.py
QuanluZhang Nov 1, 2018
e0f31db
Update nnictl_utils.py
QuanluZhang Nov 1, 2018
edb4bc7
Merge branch 'master' into master
scarlett2018 Nov 1, 2018
e941d70
merge
scarlett2018 Nov 2, 2018
3b0d00a
Merge branch 'master' of https://github.com/scarlett2018/nni
scarlett2018 Nov 2, 2018
a889587
Update documentation for v0.3
scarlett2018 Nov 2, 2018
d4eb8b6
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 5, 2018
804b3be
Merge remote-tracking branch 'upstream/master'
scarlett2018 Nov 5, 2018
f232d44
update release note
scarlett2018 Nov 5, 2018
f8877f3
update v0.3.0 release note +1
scarlett2018 Nov 5, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 26 additions & 22 deletions docs/RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,40 @@
# Release 0.3.0 - 11/2/2018
## Major Features
* Support running multiple experiments simultaneously. You can run multiple experiments by specifying a unique port for each experiment:
## NNICTL new features and updates
* Support running multiple experiments simultaneously.

Before v0.3, NNI only supports running single experiment once a time. After this realse, users are able to run multiple experiments simultaneously. Each experiment will require a unique port, the 1st experiment will be set to the default port as previous versions. You can specify a unique port for the rest experiments as below:

```nnictl create --port 8081 --config <config file path>```
* Support updating max trial number.
use ```nnictl update --help``` to learn more. Or refer to [NNICTL Spec](https://github.com/Microsoft/nni/blob/master/docs/NNICTLDOC.md) for the fully usage of NNICTL.

You can still run the first experiment without '--port' parameter:
## API new features and updates
* <span style="color:red">**breaking change**</span>: nn.get_parameters() is refactored to nni.get_next_parameter. All examples of prior releases can not run on v0.3, please clone nni repo to get new examples. If you had applied NNI to your own codes, please update the API accordingly.
Copy link
Contributor

Choose a reason for hiding this comment

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

nni.get_next_parameter() ?

Copy link
Contributor

@chicm-ms chicm-ms Nov 5, 2018

Choose a reason for hiding this comment

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

update the API -> update your code?


```nnictl create --config <config file path>```
* A builtin Batch Tuner which iterates all parameter combination, can be used to submit batch trial jobs.
* nni.report_final_result(result) API supports more data types for result parameter, it can be of following types:
* New API **nni.get_sequence_id()**.
Each trial job is allocated a unique sequence number, which can be retrieved by nni.get_sequence_id() API.

```git clone -b v0.3 https://github.com/Microsoft/nni.git```
* **nni.report_final_result(result)** API supports more data types for result parameter.
It can be of following types:
* int
* float
* A python dict containing 'default' key, the value of 'default' key should be of type int or float. The dict can contain any other key value pairs.
* Continuous Integration
* Switched to Azure pipelines
* Others
* New nni.get_sequence_id() API. Each trial job is allocated a unique sequence number, which can be retrieved by nni.get_sequence_id() API.
* Download experiment result from WebUI
* Add trial examples using sklearn and NNI together
* Support updating max trial number
* Kaggle competition TGS Salt code as an example
* NNI Docker image:

```docker pull msranni/nni:latest```

## Breaking changes
* <span style="color:red">API nn.get_parameters() is renamed to nni.get_next_parameter(), this is a broken change, all examples of prior releases can not run on v0.3, please clone nni repo to get new examples.</span>
## New tuner support
* **Batch Tuner** which iterates all parameter combination, can be used to submit batch trial jobs.

```git clone -b v0.3 https://github.com/Microsoft/nni.git```
## New examples
* A NNI Docker image for public usage:
```docker pull msranni/nni:latest```
* New trial example: [NNI Sklearn Example](https://github.com/Microsoft/nni/tree/master/examples/trials/sklearn)
* New competition example: [Kaggle Competition TGS Salt Example](https://github.com/Microsoft/nni/tree/master/examples/trials/kaggle-tgs-salt)

## Others
* UI refactoring, refer to [WebUI doc](WebUI.md) for how to work with the new UI.
* Continuous Integration: NNI had switched to Azure pipelines
* [Known Issues in release 0.3.0](https://github.com/Microsoft/nni/labels/nni030knownissues).

## Know issues
[Known Issues in release 0.3.0](https://github.com/Microsoft/nni/labels/nni030knownissues).

# Release 0.2.0 - 9/29/2018
## Major Features
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial_1_CR_exp_local_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To enable NNI API, make the following changes:
1.2 Get predefined parameters
Use the following code snippet:

RECEIVED_PARAMS = nni.get_parameters()
RECEIVED_PARAMS = nni.get_next_parameter()

to get hyper-parameters' values assigned by tuner. `RECEIVED_PARAMS` is an object, for example:

Expand Down