Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
OpenDAS
nni
Commits
548f4f53
Unverified
Commit
548f4f53
authored
Nov 05, 2021
by
liuzhe-lz
Committed by
GitHub
Nov 05, 2021
Browse files
Add development README for JupyterLab extension (#4269)
parent
070df4a0
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
53 additions
and
0 deletions
+53
-0
ts/jupyter_extension/README.md
ts/jupyter_extension/README.md
+53
-0
No files found.
ts/jupyter_extension/README.md
0 → 100644
View file @
548f4f53
NNI is under development to support JupyterLab.
You can install this extension to preview the feature.
Currently you can view NNI web UI inside JupyterLab.
## Install ##
To preview the extension, you need to have
`nni`
and
`jupyterlab`
installed at first:
```
$ pip install nni jupyterlab
```
Then run following command to register extension:
```
$ nnictl jupyter-extension install
```
It does not have prompt message. Exit without error means success.
## Run ##
For now, the extension does not support creating experiment, so you have to create one with nnictl:
```
$ nnictl create --config <experiment-directory>/config.yml
```
And you need to launch JupyterLab:
```
$ jupyter lab --ip=0.0.0.0
```
Following JupyterLab's guide to open its web page, you should find an NNI icon.
Click the icon and it will open NNI web UI for your running experiment.
## Uninstall ##
To uninstall (or more accurately, unregister) the extension, run following command:
```
$ nnictl jupyter-extension uninstall
```
## Known Issues ##
The JupyterLab extension is under development and there are many issues need to fix before public announcement:
*
Clicking a link in experiment management page will open it outside JupyterLab. To fix it will need modify in web UI.
*
Downloading log file might not work.
*
Post requests (update experiment config) might not work.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment