diff --git a/README.md b/README.md index 519d41e26..55f9f802e 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,16 @@ Kaolin library is part of a larger suite of tools for 3D deep learning research. ## Installation and Getting Started +Starting with v0.12.0, Kaolin supports installation with wheels: +``` +# Replace TORCH_VERSION and CUDA_VERSION with your torch / cuda versions +pip install kaolin==0.12.0 -f https://nvidia-kaolin.s3.us-east-2.amazonaws.com/torch-{TORCH_VERSION}_cu{CUDA_VERSION}.html +``` +For example, to install kaolin over torch 1.12.1 and cuda 11.3: +``` +pip install kaolin==0.12.0 -f https://nvidia-kaolin.s3.us-east-2.amazonaws.com/torch-1.12.1_cu113.html +``` + Visit the [Kaolin Library Documentation](https://kaolin.readthedocs.io/en/latest/) to get started! ## About the Latest Release (0.12.0) diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index dff1c3e6f..a5e14426f 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -31,6 +31,10 @@ color: white; } + table.center-align-center-col td { + text-align: center +} + {% endblock %} diff --git a/docs/notes/installation.rst b/docs/notes/installation.rst index 02e74403d..abc7a3915 100644 --- a/docs/notes/installation.rst +++ b/docs/notes/installation.rst @@ -12,18 +12,52 @@ Kaolin on other systems, only a fraction of operations will be available for a C Requirements ------------ -* Linux, macOS (CPU-only) or Windows +* Linux, Windows, or macOS (CPU-only) * Python >= 3.7, <= 3.9 * `CUDA `_ >= 10.0 (with 'nvcc' installed) See `CUDA Toolkit Archive `_ to install older version. +* torch >= 1.8, <= 1.13.1 -Dependencies ------------- +Quick Start (Linux, Windows) +---------------------------- +| Make sure any of the supported CUDA and torch versions below are pre-installed. +| The latest version of Kaolin can be installed with pip: + +.. code-block:: bash + + $ pip install kaolin==0.12.0 -f https://nvidia-kaolin.s3.us-east-2.amazonaws.com/{TORCH_VER}_{CUDA_VER}.html + +.. Note:: + Replace *TORCH_VER* and *CUDA_VER* with any of the compatible options below. + + +.. rst-class:: center-align-center-col + + +------------------+-----------+-----------+-----------+-----------+-----------+ + | **torch / CUDA** | **cu102** | **cu111** | **cu113** | **cu116** | **cu117** | + +==================+===========+===========+===========+===========+===========+ + | **torch-1.13.1** | | | | ✓ | ✓ | + +------------------+-----------+-----------+-----------+-----------+-----------+ + | **torch-1.13.0** | | | | ✓ | ✓ | + +------------------+-----------+-----------+-----------+-----------+-----------+ + | **torch-1.12.1** | ✓ | | ✓ | ✓ | | + +------------------+-----------+-----------+-----------+-----------+-----------+ + | **torch-1.12.0** | ✓ | | ✓ | ✓ | | + +------------------+-----------+-----------+-----------+-----------+-----------+ + | **torch-1.11.0** | ✓ | | ✓ | | | + +------------------+-----------+-----------+-----------+-----------+-----------+ + | **torch-1.10.2** | ✓ | ✓ | ✓ | | | + +------------------+-----------+-----------+-----------+-----------+-----------+ + | **torch-1.10.1** | ✓ | ✓ | ✓ | | | + +------------------+-----------+-----------+-----------+-----------+-----------+ + | **torch-1.10.0** | ✓ | ✓ | ✓ | | | + +------------------+-----------+-----------+-----------+-----------+-----------+ + +For example, to install kaolin for torch 1.12.1 and CUDA 11.3: + +.. code-block:: bash + + $ pip install kaolin==0.12.0 -f https://nvidia-kaolin.s3.us-east-2.amazonaws.com/torch-1.12.1_cu113.html -* torch >= 1.8, <= 1.12.1 -* cython == 0.29.20 (auto-installed) -* scipy >= 1.2.0 (auto-installed) -* Pillow >= 8.0.0 (auto-installed) -* usd-core >= 20.11 (auto-installed; required for USD I/O and 3D checkpoints with :class:`~kaolin.visualize.Timelapse`) Installation from source ------------------------ @@ -36,6 +70,15 @@ Installation from source $ conda create --name kaolin python=3.7 $ conda activate kaolin +Dependencies +^^^^^^^^^^^^ + +* torch >= 1.8, <= 1.13.1 +* cython == 0.29.20 (auto-installed) +* scipy >= 1.2.0 (auto-installed) +* Pillow >= 8.0.0 (auto-installed) +* usd-core >= 20.11 (auto-installed; required for USD I/O and 3D checkpoints with :class:`~kaolin.visualize.Timelapse`) + 1. Clone Repository ^^^^^^^^^^^^^^^^^^^