Skip to content

Commit

Permalink
update wheels installation instructions for 0.14.0 (#748)
Browse files Browse the repository at this point in the history
sync doc welcome page with readme

Signed-off-by: Clement Fuji Tsang <cfujitsang@nvidia.com>
  • Loading branch information
Caenorst committed Jul 26, 2023
1 parent adcec54 commit 89dfbc9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 17 deletions.
4 changes: 2 additions & 2 deletions docs/index.rst
Expand Up @@ -3,10 +3,10 @@ Welcome to Kaolin Library Documentation

.. image:: ../assets/kaolin.png

NVIDIA Kaolin library provides a PyTorch API for working with a variety of 3D representations and includes a growing collection of GPU-optimized operations such as modular differentiable rendering, fast conversions between representations, data loading, 3D checkpoints and more.
`NVIDIA Kaolin library <https://github.com/NVIDIAGameWorks/kaolin>`_ provides a PyTorch API for working with a variety of 3D representations and includes a growing collection of GPU-optimized operations such as modular differentiable rendering, fast conversions between representations, data loading, 3D checkpoints, differentiable camera API, differentiable lighting with spherical harmonics and spherical gaussians, powerful quadtree acceleration structure called Structured Point Clouds, interactive 3D visualizer for jupyter notebooks, convenient batched mesh container and more.
See :ref:`Installation <installation>`, :ref:`API Overview <overview>` and :ref:`Tutorials <tutorial_index>` to get started!

Kaolin library is part of a larger suite of tools for 3D deep learning research. For example, `Omniverse Kaolin app <https://docs.omniverse.nvidia.com/app_kaolin/app_kaolin/overview.html>`_ allows interactive visualization of 3D checkpoints. To find out more about the Kaolin ecosystem, visit the `NVIDIA Kaolin Dev Zone page <https://developer.nvidia.com/kaolin>`_.
Note that Kaolin library is part of the larger `NVIDIA Kaolin effort <https://developer.nvidia.com/kaolin>`_ for 3D deep learning.


.. toctree::
Expand Down
28 changes: 13 additions & 15 deletions docs/notes/installation.rst
Expand Up @@ -13,9 +13,9 @@ Requirements
------------

* Linux, Windows, or macOS (CPU-only)
* Python >= 3.7, <= 3.9
* Python >= 3.7, <= 3.10
* `CUDA <https://developer.nvidia.com/cuda-toolkit>`_ >= 10.0 (with 'nvcc' installed) See `CUDA Toolkit Archive <https://developer.nvidia.com/cuda-toolkit-archive>`_ to install older version.
* torch >= 1.8, <= 2.0.0
* torch >= 1.8, <= 2.0.1

Quick Start (Linux, Windows)
----------------------------
Expand All @@ -24,7 +24,7 @@ Quick Start (Linux, Windows)
.. code-block:: bash
$ pip install kaolin==0.13.0 -f https://nvidia-kaolin.s3.us-east-2.amazonaws.com/torch-{TORCH_VER}_cu{CUDA_VER}.html
$ pip install kaolin==0.14.0 -f https://nvidia-kaolin.s3.us-east-2.amazonaws.com/torch-{TORCH_VER}_cu{CUDA_VER}.html
.. Note::
Replace *TORCH_VER* and *CUDA_VER* with any of the compatible options below.
Expand All @@ -33,23 +33,21 @@ Quick Start (Linux, Windows)
.. rst-class:: center-align-center-col

+------------------+-----------+-----------+-----------+-----------+-----------+
| **torch / CUDA** | **cu102** | **cu111** | **cu113** | **cu116** | **cu117** |
| **torch / CUDA** | **cu113** | **cu115** | **cu116** | **cu117** | **cu118** |
+==================+===========+===========+===========+===========+===========+
| **torch-1.13.1** | | | |||
| **torch-2.0.0** | | | |||
+------------------+-----------+-----------+-----------+-----------+-----------+
| **torch-1.13.0** | | | |||
| **torch-2.0.1** | | | |||
+------------------+-----------+-----------+-----------+-----------+-----------+
| **torch-1.12.1** | | ||| |
| **torch-1.13.1** | | ||| |
+------------------+-----------+-----------+-----------+-----------+-----------+
| **torch-1.12.0** | | ||| |
| **torch-1.13.0** | | ||| |
+------------------+-----------+-----------+-----------+-----------+-----------+
| **torch-1.11.0** || || | |
| **torch-1.12.1** || || | |
+------------------+-----------+-----------+-----------+-----------+-----------+
| **torch-1.10.2** || || | |
| **torch-1.12.0** || || | |
+------------------+-----------+-----------+-----------+-----------+-----------+
| **torch-1.10.1** |||| | |
+------------------+-----------+-----------+-----------+-----------+-----------+
| **torch-1.10.0** |||| | |
| **torch-1.11.0** ||| | | |
+------------------+-----------+-----------+-----------+-----------+-----------+

For example, to install kaolin for torch 1.12.1 and CUDA 11.3:
Expand Down Expand Up @@ -108,11 +106,11 @@ Follow `official instructions <https://pytorch.org>`_ to install PyTorch of a su
Kaolin may be able to work with other PyTorch versions, but we only explicitly test within the version range 1.10.0 to 2.0.0.
See below for overriding PyTorch version check during install.

Here is how to install the latest Pytorch version supported by Kaolin for cuda 11.3:
Here is how to install the latest Pytorch version supported by Kaolin for cuda 11.8:

.. code-block:: bash
$ pip install torch==1.12.1 torchvision==0.13.1 torchaudio==0.12.1 --extra-index-url https://download.pytorch.org/whl/cu113
$ pip install torch==2.0.1 --extra-index-url https://download.pytorch.org/whl/cu118
4. Optional Environment Variables
Expand Down

0 comments on commit 89dfbc9

Please sign in to comment.