Add Ngrok instructions to README.md
This commit is contained in:
parent
e029607f88
commit
619e3a4a6f
12
README.md
12
README.md
|
@ -17,6 +17,8 @@ Create your local environment with
|
||||||
poetry install
|
poetry install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Ensure you have created and validated your account with [Ngrok](https://ngrok.com/).
|
||||||
|
|
||||||
### Make you Dataset
|
### Make you Dataset
|
||||||
|
|
||||||
`src/interview/data.py` contains an example function to build the classic [Iris dataset](https://scikit-learn.org/stable/auto_examples/datasets/plot_iris_dataset.html). You can build this with
|
`src/interview/data.py` contains an example function to build the classic [Iris dataset](https://scikit-learn.org/stable/auto_examples/datasets/plot_iris_dataset.html). You can build this with
|
||||||
|
@ -33,4 +35,12 @@ Build the container and run the notebook with
|
||||||
make build run
|
make build run
|
||||||
```
|
```
|
||||||
|
|
||||||
This will copy your data and notebook to the container, install any packages you specified in your `pyproject.toml` file, then run the notebook in the container. Jupyter will be available on port 8888.
|
This will copy your data and notebook to the container, install any packages you specified in your `pyproject.toml` file, then run the notebook in the container. Jupyter will be available on port 8888. Take not of the authentication token.
|
||||||
|
|
||||||
|
### Setup a Tunnel
|
||||||
|
|
||||||
|
Start Ngrok with `ngrok http 8888`. This will give you the URL you will share with the candidate, as illustrated below.
|
||||||
|
|
||||||
|
![Ngrok](ngrok.png)
|
||||||
|
|
||||||
|
By following this link the candidate can login to Jupyter Lab running in the container on your machine using the Jupyter authentication token you took note of above.
|
||||||
|
|
Loading…
Reference in New Issue