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

Update docs for aml and nasbenchmark #2647

Closed
wants to merge 6 commits into from
Closed

Update docs for aml and nasbenchmark #2647

wants to merge 6 commits into from

Conversation

JunweiSUN
Copy link
Contributor

Update docs for aml and nasbenchmark

@ultmaster
Copy link
Contributor

Please revert the changes to Chinese docs.

**Step 2.** Run docker.

For NAS-Bench-101,
To avoid storage and legal issues, we do not provide any prepared databases. Please follow the following steps.
Copy link
Contributor

Choose a reason for hiding this comment

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

legal issues -> legality issues.

Copy link
Contributor Author

@JunweiSUN JunweiSUN Jul 7, 2020

Choose a reason for hiding this comment

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

will be fixed in new PR.

@@ -7,40 +7,25 @@
Example Usages <BenchmarksExample>
```

## Introduction
To imporve the reproducibility of NAS algorithms as well as reducing computing resource requirements, researchers proposed a series of NAS benchmarks such as [NAS-Bench-101](https://arxiv.org/abs/1902.09635), [NAS-Bench-201](https://arxiv.org/abs/2001.00326), [NDS](https://arxiv.org/abs/1905.13214), etc. NNI provides a query interface for users to acquire these benchmarks. Within just a few lines of codes, researcher are able to evaluate their NAS algorithms easily and fairly by utilizing these benchmarks.
Copy link
Contributor

Choose a reason for hiding this comment

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

NDS and etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it seems that "and" should not be in front of etc. Refer to https://www.sohu.com/a/149363473_814105.

docs/en_US/NAS/Benchmarks.md Show resolved Hide resolved
"metadata": {},
"source": [
"Use the following architecture as an example:<br>\n",
"![nas-101](../../img/nas-bench-101-example.png)"
Copy link
Contributor

Choose a reason for hiding this comment

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

MP = max pooling 3x3

Copy link
Contributor Author

@JunweiSUN JunweiSUN Jul 7, 2020

Choose a reason for hiding this comment

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

will be fixed in new PR.

"cell_type": "markdown",
"metadata": {},
"source": [
"An architecture of NAS-Bench-101 could be trained more than once. Each element of the returned generator is a dict which contains one of the training results of this architecture including train/valid/test accuracy, training time, number of epochs, etc. The results of NAS-Bench-201 and NDS follow similar formats."
Copy link
Contributor

Choose a reason for hiding this comment

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

this architecture => this trial config (architecture + hyper-parameters)

Copy link
Contributor Author

@JunweiSUN JunweiSUN Jul 7, 2020

Choose a reason for hiding this comment

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

will be fixed in new PR.

"metadata": {},
"source": [
"Use the following architecture as an example:<br>\n",
"![nas-201](../../img/nas-bench-201-example.png)"
Copy link
Contributor

Choose a reason for hiding this comment

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

AP = average pooling 3x3

Copy link
Contributor Author

@JunweiSUN JunweiSUN Jul 7, 2020

Choose a reason for hiding this comment

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

will be fixed in new PR.

@@ -5,12 +5,22 @@ NNI supports running an experiment on [AML](https://azure.microsoft.com/en-us/se
## Setup environment
Step 1. Install NNI, follow the install guide [here](../Tutorial/QuickStart.md).

Step 2. Create AML account, follow the document [here](https://docs.microsoft.com/en-us/azure/machine-learning/how-to-manage-workspace-cli).
Step 2. Create an Azure account using this [link](https://azure.microsoft.com/en-us/free/services/machine-learning/). If you already have an Azure account, skip this step.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's an AzureML subscription rather than an Azure account?

Copy link
Contributor Author

@JunweiSUN JunweiSUN Jul 7, 2020

Choose a reason for hiding this comment

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

This line will guide users to create an azure account with a subscription. Subscription seems to attached to user's account instead of AML. I will fix this in the new PR.

![](../../img/aml_workspace.png)

Step 6. Create an AML cluster as the computeTarget.
![](../../img/aml_cluster.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this photo half blank?

Copy link
Contributor Author

@JunweiSUN JunweiSUN Jul 7, 2020

Choose a reason for hiding this comment

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

Used wrong version. Will be fixed in new PR.


```bash
docker run -v ${HOME}/.nni/nasbenchmark:/outputs -v /path/to/your/nni:/nni python:3.7 /bin/bash /nni/examples/nas/benchmarks/nds.sh
git clone https://github.com/microsoft/nni.git
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should tell users to refer to Quickstart to clone NNI. They could clone the wrong version of NNI if they just follow this command.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure. Will be fixed in new PR.

Run the following commands to start the example experiment:
```
git clone https://github.com/microsoft/nni.git
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will be fixed in new PR.

@ultmaster ultmaster changed the base branch from master to v1.7 July 7, 2020 03:33
@ultmaster ultmaster changed the base branch from v1.7 to master July 7, 2020 03:34
@JunweiSUN
Copy link
Contributor Author

This PR will be closed since it will be replaced by #2651

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants