aboutsummaryrefslogtreecommitdiffhomepage
path: root/tensorflow/tools/dockerfiles
diff options
context:
space:
mode:
authorGravatar Austin Anderson <angerson@google.com>2018-08-01 15:23:10 -0700
committerGravatar Austin Anderson <angerson@google.com>2018-08-01 15:23:10 -0700
commit04fb295a409b426ea44463934c4cec251990bc37 (patch)
tree3b5426c3478c25a043bb5d27eb5e0279a63018c2 /tensorflow/tools/dockerfiles
parent94e0c6bb67b82eb1a43135eb5edff6c6fe4ab638 (diff)
Update readme
Diffstat (limited to 'tensorflow/tools/dockerfiles')
-rw-r--r--tensorflow/tools/dockerfiles/README.md23
1 files changed, 22 insertions, 1 deletions
diff --git a/tensorflow/tools/dockerfiles/README.md b/tensorflow/tools/dockerfiles/README.md
index 1fe51adb4a..4786f8ec81 100644
--- a/tensorflow/tools/dockerfiles/README.md
+++ b/tensorflow/tools/dockerfiles/README.md
@@ -11,12 +11,33 @@ The Dockerfiles in the `dockerfiles` directory must have their build context set
to **the directory with this README.md** to copy in helper files. For example:
```bash
-$ docker build -f ./dockerfiles/cpu.Dockerfile -t tf-cpu .
+$ docker build -f ./dockerfiles/cpu.Dockerfile -t tf .
```
Each Dockerfile has its own set of available `--build-arg`s which are documented
in the Dockerfile itself.
+## Running
+
+After building the image with the tag `tf` (for example):
+
+```bash
+# A volume mount is optional but highly recommended, especially for Jupyter
+
+# CPU-based images
+$ docker run -u $(id -u):$(id -g) -v $(PWD):/my-devel -it tf
+
+# GPU-based images (set up nvidia-docker2 first)
+$ docker run --runtime=nvidia -u $(id -u):$(id -g) -v $(PWD):/my-devel -it tf
+
+# Images with Jupyter run on port 8888, and needs a volume for notebooks
+$ docker run --user $(id -u):$(id -g) -p 8888:8888 -v $(PWD):/notebooks -it tf
+
+# Development images
+$ docker run --user $(id -u):$(id -g) -it tf
+docker$ git clone https://github.com/tensorflow/tensorflow
+```
+
## Maintaining
To make changes to TensorFlow's Dockerfiles, you'll update `spec.yml` and the