Skip to content

Commit 53dd3f4

Browse files
committed
feat: 2.5.0 -> 2.5.1, Docs:container data mounting, OS Support, typos
1 parent d2fb31c commit 53dd3f4

3 files changed

Lines changed: 44 additions & 25 deletions

File tree

README.md

Lines changed: 37 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Users can work with containers, or in a local environment.
1212
* Release planning: <https://github.com/NVIDIA/data-science-stack/projects>
1313
* Subscribe to release notifications - watch the
1414
<https://github.com/NVIDIA/data-science-stack> repository.
15-
We suggest "Releases Only", if you haven't subscribved before check the
15+
We suggest "Releases Only", if you haven't subscribed before check the
1616
[help for watching and unwatching repositories](https://help.github.com/en/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-repositories).
1717

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

35-
On Ubuntu 18.04:
35+
On Ubuntu 18.04 or 20.04:
3636

3737
```bash
3838
git clone github.com/NVIDIA/data-science-stack
3939
cd data-science-stack
4040
./data-science-stack setup-system
4141
````
4242

43-
On Red Hat Enterprise Linux 7.x or 8.x:
43+
On Red Hat Enterprise Linux Workstation 7.x or 8.x:
4444

4545
```bash
4646
git clone github.com/NVIDIA/data-science-stack
4747
cd data-science-stack
4848
./data-science-stack setup-system
49-
# script will stop, manually install driver ... (instuctions below)
49+
# script will stop, manually install driver ... (instructions below)
5050
./data-science-stack setup-system
5151
```
5252

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

67+
To mount data or code into your contianer, see
68+
[How do I mount data into containers?](#How-do-i-mount-data-into-containers)
69+
below.
70+
6771
The reverse of `build-container` is `purge-container`.
6872

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

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

7377
```bash
7478
./data-science-stack list
@@ -137,7 +141,7 @@ Creating custom environments is covered in the
137141
* Tesla P, V and T series
138142
* GeForce 10xx and 20xx
139143
* Operating System:
140-
* Ubuntu 18.04.x
144+
* Ubuntu 18.04 or 20.04
141145
* Red Hat Enterprise Linux Workstation 7.5+ or 8.0+ (requires license)
142146
* Other Linux distributions are NOT supported, but may work as long as
143147
the driver and Docker work.
@@ -146,16 +150,15 @@ Creating custom environments is covered in the
146150
147151
Disable "Secure Boot" in the system BIOS/UEFI before installing Linux.
148152
149-
### Ubuntu 18.04
153+
### Ubuntu
150154
151-
The Data Science stacks are supported on Ubuntu LTS 18.04.1+ with the
152-
4.15+ kernel. Ubuntu can be downloaded from
155+
The Data Science stacks are supported on Ubuntu LTS 18.04.1+ or 20.04
156+
with the 4.15+ kernel. Ubuntu can be downloaded from
153157
<https://www.ubuntu.com/download/desktop>
154158
155-
### Red Hat Enterprise Linux (RHEL)
159+
### Red Hat Enterprise Linux Workstation (RHEL)
156160
157-
The Data Science stacks are supported on Red Hat Enterprise Linux (RHEL)
158-
version 7.5+ or 8.x.
161+
The Data Science stacks are supported on Red Hat Enterprise Linux Workstation(RHEL) version 7.5+ or 8.x.
159162
The RHEL ISO image can be downloaded with the instructions on:
160163
<https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/installation_guide/chap-download-red-hat-enterprise-linux>
161164
@@ -180,7 +183,7 @@ The minimum version of the NVIDIA driver supported is 455.23.04.
180183
More recent drivers may be available, but may not have been tested with the
181184
data science stacks.
182185
183-
### Ubuntu 18.04 Driver Install
186+
### Ubuntu Driver Install
184187
185188
Driver install for Ubuntu is handled by `data-science-stack setup-system`
186189
so no manual install should be required.
@@ -195,7 +198,7 @@ be removed (this may have side effects, read the warnings) and reinstalled:
195198
# reboot
196199
```
197200
198-
### Red Hat Enterprise Linux (RHEL) Driver Install
201+
### Red Hat Enterprise Linux Workstation (RHEL) Driver Install
199202
200203
Before attempting to install the driver check that the system does not
201204
have `/usr/bin/nvidia-uninstall` which is left by an old driver .run file.
@@ -526,28 +529,43 @@ sudo reboot
526529
```
527530
528531
529-
## Troubleshooting FAQ
532+
## Troubleshooting and FAQ
530533
531-
**The driver does not install correctly**
534+
### The driver does not install correctly
532535
533536
Try using `purge-driver` followed by `install-driver`, then check with
534537
`diagnostics`. If the driver was previously installed with a.run file the
535538
script will let you know how to remove the old driver.
536539
537-
**How much disk space is needed?**
540+
### How much disk space is needed?
538541
539542
About 30GB free should be enough. A lot of space is needed during
540543
environment/container creation since Conda has a package cache.
541544
542-
**The script is failing after it cannot reach URLs or download files**
545+
### The script is failing after it cannot reach URLs or download files
543546
544547
To setup the Data Science Stack the script needs to update the OS and other
545548
installed packages, install software from NVIDIA, setup Docker and pull
546549
containers, download Conda packages, clone repos from GitHub, and other tasks.
547-
During this process if the network is down, the the OS or IT firewalls are
550+
During this process if the network is down, the OS or IT firewalls are
548551
blocking any of those hosts errors will occur. Retrying the command will
549552
work in most cases after the problem/block is resolved.
550553
554+
### How do I mount data into containers?
555+
556+
To mount code or data directories into your running container, add additional
557+
`-v "/host/path/:/mount/location"` parameters to the `docker run ...` command.
558+
The latest command to run the container is displayed by
559+
`./data-science-stack run-container` when it runs.
560+
561+
For example to mount ~/notebooks and /data directories in as
562+
/notebooks and /data volumes the Docker command would begin with
563+
````bash
564+
docker run -v ~/notebooks:/notebooks -v /data:/data ...
565+
````
566+
567+
For information about Docker mounts refer to
568+
<https://docs.docker.com/storage/bind-mounts/>
551569
552570
## More Information
553571

data-science-stack

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# Copyright (c) 2019, NVIDIA CORPORATION. All rights reserved.
44

55
# Global Paramaters
6-
STACK_VERSION=2.5.0
6+
STACK_VERSION=2.5.1
77
NOTEBOOKS_VERSION=0.16
88

99
MIN_DRIVER=455.23.04
@@ -855,7 +855,7 @@ Information Commands:
855855
list
856856
List the available environments.
857857
diagnostics
858-
Display stack sofware versions and info.
858+
Display stack software versions and info.
859859
860860
Setup Commands:
861861
@@ -902,7 +902,8 @@ Other Subcommands:
902902
903903
WARNING:
904904
These subcommands run parts of the above commands, and should be used with
905-
caution as the ordering and dependecies ARE NOT enforced by the subcommands.
905+
caution as the ordering and dependencies ARE NOT currently enforced by
906+
the subcommands.
906907
907908
install-base
908909
Install base dependencies needed by stacks with apt/yum.
@@ -917,7 +918,7 @@ Other Subcommands:
917918
setup-user
918919
Setup user permissions to use docker. Useful when multiple users
919920
use a machine. Normal done by setup-system for first user.
920-
The user must have sudo permision.
921+
The user must have sudo permission.
921922
install-cuda
922923
Install the NVIDIA CUDA Toolkit v${MIN_CUDA}+
923924
install-miniconda
@@ -934,7 +935,7 @@ Other Subcommands:
934935
Download the RAPIDS example notebooks to:
935936
${NOTEBOOKS_DIR}
936937
install-kubernetes
937-
Install a local Kubeternetes stack with kubeadm
938+
Install a local Kubernetes stack with kubeadm
938939
purge-kubernetes
939940
DANGER: Purge the local Kubernetes stack installed with this
940941
script's install-kubernetes command.

data-science-stack.Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ RUN DEBIAN_FRONTEND=noninteractive apt-get update -y --fix-missing \
3232

3333
# Create Base environment
3434

35-
ARG STACK_VERSION=2.5.0
35+
ARG STACK_VERSION=2.5.1
3636
ARG CONDA_VERSION=4.8.3
3737
ARG RAPIDS_VERSION=0.16
3838

0 commit comments

Comments
 (0)