diff --git a/docs/README.md b/docs/README.md index b80af3c9f..ebd0636cb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ This folder contains the scripts necessary to build the repository documentation. You can view the documentation at -. +. ## Contributing to Docs diff --git a/docs/requirements-doc.txt b/docs/requirements-doc.txt index cb529fd33..8d8ee798c 100644 --- a/docs/requirements-doc.txt +++ b/docs/requirements-doc.txt @@ -10,6 +10,9 @@ sphinx-multiversion recommonmark>=0.6 nbsphinx>=0.6 +# smx +mergedeep==1.3.4 + # packages necessary to run tests and push PRs # assumes requirements for nvtabular logic are already installed diff --git a/docs/source/containers.rst b/docs/source/containers.rst index 1fca5de5b..ef352e676 100644 --- a/docs/source/containers.rst +++ b/docs/source/containers.rst @@ -4,33 +4,53 @@ Merlin Containers Merlin and the Merlin component libraries are available in Docker containers from the NVIDIA GPU Cloud (NCG) catalog. Access the catalog of containers at http://ngc.nvidia.com/catalog/containers. +Training Containers +-------------------- + The following table identifies the container names, catalog URL, and key Merlin components. .. list-table:: :widths: 25 50 25 :header-rows: 1 - * - Container Name + * - Training Container - NGC Catalog URL - Key Merlin Components - * - merlin-tensorflow-inference - - https://catalog.ngc.nvidia.com/orgs/nvidia/teams/merlin/containers/merlin-tensorflow-inference - - NVTabular, Tensorflow, and Triton Inference Server - * - merlin-pytorch-inference - - https://catalog.ngc.nvidia.com/orgs/nvidia/teams/merlin/containers/merlin-pytorch-inference - - NVTabular, PyTorch, and Triton Inference Server - * - merlin-inference - - https://ngc.nvidia.com/catalog/containers/nvidia:merlin:merlin-inference - - NVTabular, HugeCTR, and Triton Inference Server * - merlin-training - - https://ngc.nvidia.com/catalog/containers/nvidia:merlin:merlin-training + - https://catalog.ngc.nvidia.com/orgs/nvidia/teams/merlin/containers/merlin-training - NVTabular and HugeCTR * - merlin-tensorflow-training - - https://ngc.nvidia.com/catalog/containers/nvidia:merlin:merlin-tensorflow-training + - https://catalog.ngc.nvidia.com/orgs/nvidia/teams/merlin/containers/merlin-tensorflow-training - NVTabular, TensorFlow, and HugeCTR Tensorflow Embedding plugin * - merlin-pytorch-training - - https://ngc.nvidia.com/catalog/containers/nvidia:merlin:merlin-pytorch-training + - https://catalog.ngc.nvidia.com/orgs/nvidia/teams/merlin/containers/merlin-pytorch-training - NVTabular and PyTorch To use these containers, you must install the `NVIDIA Container Toolkit `_ to provide GPU support for Docker. You can use the NGC links referenced in the preceding table for more information about how to launch and run these containers. + + +Inference Containers +-------------------- + +The following table identifies the container names, catalog URL, and key Merlin components. + +.. list-table:: + :widths: 25 50 25 + :header-rows: 1 + + * - Inference Container + - NGC Catalog URL + - Key Merlin Components + * - merlin-inference + - https://catalog.ngc.nvidia.com/orgs/nvidia/teams/merlin/containers/merlin-inference + - NVTabular, HugeCTR, and Triton Inference Server + * - merlin-tensorflow-inference + - https://catalog.ngc.nvidia.com/orgs/nvidia/teams/merlin/containers/merlin-tensorflow-inference + - NVTabular, Tensorflow, and Triton Inference Server + * - merlin-pytorch-inference + - https://catalog.ngc.nvidia.com/orgs/nvidia/teams/merlin/containers/merlin-pytorch-inference + - NVTabular, PyTorch, and Triton Inference Server + +To use these containers, you must install the `NVIDIA Container Toolkit `_ to provide GPU support for Docker. +You can use the NGC links referenced in the preceding table for more information about how to launch and run these containers. diff --git a/docs/source/generated/nvcr.io-nvidia-merlin-merlin-inference.rst b/docs/source/generated/nvcr.io-nvidia-merlin-merlin-inference.rst new file mode 100644 index 000000000..0829d7ef4 --- /dev/null +++ b/docs/source/generated/nvcr.io-nvidia-merlin-merlin-inference.rst @@ -0,0 +1,92 @@ +.. table:: + :align: left + + ============================== ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= + Container Release Release 22.03 Release 22.02 Release 22.01 Release 21.12 Release 21.11 Release 21.09 + ============================== ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= + **DGX** + ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + **DGX System** * DGX-1 * DGX-1 * DGX-1 * DGX-1 * DGX-1 * DGX-1 + + * DGX-2 * DGX-2 * DGX-2 * DGX-2 * DGX-2 * DGX-2 + + * DGX A100 * DGX A100 * DGX A100 * DGX A100 * DGX A100 * DGX A100 + + * DGX Station * DGX Station * DGX Station * DGX Station * DGX Station * DGX Station + + **Operating System** Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS + + **NVIDIA Certified Systems** + ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + **NVIDIA Driver** NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 + + or later is required. However, or later is required. However, or later is required. However, or later is required. However, or later is required. However, or later is required. However, + + if you're running on Data Center if you're running on Data Center if you're running on Data Center if you're running on Data Center if you're running on Data Center if you're running on Data Center + + GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, + + you can use any of the following you can use any of the following you can use any of the following you can use any of the following you can use any of the following you can use any of the following + + NVIDIA Driver versions: NVIDIA Driver versions: NVIDIA Driver versions: NVIDIA Driver versions: NVIDIA Driver versions: NVIDIA Driver versions: + + + + * 418.40 (or later R418) * 418.40 (or later R418) * 418.40 (or later R418) * 418.40 (or later R418) * 418.40 (or later R418) * 418.40 (or later R418) + + * 440.33 (or later R440) * 440.33 (or later R440) * 440.33 (or later R440) * 440.33 (or later R440) * 440.33 (or later R440) * 440.33 (or later R440) + + * 450.51 (or later R450) * 450.51 (or later R450) * 450.51 (or later R450) * 450.51 (or later R450) * 450.51 (or later R450) * 450.51 (or later R450) + + * 460.27 (or later R460) * 460.27 (or later R460) * 460.27 (or later R460) * 460.27 (or later R460) * 460.27 (or later R460) * 460.27 (or later R460) + + + + **Note**: The CUDA Driver **Note**: The CUDA Driver **Note**: The CUDA Driver **Note**: The CUDA Driver **Note**: The CUDA Driver **Note**: The CUDA Driver + + Compatability Package does not Compatability Package does not Compatability Package does not Compatability Package does not Compatability Package does not Compatability Package does not + + support all drivers. support all drivers. support all drivers. support all drivers. support all drivers. support all drivers. + + **GPU Model** * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ + + * `Turing `_ * `Turing `_ * `Turing `_ * `Turing `_ * `Turing `_ * `Turing `_ + + * `Volta `_ * `Volta `_ * `Volta `_ * `Volta `_ * `Volta `_ * `Volta `_ + + * `Pascal `_ * `Pascal `_ * `Pascal `_ * `Pascal `_ * `Pascal `_ * `Pascal `_ + + **Base Container Image** + ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + **Container Operating System** Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS + + **Base Container** Triton version 22.02 Triton version 22.01 Triton version 21.12 Triton version 21.10 Triton version 21.10 Triton version 21.07 + + **CUDA** 11.6.0.021 11.6.0.020 11.5.0.029 11.5.0.029 11.4.3.001 11.4.0.031 + + **RMM** 0+unknown 21.12.00 21.10.00a+42.gae27a57 21.08.02 21.08.02 0+unknown + + **cuDF** 21.12.02 21.12.02 21.10.00a+345.ge05bd4bf3c.dirty 21.08.03 21.08.03 21.08.02 + + **cuDNN** 8.3.2.44+cuda11.5 8.3.2.44+cuda11.5 8.3.1.22 8.3.0.96 8.2.4.15 8.2.2.26 + + **Merlin Core** v0.1.1+12.g53b1ffc Not applicable Not applicable Not applicable Not applicable Not applicable + + **Merlin Models** Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable + + **Merlin Systems** 0+untagged.9.gccd0e15 Not applicable Not applicable Not applicable Not applicable Not applicable + + **NVTabular** 0.11.0+20.gafa0e43 0.10.0 0.9.0+1.g31f9350 0.8.0 0.7.1 0.7.0 + + **Transformers4Rec** 0.1.6+4.ga153d6d 0.1.4 0.1.4 0.1.3 0.1.2 0.1.1 + + **HugeCTR** Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable + + **SM** Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable + + **Triton Inference Server** 2.19.0 2.18.0 2.17.0 2.16.0 2.15.0 2.12.0 + + **Size** 9.19 GB 20.62 GB 25.93 GB 27.26 GB 24.61 GB 28.72 GB + + ============================== ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= + diff --git a/docs/source/generated/nvcr.io-nvidia-merlin-merlin-pytorch-inference.rst b/docs/source/generated/nvcr.io-nvidia-merlin-merlin-pytorch-inference.rst new file mode 100644 index 000000000..126e872ea --- /dev/null +++ b/docs/source/generated/nvcr.io-nvidia-merlin-merlin-pytorch-inference.rst @@ -0,0 +1,94 @@ +.. table:: + :align: left + + ============================== ================================================================================= + Container Release Release 22.03 + ============================== ================================================================================= + **DGX** + ----------------------------------------------------------------------------------------------------------------- + **DGX System** * DGX-1 + + * DGX-2 + + * DGX A100 + + * DGX Station + + **Operating System** Ubuntu 20.04.3 LTS + + **NVIDIA Certified Systems** + ----------------------------------------------------------------------------------------------------------------- + **NVIDIA Driver** NVIDIA Driver version 465.19.01 + + or later is required. However, + + if you're running on Data Center + + GPUs (formerly Tesla) such as T4, + + you can use any of the following + + NVIDIA Driver versions: + + + + * 418.40 (or later R418) + + * 440.33 (or later R440) + + * 450.51 (or later R450) + + * 460.27 (or later R460) + + + + **Note**: The CUDA Driver + + Compatability Package does not + + support all drivers. + + **GPU Model** * `NVIDIA Ampere GPU Architecture `_ + + * `Turing `_ + + * `Volta `_ + + * `Pascal `_ + + **Base Container Image** + ----------------------------------------------------------------------------------------------------------------- + **Container Operating System** Ubuntu 20.04.3 LTS + + **Base Container** Triton version 22.02 + + **CUDA** 11.6.0.021 + + **RMM** 21.12.00 + + **cuDF** 21.12.02 + + **cuDNN** 8.3.2.44+cuda11.5 + + **Merlin Core** v0.1.1+3.gee1d59d + + **Merlin Models** Not applicable + + **Merlin Systems** Not applicable + + **NVTabular** 0.11.0 + + **Transformers4Rec** 0.1.6 + + **HugeCTR** Not applicable + + **SM** Not applicable + + **PyTorch** Not applicable + + **Triton Inference Server** 2.19.0 + + **Size** 9.72 GB + + ============================== ================================================================================= + diff --git a/docs/source/generated/nvcr.io-nvidia-merlin-merlin-pytorch-training.rst b/docs/source/generated/nvcr.io-nvidia-merlin-merlin-pytorch-training.rst new file mode 100644 index 000000000..db172280a --- /dev/null +++ b/docs/source/generated/nvcr.io-nvidia-merlin-merlin-pytorch-training.rst @@ -0,0 +1,92 @@ +.. table:: + :align: left + + ============================== ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= + Container Release Release 22.03 Release 22.02 Release 22.01 Release 21.12 Release 21.11 Release 21.09 + ============================== ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= + **DGX** + ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + **DGX System** * DGX-1 * DGX-1 * DGX-1 * DGX-1 * DGX-1 * DGX-1 + + * DGX-2 * DGX-2 * DGX-2 * DGX-2 * DGX-2 * DGX-2 + + * DGX A100 * DGX A100 * DGX A100 * DGX A100 * DGX A100 * DGX A100 + + * DGX Station * DGX Station * DGX Station * DGX Station * DGX Station * DGX Station + + **Operating System** Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS + + **NVIDIA Certified Systems** + ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + **NVIDIA Driver** NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 + + or later is required. However, or later is required. However, or later is required. However, or later is required. However, or later is required. However, or later is required. However, + + if you're running on Data Center if you're running on Data Center if you're running on Data Center if you're running on Data Center if you're running on Data Center if you're running on Data Center + + GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, + + you can use any of the following you can use any of the following you can use any of the following you can use any of the following you can use any of the following you can use any of the following + + NVIDIA Driver versions: NVIDIA Driver versions: NVIDIA Driver versions: NVIDIA Driver versions: NVIDIA Driver versions: NVIDIA Driver versions: + + + + * 418.40 (or later R418) * 418.40 (or later R418) * 418.40 (or later R418) * 418.40 (or later R418) * 418.40 (or later R418) * 418.40 (or later R418) + + * 440.33 (or later R440) * 440.33 (or later R440) * 440.33 (or later R440) * 440.33 (or later R440) * 440.33 (or later R440) * 440.33 (or later R440) + + * 450.51 (or later R450) * 450.51 (or later R450) * 450.51 (or later R450) * 450.51 (or later R450) * 450.51 (or later R450) * 450.51 (or later R450) + + * 460.27 (or later R460) * 460.27 (or later R460) * 460.27 (or later R460) * 460.27 (or later R460) * 460.27 (or later R460) * 460.27 (or later R460) + + + + **Note**: The CUDA Driver **Note**: The CUDA Driver **Note**: The CUDA Driver **Note**: The CUDA Driver **Note**: The CUDA Driver **Note**: The CUDA Driver + + Compatability Package does not Compatability Package does not Compatability Package does not Compatability Package does not Compatability Package does not Compatability Package does not + + support all drivers. support all drivers. support all drivers. support all drivers. support all drivers. support all drivers. + + **GPU Model** * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ + + * `Turing `_ * `Turing `_ * `Turing `_ * `Turing `_ * `Turing `_ * `Turing `_ + + * `Volta `_ * `Volta `_ * `Volta `_ * `Volta `_ * `Volta `_ * `Volta `_ + + * `Pascal `_ * `Pascal `_ * `Pascal `_ * `Pascal `_ * `Pascal `_ * `Pascal `_ + + **Base Container Image** + ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + **Container Operating System** Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS + + **Base Container** nvcr.io/nvidia/pytorch:22.02-py3 nvcr.io/nvidia/pytorch:22.01-py3 nvcr.io/nvidia/pytorch:21.12-py3 nvcr.io/nvidia/pytorch:21.11-py3 nvcr.io/nvidia/pytorch:21.10-py3 nvcr.io/nvidia/pytorch:21.07-py3 + + **CUDA** 11.6.0.021 11.6.0.020 11.5.0.029 11.5.0.029 11.4.3.001 11.4.0.031 + + **RMM** 21.12.00a+31.g0acbd51 21.12.00a+31.g0acbd51 0+untagged.1.gae27a57 0+untagged.1.gccd9647 0+unknown 0+unknown + + **cuDF** 21.12.00a+293.g0930f712e6 21.12.00a+293.g0930f712e6 0+untagged.1.ge05bd4b 0+untagged.1.g0a00579 21.08.03 21.08.03 + + **cuDNN** 8.3.2.44+cuda11.5 8.3.2.44+cuda11.5 8.3.1.22 8.3.0.96 8.2.4.15 8.2.2.26 + + **Merlin Core** v0.1.1+3.gee1d59d Not applicable Not applicable Not applicable Not applicable Not applicable + + **Merlin Models** Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable + + **Merlin Systems** Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable + + **NVTabular** 0.11.0 0.10.0 0.9.0+1.g31f9350 0.8.0 0.7.1 0.7.0+1.g2aa56e5 + + **Transformers4Rec** 0.1.6 0.1.4 0.1.4 0.1.3 0.1.2 0.1.1 + + **HugeCTR** Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable + + **SM** Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable + + **PyTorch** 1.11.0a0+17540c5 1.11.0a0+bfe5ad2 1.11.0a0+b6df043 1.11.0a0+b6df043 1.10.0a0+0aef44c 1.9.1+cu102 + + **Size** 14.18 GB 15.02 GB 15.2 GB 14.8 GB 14.31 GB 18.78 GB + + ============================== ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= + diff --git a/docs/source/generated/nvcr.io-nvidia-merlin-merlin-tensorflow-inference.rst b/docs/source/generated/nvcr.io-nvidia-merlin-merlin-tensorflow-inference.rst new file mode 100644 index 000000000..a68780880 --- /dev/null +++ b/docs/source/generated/nvcr.io-nvidia-merlin-merlin-tensorflow-inference.rst @@ -0,0 +1,94 @@ +.. table:: + :align: left + + ============================== ================================================================================= + Container Release Release 22.03 + ============================== ================================================================================= + **DGX** + ----------------------------------------------------------------------------------------------------------------- + **DGX System** * DGX-1 + + * DGX-2 + + * DGX A100 + + * DGX Station + + **Operating System** Ubuntu 20.04.3 LTS + + **NVIDIA Certified Systems** + ----------------------------------------------------------------------------------------------------------------- + **NVIDIA Driver** NVIDIA Driver version 465.19.01 + + or later is required. However, + + if you're running on Data Center + + GPUs (formerly Tesla) such as T4, + + you can use any of the following + + NVIDIA Driver versions: + + + + * 418.40 (or later R418) + + * 440.33 (or later R440) + + * 450.51 (or later R450) + + * 460.27 (or later R460) + + + + **Note**: The CUDA Driver + + Compatability Package does not + + support all drivers. + + **GPU Model** * `NVIDIA Ampere GPU Architecture `_ + + * `Turing `_ + + * `Volta `_ + + * `Pascal `_ + + **Base Container Image** + ----------------------------------------------------------------------------------------------------------------- + **Container Operating System** Ubuntu 20.04.3 LTS + + **Base Container** Triton version 22.02 + + **CUDA** 11.6.0.021 + + **RMM** 21.12.00 + + **cuDF** 21.12.02 + + **cuDNN** 8.3.2.44+cuda11.5 + + **Merlin Core** v0.1.1+3.gee1d59d + + **Merlin Models** Not applicable + + **Merlin Systems** Not applicable + + **NVTabular** 0.11.0 + + **Transformers4Rec** 0.1.6 + + **HugeCTR** Not applicable + + **SM** Not applicable + + **TensorFlow** Not applicable + + **Triton Inference Server** 2.19.0 + + **Size** 9.2 GB + + ============================== ================================================================================= + diff --git a/docs/source/generated/nvcr.io-nvidia-merlin-merlin-tensorflow-training.rst b/docs/source/generated/nvcr.io-nvidia-merlin-merlin-tensorflow-training.rst new file mode 100644 index 000000000..dfba11bcf --- /dev/null +++ b/docs/source/generated/nvcr.io-nvidia-merlin-merlin-tensorflow-training.rst @@ -0,0 +1,92 @@ +.. table:: + :align: left + + ============================== ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= + Container Release Release 22.03 Release 22.02 Release 22.01 Release 21.12 Release 21.11 Release 21.09 + ============================== ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= + **DGX** + ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + **DGX System** * DGX-1 * DGX-1 * DGX-1 * DGX-1 * DGX-1 * DGX-1 + + * DGX-2 * DGX-2 * DGX-2 * DGX-2 * DGX-2 * DGX-2 + + * DGX A100 * DGX A100 * DGX A100 * DGX A100 * DGX A100 * DGX A100 + + * DGX Station * DGX Station * DGX Station * DGX Station * DGX Station * DGX Station + + **Operating System** Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS + + **NVIDIA Certified Systems** + ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + **NVIDIA Driver** NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 + + or later is required. However, or later is required. However, or later is required. However, or later is required. However, or later is required. However, or later is required. However, + + if you're running on Data Center if you're running on Data Center if you're running on Data Center if you're running on Data Center if you're running on Data Center if you're running on Data Center + + GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, + + you can use any of the following you can use any of the following you can use any of the following you can use any of the following you can use any of the following you can use any of the following + + NVIDIA Driver versions: NVIDIA Driver versions: NVIDIA Driver versions: NVIDIA Driver versions: NVIDIA Driver versions: NVIDIA Driver versions: + + + + * 418.40 (or later R418) * 418.40 (or later R418) * 418.40 (or later R418) * 418.40 (or later R418) * 418.40 (or later R418) * 418.40 (or later R418) + + * 440.33 (or later R440) * 440.33 (or later R440) * 440.33 (or later R440) * 440.33 (or later R440) * 440.33 (or later R440) * 440.33 (or later R440) + + * 450.51 (or later R450) * 450.51 (or later R450) * 450.51 (or later R450) * 450.51 (or later R450) * 450.51 (or later R450) * 450.51 (or later R450) + + * 460.27 (or later R460) * 460.27 (or later R460) * 460.27 (or later R460) * 460.27 (or later R460) * 460.27 (or later R460) * 460.27 (or later R460) + + + + **Note**: The CUDA Driver **Note**: The CUDA Driver **Note**: The CUDA Driver **Note**: The CUDA Driver **Note**: The CUDA Driver **Note**: The CUDA Driver + + Compatability Package does not Compatability Package does not Compatability Package does not Compatability Package does not Compatability Package does not Compatability Package does not + + support all drivers. support all drivers. support all drivers. support all drivers. support all drivers. support all drivers. + + **GPU Model** * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ + + * `Turing `_ * `Turing `_ * `Turing `_ * `Turing `_ * `Turing `_ * `Turing `_ + + * `Volta `_ * `Volta `_ * `Volta `_ * `Volta `_ * `Volta `_ * `Volta `_ + + * `Pascal `_ * `Pascal `_ * `Pascal `_ * `Pascal `_ * `Pascal `_ * `Pascal `_ + + **Base Container Image** + ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + **Container Operating System** Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS + + **Base Container** nvcr.io/nvidia/tensorflow:22.02-tf2-py3 nvcr.io/nvidia/tensorflow:22.01-tf2-py3 nvcr.io/nvidia/tensorflow:21.12-tf2-py3 nvcr.io/nvidia/tensorflow:21.11-tf2-py3 nvcr.io/nvidia/tensorflow:21.10-tf2-py3 nvcr.io/nvidia/tensorflow:21.07-tf2-py3 + + **CUDA** 11.6.0.021 11.6.0.020 11.5.0.029 11.5.0.029 11.4.3.001 11.4.0.031 + + **RMM** 21.12.00a+31.g0acbd51 21.12.00a+31.g0acbd51 0+untagged.1.gae27a57 0+untagged.1.gccd9647 0+unknown 0+unknown + + **cuDF** 21.12.00a+293.g0930f712e6 21.12.00a+293.g0930f712e6 0+untagged.1.ge05bd4b 0+untagged.1.g0a00579 21.08.03 21.08.02 + + **cuDNN** 8.3.2.44+cuda11.5 8.3.2.44+cuda11.5 8.3.1.22 8.3.0.96 8.2.4.15 8.2.2.26 + + **Merlin Core** v0.1.1+3.gee1d59d Not applicable Not applicable Not applicable Not applicable Not applicable + + **Merlin Models** Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable + + **Merlin Systems** Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable + + **NVTabular** 0.11.0 0.10.0 0.9.0+1.g31f9350 0.8.0 0.7.1 0.7.0 + + **Transformers4Rec** 0.1.6 0.1.4 0.1.4 0.1.3 0.1.2 0.1.1 + + **HugeCTR** Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable + + **SM** Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable + + **TensorFlow** 2.7.0 2.7.0 2.6.2 2.6.0 2.6.1 2.5.0 + + **Size** 12.68 GB 13.37 GB 13.66 GB 13.05 GB 13.38 GB 13.85 GB + + ============================== ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= + diff --git a/docs/source/generated/nvcr.io-nvidia-merlin-merlin-training.rst b/docs/source/generated/nvcr.io-nvidia-merlin-merlin-training.rst new file mode 100644 index 000000000..133da6406 --- /dev/null +++ b/docs/source/generated/nvcr.io-nvidia-merlin-merlin-training.rst @@ -0,0 +1,90 @@ +.. table:: + :align: left + + ============================== ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= + Container Release Release 22.03 Release 22.02 Release 22.01 Release 21.12 Release 21.11 Release 21.09 + ============================== ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= + **DGX** + ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + **DGX System** * DGX-1 * DGX-1 * DGX-1 * DGX-1 * DGX-1 * DGX-1 + + * DGX-2 * DGX-2 * DGX-2 * DGX-2 * DGX-2 * DGX-2 + + * DGX A100 * DGX A100 * DGX A100 * DGX A100 * DGX A100 * DGX A100 + + * DGX Station * DGX Station * DGX Station * DGX Station * DGX Station * DGX Station + + **Operating System** Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS + + **NVIDIA Certified Systems** + ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + **NVIDIA Driver** NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 NVIDIA Driver version 465.19.01 + + or later is required. However, or later is required. However, or later is required. However, or later is required. However, or later is required. However, or later is required. However, + + if you're running on Data Center if you're running on Data Center if you're running on Data Center if you're running on Data Center if you're running on Data Center if you're running on Data Center + + GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, GPUs (formerly Tesla) such as T4, + + you can use any of the following you can use any of the following you can use any of the following you can use any of the following you can use any of the following you can use any of the following + + NVIDIA Driver versions: NVIDIA Driver versions: NVIDIA Driver versions: NVIDIA Driver versions: NVIDIA Driver versions: NVIDIA Driver versions: + + + + * 418.40 (or later R418) * 418.40 (or later R418) * 418.40 (or later R418) * 418.40 (or later R418) * 418.40 (or later R418) * 418.40 (or later R418) + + * 440.33 (or later R440) * 440.33 (or later R440) * 440.33 (or later R440) * 440.33 (or later R440) * 440.33 (or later R440) * 440.33 (or later R440) + + * 450.51 (or later R450) * 450.51 (or later R450) * 450.51 (or later R450) * 450.51 (or later R450) * 450.51 (or later R450) * 450.51 (or later R450) + + * 460.27 (or later R460) * 460.27 (or later R460) * 460.27 (or later R460) * 460.27 (or later R460) * 460.27 (or later R460) * 460.27 (or later R460) + + + + **Note**: The CUDA Driver **Note**: The CUDA Driver **Note**: The CUDA Driver **Note**: The CUDA Driver **Note**: The CUDA Driver **Note**: The CUDA Driver + + Compatability Package does not Compatability Package does not Compatability Package does not Compatability Package does not Compatability Package does not Compatability Package does not + + support all drivers. support all drivers. support all drivers. support all drivers. support all drivers. support all drivers. + + **GPU Model** * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ * `NVIDIA Ampere GPU Architecture `_ + + * `Turing `_ * `Turing `_ * `Turing `_ * `Turing `_ * `Turing `_ * `Turing `_ + + * `Volta `_ * `Volta `_ * `Volta `_ * `Volta `_ * `Volta `_ * `Volta `_ + + * `Pascal `_ * `Pascal `_ * `Pascal `_ * `Pascal `_ * `Pascal `_ * `Pascal `_ + + **Base Container Image** + ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + **Container Operating System** Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS Ubuntu 20.04.3 LTS + + **Base Container** Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable + + **CUDA** 11.6.0.021 11.6.0.020 11.5.0.029 11.5.0.029 11.4.3.001 11.4.0.031 + + **RMM** 21.12.00a+31.g0acbd51 21.12.00a+31.g0acbd51 0+untagged.1.gae27a57 21.08.02 0+unknown 0+unknown + + **cuDF** 21.12.00a+293.g0930f712e6 21.12.00a+293.g0930f712e6 0+untagged.1.ge05bd4b 21.08.03 21.08.03 21.08.02 + + **cuDNN** 8.3.2.44+cuda11.5 8.3.2.44+cuda11.5 8.3.1.22 8.3.0.96 8.2.4.15 8.2.2.26 + + **Merlin Core** v0.1.1+3.gee1d59d Not applicable Not applicable Not applicable Not applicable Not applicable + + **Merlin Models** Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable + + **Merlin Systems** Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable + + **NVTabular** 0.11.0 0.10.0 0.9.0+1.g31f9350 0.8.0 0.7.1 0.7.0 + + **Transformers4Rec** Not applicable Not applicable Not applicable Not applicable Not applicable Not applicable + + **HugeCTR** 3.4.0 3.4.0 3.3.1 3.3.0 3.2.1 3.2.0 + + **SM** 60, 61, 70, 75, 80 60, 61, 70, 75, 80 60, 61, 70, 75, 80 60, 61, 70, 75, 80 60, 61, 70, 75, 80 60, 61, 70, 75, 80 + + **Size** 14.32 GB 15.84 GB 15.18 GB 15.19 GB 13.89 GB 15.35 GB + + ============================== ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= ================================================================================= + diff --git a/docs/source/index.rst b/docs/source/index.rst index 45da365d9..5306334f3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -7,6 +7,7 @@ Merlin Introduction Example Notebooks Merlin Containers + Support Matrix Indices and tables ================== diff --git a/docs/source/support_matrix/index.rst b/docs/source/support_matrix/index.rst new file mode 100644 index 000000000..5fe6c3da9 --- /dev/null +++ b/docs/source/support_matrix/index.rst @@ -0,0 +1,14 @@ +Merlin Support Matrix +===================== + +The pages provide the software and model versions that Merlin supports for each container. + +.. toctree:: + :maxdepth: 2 + + support_matrix_merlin_training + support_matrix_merlin_tensorflow_training + support_matrix_merlin_pytorch_training + support_matrix_merlin_inference + support_matrix_merlin_tensorflow_inference + support_matrix_merlin_pytorch_inference diff --git a/docs/source/support_matrix/support_matrix_merlin_inference.rst b/docs/source/support_matrix/support_matrix_merlin_inference.rst new file mode 100644 index 000000000..00ccd546f --- /dev/null +++ b/docs/source/support_matrix/support_matrix_merlin_inference.rst @@ -0,0 +1,8 @@ +Merlin Inference Support Matrix +=============================== + +This container enables you to deploy NVTabular workflows and HugeCTR or TensorFlow +models to the Triton Inference Server for production. + +.. include:: ../generated/nvcr.io-nvidia-merlin-merlin-inference.rst + diff --git a/docs/source/support_matrix/support_matrix_merlin_pytorch_inference.rst b/docs/source/support_matrix/support_matrix_merlin_pytorch_inference.rst new file mode 100644 index 000000000..eac4ad3f9 --- /dev/null +++ b/docs/source/support_matrix/support_matrix_merlin_pytorch_inference.rst @@ -0,0 +1,7 @@ +Merlin PyTorch Inference Support Matrix +======================================= + +This container enables you to deploy NVTabular workflows and PyTorch +models to the Triton Inference Server for production. + +.. include:: ../generated/nvcr.io-nvidia-merlin-merlin-pytorch-inference.rst diff --git a/docs/source/support_matrix/support_matrix_merlin_pytorch_training.rst b/docs/source/support_matrix/support_matrix_merlin_pytorch_training.rst new file mode 100644 index 000000000..7877efbea --- /dev/null +++ b/docs/source/support_matrix/support_matrix_merlin_pytorch_training.rst @@ -0,0 +1,8 @@ +Merlin PyTorch Training Support Training +======================================== + +This container enables you to perform preprocessing and feature engineering with +NVTabular so that you can train a deep learning recommendation model with PyTorch. + +.. include:: ../generated/nvcr.io-nvidia-merlin-merlin-pytorch-training.rst + diff --git a/docs/source/support_matrix/support_matrix_merlin_tensorflow_inference.rst b/docs/source/support_matrix/support_matrix_merlin_tensorflow_inference.rst new file mode 100644 index 000000000..0339cbc1b --- /dev/null +++ b/docs/source/support_matrix/support_matrix_merlin_tensorflow_inference.rst @@ -0,0 +1,8 @@ +Merlin TensorFlow Inference Support Matrix +========================================== + +This container enables you to deploy NVTabular workflows and TensorFlow +models to the Triton Inference Server for production. + +.. include:: ../generated/nvcr.io-nvidia-merlin-merlin-tensorflow-inference.rst + diff --git a/docs/source/support_matrix/support_matrix_merlin_tensorflow_training.rst b/docs/source/support_matrix/support_matrix_merlin_tensorflow_training.rst new file mode 100644 index 000000000..8a94ed2da --- /dev/null +++ b/docs/source/support_matrix/support_matrix_merlin_tensorflow_training.rst @@ -0,0 +1,8 @@ +Merlin TensorFlow Training Support Matrix +========================================= + +This container enables you to perform preprocessing and feature engineering with +NVTabular so that you can train a deep learning recommendation model with TensorFlow. + +.. include:: ../generated/nvcr.io-nvidia-merlin-merlin-tensorflow-training.rst + diff --git a/docs/source/support_matrix/support_matrix_merlin_training.rst b/docs/source/support_matrix/support_matrix_merlin_training.rst new file mode 100644 index 000000000..da3e1527c --- /dev/null +++ b/docs/source/support_matrix/support_matrix_merlin_training.rst @@ -0,0 +1,8 @@ +Merlin Training Support Matrix +============================== + +This container enables you to perform preprocessing and feature engineering with +NVTabular so that you can train a deep learning recommendation model with HugeCTR. + +.. include:: ../generated/nvcr.io-nvidia-merlin-merlin-training.rst +