From 49751641f253e97b79ce858360f6ef712b024005 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joonhyung=20Lee/=EC=9D=B4=EC=A4=80=ED=98=95?= <33523965+veritas9872@users.noreply.github.com> Date: Sun, 9 Apr 2023 18:01:16 +0900 Subject: [PATCH] Update README.md Fix explanation of services. --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 762a664..22c470d 100644 --- a/README.md +++ b/README.md @@ -71,9 +71,9 @@ If this is your first time using this project, follow these steps: ### Explanation of services Different Docker Compose services are organized to serve different needs. -- `train`, the default service, is used when compiled dependencies are necessary - and when PyTorch needs to be compiled from source due to Compute Capability - issues, etc. +- `train`, the default service, should be used when compiled dependencies are + necessary or when PyTorch needs to be compiled from source due to + Compute Capability issues, etc. - `devel` is designed for PyTorch CUDA/C++ developers who need to recompile frequently and have many complex dependencies. - `ngc` is derived from the official NVIDIA PyTorch HPC images with the option @@ -82,13 +82,14 @@ Different Docker Compose services are organized to serve different needs. change greatly between different releases and that configurations for one release may not work for another one. - `hub` is derived from the official PyTorch Docker Hub image and serves a - similar function as the `ngc` service described above. + similar function as the `ngc` service described above. However, + the PyTorch Docker images are more stable compared to the NGC images. - `simple` is derived from the Official Ubuntu Linux image by default as some corporations restrict the use of Docker images not officially verified by Docker. It installs all packages via `conda` by default and can optionally - install reproducible environments via `conda-lock`. Note that `pip` packages - can also be installed via `conda`. Also, the base image can be configured to - use images other than the Official Linux Docker images. + install highly reproducible environments via `conda-lock`. Note that + `pip` packages can also be installed via `conda`. Also, the base image can + be configured to use images other than the Official Linux Docker images. **The `simple` service is recommended for users without compiled dependencies.** The `Makefile` has been configured to take values specified in the `.env` file