Skip to content

Commit

Permalink
feat: 2.5.0 -> 2.5.1, Docs:container data mounting, OS Support, typos
Browse files Browse the repository at this point in the history
  • Loading branch information
beberg committed Dec 11, 2020
1 parent d2fb31c commit 53dd3f4
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 25 deletions.
56 changes: 37 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Users can work with containers, or in a local environment.
* Release planning: <https://github.com/NVIDIA/data-science-stack/projects>
* Subscribe to release notifications - watch the
<https://github.com/NVIDIA/data-science-stack> repository.
We suggest "Releases Only", if you haven't subscribved before check the
We suggest "Releases Only", if you haven't subscribed before check the
[help for watching and unwatching repositories](https://help.github.com/en/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-repositories).

## Contents
Expand All @@ -32,21 +32,21 @@ _For usage and command documentation: `./data-science-stack help` at any time._
_Note: The script is designed to run as the user, and ask for sudo password
when needed. Do not run it with `sudo ...`

On Ubuntu 18.04:
On Ubuntu 18.04 or 20.04:

```bash
git clone github.com/NVIDIA/data-science-stack
cd data-science-stack
./data-science-stack setup-system
````

On Red Hat Enterprise Linux 7.x or 8.x:
On Red Hat Enterprise Linux Workstation 7.x or 8.x:

```bash
git clone github.com/NVIDIA/data-science-stack
cd data-science-stack
./data-science-stack setup-system
# script will stop, manually install driver ... (instuctions below)
# script will stop, manually install driver ... (instructions below)
./data-science-stack setup-system
```

Expand All @@ -64,11 +64,15 @@ This creates and runs Jupyter in the container. Users can then connect
with the Jupyter notebook running at <http://localhost:8888/>
Control-C to exit.

To mount data or code into your contianer, see
[How do I mount data into containers?](#How-do-i-mount-data-into-containers)
below.

The reverse of `build-container` is `purge-container`.

For information about Docker refer to <https://docs.docker.com/>

### Option 2 - In a Local Conda Environment (Recommended for inital development work)
### Option 2 - In a Local Conda Environment (Recommended for initial development work)

```bash
./data-science-stack list
Expand Down Expand Up @@ -137,7 +141,7 @@ Creating custom environments is covered in the
* Tesla P, V and T series
* GeForce 10xx and 20xx
* Operating System:
* Ubuntu 18.04.x
* Ubuntu 18.04 or 20.04
* Red Hat Enterprise Linux Workstation 7.5+ or 8.0+ (requires license)
* Other Linux distributions are NOT supported, but may work as long as
the driver and Docker work.
Expand All @@ -146,16 +150,15 @@ Creating custom environments is covered in the
Disable "Secure Boot" in the system BIOS/UEFI before installing Linux.
### Ubuntu 18.04
### Ubuntu
The Data Science stacks are supported on Ubuntu LTS 18.04.1+ with the
4.15+ kernel. Ubuntu can be downloaded from
The Data Science stacks are supported on Ubuntu LTS 18.04.1+ or 20.04
with the 4.15+ kernel. Ubuntu can be downloaded from
<https://www.ubuntu.com/download/desktop>
### Red Hat Enterprise Linux (RHEL)
### Red Hat Enterprise Linux Workstation (RHEL)
The Data Science stacks are supported on Red Hat Enterprise Linux (RHEL)
version 7.5+ or 8.x.
The Data Science stacks are supported on Red Hat Enterprise Linux Workstation(RHEL) version 7.5+ or 8.x.
The RHEL ISO image can be downloaded with the instructions on:
<https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/installation_guide/chap-download-red-hat-enterprise-linux>
Expand All @@ -180,7 +183,7 @@ The minimum version of the NVIDIA driver supported is 455.23.04.
More recent drivers may be available, but may not have been tested with the
data science stacks.
### Ubuntu 18.04 Driver Install
### Ubuntu Driver Install
Driver install for Ubuntu is handled by `data-science-stack setup-system`
so no manual install should be required.
Expand All @@ -195,7 +198,7 @@ be removed (this may have side effects, read the warnings) and reinstalled:
# reboot
```
### Red Hat Enterprise Linux (RHEL) Driver Install
### Red Hat Enterprise Linux Workstation (RHEL) Driver Install
Before attempting to install the driver check that the system does not
have `/usr/bin/nvidia-uninstall` which is left by an old driver .run file.
Expand Down Expand Up @@ -526,28 +529,43 @@ sudo reboot
```
## Troubleshooting FAQ
## Troubleshooting and FAQ
**The driver does not install correctly**
### The driver does not install correctly
Try using `purge-driver` followed by `install-driver`, then check with
`diagnostics`. If the driver was previously installed with a.run file the
script will let you know how to remove the old driver.
**How much disk space is needed?**
### How much disk space is needed?
About 30GB free should be enough. A lot of space is needed during
environment/container creation since Conda has a package cache.
**The script is failing after it cannot reach URLs or download files**
### The script is failing after it cannot reach URLs or download files
To setup the Data Science Stack the script needs to update the OS and other
installed packages, install software from NVIDIA, setup Docker and pull
containers, download Conda packages, clone repos from GitHub, and other tasks.
During this process if the network is down, the the OS or IT firewalls are
During this process if the network is down, the OS or IT firewalls are
blocking any of those hosts errors will occur. Retrying the command will
work in most cases after the problem/block is resolved.
### How do I mount data into containers?
To mount code or data directories into your running container, add additional
`-v "/host/path/:/mount/location"` parameters to the `docker run ...` command.
The latest command to run the container is displayed by
`./data-science-stack run-container` when it runs.
For example to mount ~/notebooks and /data directories in as
/notebooks and /data volumes the Docker command would begin with
````bash
docker run -v ~/notebooks:/notebooks -v /data:/data ...
````
For information about Docker mounts refer to
<https://docs.docker.com/storage/bind-mounts/>
## More Information
Expand Down
11 changes: 6 additions & 5 deletions data-science-stack
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Copyright (c) 2019, NVIDIA CORPORATION. All rights reserved.

# Global Paramaters
STACK_VERSION=2.5.0
STACK_VERSION=2.5.1
NOTEBOOKS_VERSION=0.16

MIN_DRIVER=455.23.04
Expand Down Expand Up @@ -855,7 +855,7 @@ Information Commands:
list
List the available environments.
diagnostics
Display stack sofware versions and info.
Display stack software versions and info.
Setup Commands:
Expand Down Expand Up @@ -902,7 +902,8 @@ Other Subcommands:
WARNING:
These subcommands run parts of the above commands, and should be used with
caution as the ordering and dependecies ARE NOT enforced by the subcommands.
caution as the ordering and dependencies ARE NOT currently enforced by
the subcommands.
install-base
Install base dependencies needed by stacks with apt/yum.
Expand All @@ -917,7 +918,7 @@ Other Subcommands:
setup-user
Setup user permissions to use docker. Useful when multiple users
use a machine. Normal done by setup-system for first user.
The user must have sudo permision.
The user must have sudo permission.
install-cuda
Install the NVIDIA CUDA Toolkit v${MIN_CUDA}+
install-miniconda
Expand All @@ -934,7 +935,7 @@ Other Subcommands:
Download the RAPIDS example notebooks to:
${NOTEBOOKS_DIR}
install-kubernetes
Install a local Kubeternetes stack with kubeadm
Install a local Kubernetes stack with kubeadm
purge-kubernetes
DANGER: Purge the local Kubernetes stack installed with this
script's install-kubernetes command.
Expand Down
2 changes: 1 addition & 1 deletion data-science-stack.Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ RUN DEBIAN_FRONTEND=noninteractive apt-get update -y --fix-missing \

# Create Base environment

ARG STACK_VERSION=2.5.0
ARG STACK_VERSION=2.5.1
ARG CONDA_VERSION=4.8.3
ARG RAPIDS_VERSION=0.16

Expand Down

0 comments on commit 53dd3f4

Please sign in to comment.