Skip to content
This repository was archived by the owner on Jun 3, 2025. It is now read-only.

Commit 1661057

Browse files
authored
Update notebook readme (#54)
1 parent 0a4a97a commit 1661057

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

notebooks/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,28 @@ limitations under the License.
1717
## Tutorials for SparseML
1818
Tutorials, which are implemented as Jupyter Notebooks for easy consumption and editing,
1919
are provided under the `notebooks` directory.
20+
2021
To run one of the tutorials, start a Jupyter session in the `notebooks` directory.
2122
```bash
2223
cd notebooks
2324
jupyter notebook
2425
```
2526

27+
If you are running the notebooks from within a virtual environment (recommended), you may create a kernel
28+
attached to the environment as follows:
29+
30+
```bash
31+
python -m ipykernel install --user --name your_env --display-name "Python (your_env)".
32+
```
33+
34+
This kernel should then be available for you under the "Kernel > Change kernel" menu item. If a notebook displays
35+
TensorBoard and you are running it from a remote server, you may forward the port that TensorBoard uses (by default 6006)
36+
to your local machine:
37+
38+
```bash
39+
ssh -N -f -L localhost:6006:localhost:6006 user@remote_ip_address
40+
```
41+
2642
Additionally, some notebooks may make use of the [ipywidgets](https://github.com/jupyter-widgets/ipywidgets) package.
2743
You may need to enable the Jupyter extension to properly see the UIs.
2844
Use the following command to do so: `jupyter nbextension enable --py widgetsnbextension`.

0 commit comments

Comments
 (0)