add tutorial for colab support #2700

JunweiSUN · 2020-07-17T10:12:06Z

No description provided.

SparkSnail · 2020-07-21T11:25:06Z

docs/en_US/CommunitySharings/NNI_colab_support.md

@@ -0,0 +1,44 @@
+
+# Use NNI on Google Colab
+NNI can easily run on Google's colab platform. However, colab doesn't expose its public IP and ports, so by default you can not access NNI's web ui on colab. To solve this, you need a reverse proxy software like `ngrok` or `frp`. This tutorial will show you how to use ngrok to get access to NNI's web ui on colab.


use ngrok to access NNI's web ui

SparkSnail · 2020-07-21T11:25:41Z

docs/en_US/CommunitySharings/NNI_colab_support.md

+
+```
+! nnictl create --config nni_repo/nni/examples/trials/mnist-pytorch/config.yml --port 5000 & # if you want to use gpu, make sure gpuNum >= 1 in config.yml
+get_ipython().system_raw('./ngrok http 5000 &')


what is get_ipython()? why not use ./ngrok http 5000 & directly?

If use ! ./ngrok http 5000 & directly, the cell running this command will stuck. Not sure why this happened. Use get_ipython() will solve this problem.

I think what get_ipython is trying to solve should be stated in tutorial.

SparkSnail · 2020-07-21T11:26:09Z

docs/en_US/CommunitySharings/NNI_colab_support.md

+
+## Access WebUI with frp
+
+frp is another reverse proxy software with similar functions. However, frp doesn't provide free public urls, so you may need an server with public IP as an frp server. See [here](https://github.com/fatedier/frp) to know more about how to deploy frp.


SparkSnail · 2020-07-21T11:26:35Z

docs/en_US/CommunitySharings/NNI_colab_support.md

+! ./ngrok authtoken <your-authtoken>
+```
+
+3. Start an NNI trail example on a port greater than 1024, then start ngrok with the same port.


greater -> bigger

ultmaster · 2020-07-22T03:56:46Z

docs/en_US/CommunitySharings/NNI_colab_support.md

@@ -0,0 +1,44 @@
+
+# Use NNI on Google Colab
+NNI can easily run on Google's colab platform. However, colab doesn't expose its public IP and ports, so by default you can not access NNI's web ui on colab. To solve this, you need a reverse proxy software like `ngrok` or `frp`. This tutorial will show you how to use ngrok to access NNI's web ui on colab.


Google "C"olab

ultmaster · 2020-07-22T03:57:39Z

docs/en_US/CommunitySharings/NNI_colab_support.md

+! ./ngrok authtoken <your-authtoken>
+```
+
+3. Start an NNI trail example on a port bigger than 1024, then start ngrok with the same port.


an NNI example. What's trail?

ultmaster · 2020-07-22T03:58:07Z

docs/en_US/CommunitySharings/NNI_colab_support.md

+
+
+```
+! nnictl create --config nni_repo/nni/examples/trials/mnist-pytorch/config.yml --port 5000 & # if you want to use gpu, make sure gpuNum >= 1 in config.yml


You can add comments in text instead of in the code.

ultmaster · 2020-07-22T03:58:59Z

docs/en_US/CommunitySharings/NNI_colab_support.md

+
+```
+! nnictl create --config nni_repo/nni/examples/trials/mnist-pytorch/config.yml --port 5000 & # if you want to use gpu, make sure gpuNum >= 1 in config.yml
+get_ipython().system_raw('./ngrok http 5000 &')


I think what get_ipython is trying to solve should be stated in tutorial.

ultmaster · 2020-07-22T04:00:08Z

docs/en_US/nnicli.md

+
+NNI client is a python API of `nnictl`, which implements the most common used commands. User can use this API to control their experiments in python code instead of command line. Here is an example:
+
+```


Might submit this file in a separate PR.

Sure. These files were introduced by mistake.

ultmaster · 2020-07-22T08:20:34Z

docs/en_US/CommunitySharings/NNI_colab_support.md

@@ -0,0 +1,44 @@
+
+# Use NNI on Google Colab
+NNI can easily run on Google Colab platform. However, colab doesn't expose its public IP and ports, so by default you can not access NNI's Web UI on colab. To solve this, you need a reverse proxy software like `ngrok` or `frp`. This tutorial will show you how to use ngrok to access NNI's Web UI on colab.


There is still a lot of "colab". Please change them to "Colab".

My bad. Fixed.

