Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Improve docs in Notebooks Contrib #245

Open
wants to merge 1 commit into
base: branch-0.12
Choose a base branch
from
Open

[WIP] Improve docs in Notebooks Contrib #245

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions BUILD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,28 @@ A Dockerfile is provided for installing pre-requisite packages & launching Jupyt

# Installation

##
Our container extends the base notebooks container. Unlike our Notebooks repo, which comes with the container, Notebooks Extended is meant to be a constatly updating source of community contributions. You can run Notebooks Extended in a container with 3 steps:
## Downloada and Volumize
Our container extends the base notebooks container. Unlike our Notebooks repo, which comes with the container, Notebooks Contrib is meant to be a constatly updating source of community contributions. You can run Notebooks Contrib in a container with 3 steps (the example shows how if your are using the latest stable branch):

Step 1: Download your RAPIDS container
Here is
Step 1: Download your preferred RAPIDS container from here: https://rapids.ai/start.html#get-rapids
```bash
docker pull rapidsai/rapidsai:latest
```
Step 2: Pull the Notebooks Extended git repo
Step 2: Pull the Notebooks Contrib git repo
```bash
git clone https://github.com/rapidsai/notebooks-extended
git clone https://github.com/rapidsai/notebooks-contrib
```
Step 3: Run the jupyter server in the docker container:
```bash
cd notebooks-extended
docker run --runtime=nvidia --rm -it -p 8888:8888 -p 8787:8787 -p 8786:8786 -v /folder/of/your/choice/:notebooks/extended -it rapidsai/rapidsai:latest
cd notebooks-contrib
docker run --runtime=nvidia --rm -it -p 8888:8888 -p 8787:8787 -p 8786:8786 -v /folder/of/your/choice/:notebooks/contrib -it rapidsai/rapidsai:latest
utils/start-jupyter.sh
```

## Using the Right Branch
Notebooks Contrib has to work with both the stable releases and the nightly releases. To accomplish this, starting in v0.10, we are now patterning Notebook Contrib's branching to be similar to that of Notebooks. Please switch branches accordingly.

- If Running RAPIDS **Nightlies** versions- Latest nightlies notebooks and updates will be `branch-latest`. It will have the latest updates to both notebooks and docs.
- If Running RAPIDS **Stable** versions- Current stable release versions of notebooks will be in `master`. It will also have any recent permalinked materials (blogs, conferences, etc).
- If Running RAPIDS **Older** versions- Older versions of notebooks compatible with older releases with be in `branch-<version numbers>`. These branches will not be maintained.