ultmaster · 2020-07-22T08:20:40Z

docs/en_US/CommunitySharings/NNI_colab_support.md

+! curl -s http://localhost:4040/api/tunnels # don't change the port number 4040
+```
+
+You will see an url like http://xxxx.ngrok.io after step 4, open this url and you will find NNI's web ui. Have fun :)


JunweiSUN added 2 commits July 17, 2020 18:05

add tutorial for colab

595ed0c

Merge branch 'master' into dev-colab-doc

3120a22

scarlett2018 mentioned this pull request Jul 20, 2020

July iteration plan #2608

Closed

66 tasks

JunweiSUN requested review from QuanluZhang, ultmaster and SparkSnail July 20, 2020 03:19

SparkSnail reviewed Jul 21, 2020

View reviewed changes

JunweiSUN added 2 commits July 21, 2020 22:42

Merge branch 'master' into dev-colab-doc

24544bf

fix typo

9e85ba1

ultmaster reviewed Jul 22, 2020

View reviewed changes

JunweiSUN added 3 commits July 22, 2020 15:42

update colab doc

8113e00

add EOF to conf.py

4889374

add EOF to conf.py

e0de883

QuanluZhang removed their request for review July 22, 2020 08:11

ultmaster reviewed Jul 22, 2020

View reviewed changes

JunweiSUN added 2 commits July 22, 2020 16:23

update doc

99649f8

update doc

980ee38

SparkSnail approved these changes Jul 23, 2020

View reviewed changes

ultmaster approved these changes Jul 23, 2020

View reviewed changes

JunweiSUN closed this Jul 23, 2020

JunweiSUN reopened this Jul 23, 2020

ultmaster merged commit 66f2777 into microsoft:master Jul 24, 2020

JunweiSUN deleted the dev-colab-doc branch July 29, 2020 06:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add tutorial for colab support #2700

add tutorial for colab support #2700

JunweiSUN commented Jul 17, 2020

SparkSnail Jul 21, 2020

JunweiSUN Jul 21, 2020

SparkSnail Jul 21, 2020 •

edited

Loading

JunweiSUN Jul 21, 2020

ultmaster Jul 22, 2020

JunweiSUN Jul 22, 2020

SparkSnail Jul 21, 2020

JunweiSUN Jul 21, 2020

SparkSnail Jul 21, 2020

JunweiSUN Jul 21, 2020

ultmaster Jul 22, 2020

ultmaster Jul 22, 2020

JunweiSUN Jul 22, 2020

ultmaster Jul 22, 2020

JunweiSUN Jul 22, 2020

ultmaster Jul 22, 2020

JunweiSUN Jul 22, 2020

ultmaster Jul 22, 2020

ultmaster Jul 22, 2020

JunweiSUN Jul 22, 2020

ultmaster Jul 22, 2020

JunweiSUN Jul 22, 2020

ultmaster Jul 22, 2020

JunweiSUN Jul 22, 2020

		@@ -0,0 +1,44 @@

		# Use NNI on Google Colab
		NNI can easily run on Google's colab platform. However, colab doesn't expose its public IP and ports, so by default you can not access NNI's web ui on colab. To solve this, you need a reverse proxy software like `ngrok` or `frp`. This tutorial will show you how to use ngrok to get access to NNI's web ui on colab.


		## Access WebUI with frp

		frp is another reverse proxy software with similar functions. However, frp doesn't provide free public urls, so you may need an server with public IP as an frp server. See [here](https://github.com/fatedier/frp) to know more about how to deploy frp.



		```
		! nnictl create --config nni_repo/nni/examples/trials/mnist-pytorch/config.yml --port 5000 & # if you want to use gpu, make sure gpuNum >= 1 in config.yml


		NNI client is a python API of `nnictl`, which implements the most common used commands. User can use this API to control their experiments in python code instead of command line. Here is an example:

		```

		@@ -0,0 +1,44 @@

		# Use NNI on Google Colab
		NNI can easily run on Google Colab platform. However, colab doesn't expose its public IP and ports, so by default you can not access NNI's Web UI on colab. To solve this, you need a reverse proxy software like `ngrok` or `frp`. This tutorial will show you how to use ngrok to access NNI's Web UI on colab.

add tutorial for colab support #2700

add tutorial for colab support #2700

Conversation

JunweiSUN commented Jul 17, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SparkSnail Jul 21, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SparkSnail Jul 21, 2020 •

edited

Loading