fbcode/vision/fair/pytorch3d/pytorch3d/transforms/se3.py

Reviewed By: sgrigory

Differential Revision: D93709801

fbshipit-source-id: e4bae81fe1a88fed547304e6e21b248c5a345277

.circleci/build_count.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# Copyright (c) Facebook, Inc. and its affiliates.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
 # All rights reserved.
 #
 # This source code is licensed under the BSD-style license found in the

.circleci/check.sh

@@ -1,5 +1,5 @@
 #!/bin/bash -e
-# Copyright (c) Facebook, Inc. and its affiliates.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
 # All rights reserved.
 #
 # This source code is licensed under the BSD-style license found in the

.circleci/config.in.yml

@@ -18,20 +18,13 @@ setupcuda: &setupcuda
     working_directory: ~/
     command: |
       # download and install nvidia drivers, cuda, etc
-      wget --no-verbose --no-clobber -P ~/nvidia-downloads https://developer.download.nvidia.com/compute/cuda/11.2.2/local_installers/cuda_11.2.2_460.32.03_linux.run
-      sudo sh ~/nvidia-downloads/cuda_11.2.2_460.32.03_linux.run --silent
+      wget --no-verbose --no-clobber -P ~/nvidia-downloads https://developer.download.nvidia.com/compute/cuda/11.3.1/local_installers/cuda_11.3.1_465.19.01_linux.run
+      sudo sh ~/nvidia-downloads/cuda_11.3.1_465.19.01_linux.run --silent
       echo "Done installing CUDA."
       pyenv versions
       nvidia-smi
       pyenv global 3.9.1
 
-gpu: &gpu
-  environment:
-    CUDA_VERSION: "10.2"
-  machine:
-    image: default
-  resource_class: gpu.medium # tesla m60
-
 binary_common: &binary_common
   parameters:
     # Edit these defaults to do a release`
@@ -54,42 +47,41 @@ binary_common: &binary_common
       description: "Wheel only: what docker image to use"
       type: string
       default: "pytorch/manylinux-cuda101"
+    conda_docker_image:
+      description: "what docker image to use for docker"
+      type: string
+      default: "pytorch/conda-cuda"
   environment:
     PYTHON_VERSION: << parameters.python_version >>
     BUILD_VERSION: << parameters.build_version >>
     PYTORCH_VERSION: << parameters.pytorch_version >>
     CU_VERSION: << parameters.cu_version >>
+    TESTRUN_DOCKER_IMAGE: << parameters.conda_docker_image >>
 
 jobs:
   main:
-    <<: *gpu
+    environment:
+      CUDA_VERSION: "11.3"
+    resource_class: gpu.nvidia.small.multi
     machine:
-      image: ubuntu-2004:202101-01
+      image: linux-cuda-11:default
     steps:
       - checkout
       - <<: *setupcuda
       - run: pip3 install --progress-bar off imageio wheel matplotlib 'pillow<7'
-      - run: pip3 install --progress-bar off torch torchvision
+      - run: pip3 install --progress-bar off torch==1.10.0+cu113 torchvision==0.11.1+cu113 -f https://download.pytorch.org/whl/cu113/torch_stable.html
       # - run: conda create -p ~/conda_env python=3.7 numpy
       # - run: conda activate ~/conda_env
       # - run: conda install -c pytorch pytorch torchvision
 
       - run: pip3 install --progress-bar off 'git+https://github.com/facebookresearch/fvcore'
       - run: pip3 install --progress-bar off 'git+https://github.com/facebookresearch/iopath'
-      - run:
-          name: get cub
-          command: |
-            cd ..
-            wget --no-verbose https://github.com/NVIDIA/cub/archive/1.10.0.tar.gz
-            tar xzf 1.10.0.tar.gz
-            # This expands to a directory called cub-1.10.0
       - run:
           name: build
           command: |
-            export LD_LIBRARY_PATH=$LD_LIBARY_PATH:/usr/local/cuda-11.2/lib64
-            export CUB_HOME=$(realpath ../cub-1.10.0)
+            export LD_LIBRARY_PATH=$LD_LIBARY_PATH:/usr/local/cuda-11.3/lib64
             python3 setup.py build_ext --inplace
-      - run: LD_LIBRARY_PATH=$LD_LIBARY_PATH:/usr/local/cuda-11.2/lib64 python -m unittest discover -v -s tests
+      - run: LD_LIBRARY_PATH=$LD_LIBARY_PATH:/usr/local/cuda-11.3/lib64 python -m unittest discover -v -s tests -t .
       - run: python3 setup.py bdist_wheel
 
   binary_linux_wheel:
@@ -113,7 +105,7 @@ jobs:
   binary_linux_conda:
     <<: *binary_common
     docker:
-      - image: "pytorch/conda-cuda"
+      - image: "<< parameters.conda_docker_image >>"
         auth:
           username: $DOCKERHUB_USERNAME
           password: $DOCKERHUB_TOKEN
@@ -124,8 +116,8 @@ jobs:
       # so we aren't running the tests.
       - run:
           name: build
-          no_output_timeout: 20m
-          command: MAX_JOBS=15 TEST_FLAG=--no-test packaging/build_conda.sh
+          no_output_timeout: 40m
+          command: MAX_JOBS=15 TEST_FLAG=--no-test python3 packaging/build_conda.py
       - store_artifacts:
           path: /opt/conda/conda-bld/linux-64
       - persist_to_workspace:
@@ -136,142 +128,44 @@ jobs:
   binary_linux_conda_cuda:
     <<: *binary_common
     machine:
-      image: ubuntu-1604:201903-01
-    resource_class: gpu.medium
+      image: linux-cuda-11:default
+    resource_class: gpu.nvidia.small.multi
     steps:
     - checkout
-    - run:
-        name: Setup environment
-        command: |
-          set -e
-
-          curl -L https://packagecloud.io/circleci/trusty/gpgkey | sudo apt-key add -
-          curl -L https://dl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
-
-          sudo apt-get update
-
-          sudo apt-get install \
-              apt-transport-https \
-              ca-certificates \
-              curl \
-              gnupg-agent \
-              software-properties-common
-
-          curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
-
-          sudo add-apt-repository \
-             "deb [arch=amd64] https://download.docker.com/linux/ubuntu \
-             $(lsb_release -cs) \
-             stable"
-
-          sudo apt-get update
-          export DOCKER_VERSION="5:19.03.2~3-0~ubuntu-xenial"
-          sudo apt-get install docker-ce=${DOCKER_VERSION} docker-ce-cli=${DOCKER_VERSION} containerd.io=1.2.6-3
-
-          # Add the package repositories
-          distribution=$(. /etc/os-release;echo $ID$VERSION_ID)
-          curl -s -L https://nvidia.github.io/nvidia-docker/gpgkey | sudo apt-key add -
-          curl -s -L https://nvidia.github.io/nvidia-docker/$distribution/nvidia-docker.list | sudo tee /etc/apt/sources.list.d/nvidia-docker.list
-
-          export NVIDIA_CONTAINER_VERSION="1.0.3-1"
-          sudo apt-get update && sudo apt-get install -y nvidia-container-toolkit=${NVIDIA_CONTAINER_VERSION}
-          sudo systemctl restart docker
-
-          DRIVER_FN="NVIDIA-Linux-x86_64-460.84.run"
-          wget "https://us.download.nvidia.com/XFree86/Linux-x86_64/460.84/$DRIVER_FN"
-          sudo /bin/bash "$DRIVER_FN" -s --no-drm || (sudo cat /var/log/nvidia-installer.log && false)
-          nvidia-smi
 
     - run:
         name: Pull docker image
         command: |
+          nvidia-smi
           set -e
 
           { docker login -u="$DOCKERHUB_USERNAME" -p="$DOCKERHUB_TOKEN" ; } 2> /dev/null
 
-          DOCKER_IMAGE=pytorch/conda-cuda
-          echo Pulling docker image $DOCKER_IMAGE
-          docker pull $DOCKER_IMAGE
+          echo Pulling docker image $TESTRUN_DOCKER_IMAGE
+          docker pull $TESTRUN_DOCKER_IMAGE
     - run:
         name: Build and run tests
-        no_output_timeout: 20m
+        no_output_timeout: 40m
         command: |
           set -e
 
           cd ${HOME}/project/
 
-          DOCKER_IMAGE=pytorch/conda-cuda
           export JUST_TESTRUN=1
           VARS_TO_PASS="-e PYTHON_VERSION -e BUILD_VERSION -e PYTORCH_VERSION -e CU_VERSION -e JUST_TESTRUN"
 
-          docker run --gpus all  --ipc=host -v $(pwd):/remote -w /remote ${VARS_TO_PASS} ${DOCKER_IMAGE} ./packaging/build_conda.sh
-
-  binary_macos_wheel:
-    <<: *binary_common
-    macos:
-      xcode: "12.0"
-    steps:
-      - checkout
-      - run:
-          # Cannot easily deduplicate this as source'ing activate
-          # will set environment variables which we need to propagate
-          # to build_wheel.sh
-          command: |
-            curl -o conda.sh https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh
-            sh conda.sh -b
-            source $HOME/miniconda3/bin/activate
-            packaging/build_wheel.sh
-      - store_artifacts:
-          path: dist
+          docker run --gpus all  --ipc=host -v $(pwd):/remote -w /remote ${VARS_TO_PASS} ${TESTRUN_DOCKER_IMAGE} python3 ./packaging/build_conda.py
 
 workflows:
   version: 2
   build_and_test:
     jobs:
-      - main:
-          context: DOCKERHUB_TOKEN
+      # - main:
+      #     context: DOCKERHUB_TOKEN
       {{workflows()}}
       - binary_linux_conda_cuda:
-          name: testrun_conda_cuda_py36_cu101_pyt14
+          name: testrun_conda_cuda_py310_cu117_pyt201
           context: DOCKERHUB_TOKEN
-          python_version: "3.6"
-          pytorch_version: "1.4"
-          cu_version: "cu101"
-      - binary_linux_conda_cuda:
-          name: testrun_conda_cuda_py37_cu102_pyt190
-          context: DOCKERHUB_TOKEN
-          python_version: "3.7"
-          pytorch_version: '1.9.0'
-          cu_version: "cu102"
-      - binary_linux_conda_cuda:
-          name: testrun_conda_cuda_py37_cu110_pyt170
-          context: DOCKERHUB_TOKEN
-          python_version: "3.7"
-          pytorch_version: '1.7.0'
-          cu_version: "cu110"
-      - binary_linux_conda_cuda:
-          name: testrun_conda_cuda_py39_cu111_pyt181
-          context: DOCKERHUB_TOKEN
-          python_version: "3.9"
-          pytorch_version: '1.8.1'
-          cu_version: "cu111"
-      - binary_macos_wheel:
-          cu_version: cpu
-          name: macos_wheel_py36_cpu
-          python_version: '3.6'
-          pytorch_version: '1.9.0'
-      - binary_macos_wheel:
-          cu_version: cpu
-          name: macos_wheel_py37_cpu
-          python_version: '3.7'
-          pytorch_version: '1.9.0'
-      - binary_macos_wheel:
-          cu_version: cpu
-          name: macos_wheel_py38_cpu
-          python_version: '3.8'
-          pytorch_version: '1.9.0'
-      - binary_macos_wheel:
-          cu_version: cpu
-          name: macos_wheel_py39_cpu
-          python_version: '3.9'
-          pytorch_version: '1.9.0'
+          python_version: "3.10"
+          pytorch_version: '2.0.1'
+          cu_version: "cu117"

.circleci/regenerate.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# Copyright (c) Facebook, Inc. and its affiliates.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
 # All rights reserved.
 #
 # This source code is licensed under the BSD-style license found in the
@@ -13,35 +13,56 @@ import os.path
 
 import jinja2
 import yaml
+from packaging import version
 
 
 # The CUDA versions which have pytorch conda packages available for linux for each
 # version of pytorch.
-# Pytorch 1.4 also supports cuda 10.0 but we no longer build for cuda 10.0 at all.
 CONDA_CUDA_VERSIONS = {
-    "1.4": ["cu92", "cu101"],
-    "1.5.0": ["cu92", "cu101", "cu102"],
-    "1.5.1": ["cu92", "cu101", "cu102"],
-    "1.6.0": ["cu92", "cu101", "cu102"],
-    "1.7.0": ["cu101", "cu102", "cu110"],
-    "1.7.1": ["cu101", "cu102", "cu110"],
-    "1.8.0": ["cu101", "cu102", "cu111"],
-    "1.8.1": ["cu101", "cu102", "cu111"],
-    "1.9.0": ["cu102", "cu111"],
+    "2.1.0": ["cu118", "cu121"],
+    "2.1.1": ["cu118", "cu121"],
+    "2.1.2": ["cu118", "cu121"],
+    "2.2.0": ["cu118", "cu121"],
+    "2.2.2": ["cu118", "cu121"],
+    "2.3.1": ["cu118", "cu121"],
+    "2.4.0": ["cu118", "cu121"],
+    "2.4.1": ["cu118", "cu121"],
 }
 
 
+def conda_docker_image_for_cuda(cuda_version):
+    if len(cuda_version) != 5:
+        raise ValueError("Unknown cuda version")
+    return "pytorch/conda-builder:cuda" + cuda_version[2:]
+
+
 def pytorch_versions_for_python(python_version):
-    if python_version in ["3.6", "3.7", "3.8"]:
+    if python_version in ["3.8", "3.9"]:
         return list(CONDA_CUDA_VERSIONS)
-    pytorch_without_py39 = ["1.4", "1.5.0", "1.5.1", "1.6.0", "1.7.0"]
-    return [i for i in CONDA_CUDA_VERSIONS if i not in pytorch_without_py39]
+    if python_version == "3.10":
+        return [
+            i
+            for i in CONDA_CUDA_VERSIONS
+            if version.Version(i) >= version.Version("1.11.0")
+        ]
+    if python_version == "3.11":
+        return [
+            i
+            for i in CONDA_CUDA_VERSIONS
+            if version.Version(i) >= version.Version("2.1.0")
+        ]
+    if python_version == "3.12":
+        return [
+            i
+            for i in CONDA_CUDA_VERSIONS
+            if version.Version(i) >= version.Version("2.2.0")
+        ]
 
 
 def workflows(prefix="", filter_branch=None, upload=False, indentation=6):
     w = []
     for btype in ["conda"]:
-        for python_version in ["3.6", "3.7", "3.8", "3.9"]:
+        for python_version in ["3.8", "3.9", "3.10", "3.11", "3.12"]:
             for pytorch_version in pytorch_versions_for_python(python_version):
                 for cu_version in CONDA_CUDA_VERSIONS[pytorch_version]:
                     w += workflow_pair(
@@ -67,7 +88,6 @@ def workflow_pair(
     upload=False,
     filter_branch,
 ):
-
     w = []
     py = python_version.replace(".", "")
     pyt = pytorch_version.replace(".", "")
@@ -106,7 +126,6 @@ def generate_base_workflow(
     btype,
     filter_branch=None,
 ):
-
     d = {
         "name": base_workflow_name,
         "python_version": python_version,
@@ -115,6 +134,10 @@ def generate_base_workflow(
         "context": "DOCKERHUB_TOKEN",
     }
 
+    conda_docker_image = conda_docker_image_for_cuda(cu_version)
+    if conda_docker_image is not None:
+        d["conda_docker_image"] = conda_docker_image
+
     if filter_branch is not None:
         d["filters"] = {"branches": {"only": filter_branch}}
 

.flake8

@@ -1,5 +1,8 @@
 [flake8]
-ignore = E203, E266, E501, W503, E221
+# B028 No explicit stacklevel argument found.
+# B907 'foo' is manually surrounded by quotes, consider using the `!r` conversion flag.
+# B905 `zip()` without an explicit `strict=` parameter.
+ignore = E203, E266, E501, W503, E221, B028, B905, B907
 max-line-length = 88
 max-complexity = 18
 select = B,C,E,F,W,T4,B9

.github/CONTRIBUTING.md

@@ -16,14 +16,13 @@ We do not always accept new features, and we take the following factors into con
 
 When sending a PR, please ensure you complete the following steps:
 
-1. Fork the repo and create your branch from `master`. Follow the instructions
+1. Fork the repo and create your branch from `main`. Follow the instructions
    in [INSTALL.md](../INSTALL.md) to build the repo.
 2. If you've added code that should be tested, add tests.
 3. If you've changed any APIs, please update the documentation.
-4. Ensure the test suite passes:
+4. Ensure the test suite passes, by running this from the project root:
     ```
-    cd pytorch3d/tests
-    python -m unittest -v
+    python -m unittest discover -v -s tests -t .
     ```
 5. Make sure your code lints by running `dev/linter.sh` from  the project root.
 6. If a PR contains multiple orthogonal changes, split it into multiple separate PRs.
@@ -46,7 +45,7 @@ outlined on that page and do not file a public issue.
 ## Coding Style
 We follow these [python](http://google.github.io/styleguide/pyguide.html) and [C++](https://google.github.io/styleguide/cppguide.html) style guides.
 
-For the linter to work, you will need to install `black`, `flake`, `isort` and `clang-format`, and
+For the linter to work, you will need to install `black`, `flake`, `usort` and `clang-format`, and
 they need to be fairly up to date.
 
 ## License

.github/workflows/build.yml

@@ -0,0 +1,23 @@
+name: facebookresearch/pytorch3d/build_and_test
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+jobs:
+  binary_linux_conda_cuda:
+    runs-on: 4-core-ubuntu-gpu-t4
+    env:
+      PYTHON_VERSION: "3.12"
+      BUILD_VERSION: "${{ github.run_number }}"
+      PYTORCH_VERSION: "2.4.1"
+      CU_VERSION: "cu121"
+      JUST_TESTRUN: 1
+    steps:
+    - uses: actions/checkout@v4
+    - name: Build and run tests
+      run: |-
+        conda create --name env --yes --quiet conda-build
+        conda run --no-capture-output --name env python3 ./packaging/build_conda.py --use-conda-cuda

.github/workflows/stale.yml

@@ -1,27 +0,0 @@
-name: Mark stale issues and pull requests
-
-on:
-  schedule:
-  - cron: '31 5 * * *'
-
-jobs:
-  stale:
-
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-      pull-requests: write
-
-    steps:
-    - uses: actions/stale@v3
-      with:
-        repo-token: ${{ secrets.GITHUB_TOKEN }}
-        exempt-issue-labels: 'enhancement,how-to'
-        stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
-        stale-pr-message: 'This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.'
-        close-issue-message: 'This issue was closed because it has been stalled for 5 days with no activity.'
-        close-pr-message: 'This PR was closed because it has been stalled for 10 days with no activity.'
-        days-before-issue-stale: 30
-        days-before-pr-stale: 45
-        days-before-issue-close: 5
-        days-before-pr-close: 10

INSTALL.md

@@ -8,24 +8,23 @@
 The core library is written in PyTorch. Several components have underlying implementation in CUDA for improved performance. A subset of these components have CPU implementations in C++/PyTorch. It is advised to use PyTorch3D with GPU support in order to use all the features.
 
 - Linux or macOS or Windows
-- Python 3.6, 3.7, 3.8 or 3.9
-- PyTorch 1.4, 1.5.0, 1.5.1, 1.6.0, 1.7.0, 1.7.1, 1.8.0, 1.8.1 or 1.9.0.
+- Python
+- PyTorch 2.1.0, 2.1.1, 2.1.2, 2.2.0, 2.2.1, 2.2.2, 2.3.0, 2.3.1, 2.4.0 or 2.4.1.
 - torchvision that matches the PyTorch installation. You can install them together as explained at pytorch.org to make sure of this.
 - gcc & g++ ≥ 4.9
-- [fvcore](https://github.com/facebookresearch/fvcore)
 - [ioPath](https://github.com/facebookresearch/iopath)
 - If CUDA is to be used, use a version which is supported by the corresponding pytorch version and at least version 9.2.
-- If CUDA is to be used and you are building from source, the CUB library must be available. We recommend version 1.10.0.
+- If CUDA older than 11.7 is to be used and you are building from source, the CUB library must be available. We recommend version 1.10.0.
 
 The runtime dependencies can be installed by running:
 ```
-conda create -n pytorch3d python=3.8
+conda create -n pytorch3d python=3.9
 conda activate pytorch3d
-conda install -c pytorch pytorch=1.7.1 torchvision cudatoolkit=10.2
-conda install -c fvcore -c iopath -c conda-forge fvcore iopath
+conda install pytorch=1.13.0 torchvision pytorch-cuda=11.6 -c pytorch -c nvidia
+conda install -c iopath iopath
 ```
 
-For the CUB build time dependency, if you are using conda, you can continue with
+For the CUB build time dependency, which you only need if you have CUDA older than 11.7, if you are using conda, you can continue with
 ```
 conda install -c bottler nvidiacub
 ```
@@ -43,12 +42,13 @@ export CUB_HOME=$PWD/cub-1.10.0
 For developing on top of PyTorch3D or contributing, you will need to run the linter and tests. If you want to run any of the notebook tutorials as `docs/tutorials` or the examples in `docs/examples` you will also need matplotlib and OpenCV.
 - scikit-image
 - black
-- isort
+- usort
 - flake8
 - matplotlib
 - tdqm
 - jupyter
 - imageio
+- fvcore
 - plotly
 - opencv-python
 
@@ -59,7 +59,8 @@ conda install jupyter
 pip install scikit-image matplotlib imageio plotly opencv-python
 
 # Tests/Linting
-pip install black 'isort<5' flake8 flake8-bugbear flake8-comprehensions
+conda install -c fvcore -c conda-forge fvcore
+pip install black usort flake8 flake8-bugbear flake8-comprehensions
 ```
 
 ## Installing prebuilt binaries for PyTorch3D
@@ -77,31 +78,28 @@ Or, to install a nightly (non-official, alpha) build:
 # Anaconda Cloud
 conda install pytorch3d -c pytorch3d-nightly
 ```
-### 2. Install from PyPI, on Mac only.
-This works with pytorch 1.9.0 only. The build is CPU only.
-```
-pip install pytorch3d
-```
 
-### 3. Install wheels for Linux
-We have prebuilt wheels with CUDA for Linux for PyTorch 1.9.0, for each of the CUDA versions that they support,
-for Python 3.7, 3.8 and 3.9.
+### 2. Install wheels for Linux
+We have prebuilt wheels with CUDA for Linux for PyTorch 1.11.0, for each of the supported CUDA versions,
+for Python 3.8 and 3.9. This is for ease of use on Google Colab.
 These are installed in a special way.
-For example, to install for Python 3.8, PyTorch 1.9.0 and CUDA 10.2
+For example, to install for Python 3.8, PyTorch 1.11.0 and CUDA 11.3
 ```
-pip install pytorch3d -f https://dl.fbaipublicfiles.com/pytorch3d/packaging/wheels/py38_cu102_pyt190/download.html
+pip install --no-index --no-cache-dir pytorch3d -f https://dl.fbaipublicfiles.com/pytorch3d/packaging/wheels/py38_cu113_pyt1110/download.html
 ```
 
 In general, from inside IPython, or in Google Colab or a jupyter notebook, you can install with
 ```
 import sys
 import torch
+pyt_version_str=torch.__version__.split("+")[0].replace(".", "")
 version_str="".join([
     f"py3{sys.version_info.minor}_cu",
     torch.version.cuda.replace(".",""),
-    f"_pyt{torch.__version__[0:5:2]}"
+    f"_pyt{pyt_version_str}"
 ])
-!pip install pytorch3d -f https://dl.fbaipublicfiles.com/pytorch3d/packaging/wheels/{version_str}/download.html
+!pip install iopath
+!pip install --no-index --no-cache-dir pytorch3d -f https://dl.fbaipublicfiles.com/pytorch3d/packaging/wheels/{version_str}/download.html
 ```
 
 ## Building / installing from source.
@@ -146,10 +144,10 @@ After any necessary patching, you can go to "x64 Native Tools Command Prompt for
 cd pytorch3d
 python3 setup.py install
 ```
-After installing, verify whether all unit tests have passed
+
+After installing, you can run **unit tests**
 ```
-cd tests
-python3 -m unittest discover -p *.py
+python3 -m unittest discover -v -s tests -t .
 ```
 
 # FAQ

LICENSE

@@ -2,7 +2,7 @@ BSD License
 
 For PyTorch3D software
 
-Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.
+Copyright (c) Meta Platforms, Inc. and affiliates. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:
@@ -14,7 +14,7 @@ are permitted provided that the following conditions are met:
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.
 
- * Neither the name Facebook nor the names of its contributors may be used to
+ * Neither the name Meta nor the names of its contributors may be used to
    endorse or promote products derived from this software without specific
    prior written permission.
 

LICENSE-3RD-PARTY

@@ -0,0 +1,71 @@
+SRN license ( https://github.com/vsitzmann/scene-representation-networks/ ):
+
+MIT License
+
+Copyright (c) 2019 Vincent Sitzmann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+IDR license ( github.com/lioryariv/idr ):
+
+MIT License
+
+Copyright (c) 2020 Lior Yariv
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
+NeRF https://github.com/bmild/nerf/
+
+Copyright (c) 2020 bmild
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,4 @@
-<img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/master/.github/pytorch3dlogo.png" width="900"/>
+<img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/main/.github/pytorch3dlogo.png" width="900"/>
 
 [![CircleCI](https://circleci.com/gh/facebookresearch/pytorch3d.svg?style=svg)](https://circleci.com/gh/facebookresearch/pytorch3d)
 [![Anaconda-Server Badge](https://anaconda.org/pytorch3d/pytorch3d/badges/version.svg)](https://anaconda.org/pytorch3d/pytorch3d)
@@ -12,6 +12,7 @@ Key features include:
 - Data structure for storing and manipulating triangle meshes
 - Efficient operations on triangle meshes (projective transformations, graph convolution, sampling, loss functions)
 - A differentiable mesh renderer
+- Implicitron, see [its README](projects/implicitron_trainer), a framework for new-view synthesis via implicit representations. ([blog post](https://ai.facebook.com/blog/implicitron-a-new-modular-extensible-framework-for-neural-implicit-representations-in-pytorch3d/))
 
 PyTorch3D is designed to integrate smoothly with deep learning methods for predicting and manipulating 3D data.
 For this reason, all operators in PyTorch3D:
@@ -23,6 +24,8 @@ For this reason, all operators in PyTorch3D:
 
 Within FAIR, PyTorch3D has been used to power research projects such as [Mesh R-CNN](https://arxiv.org/abs/1906.02739).
 
+See our [blog post](https://ai.facebook.com/blog/-introducing-pytorch3d-an-open-source-library-for-3d-deep-learning/) to see more demos and learn about PyTorch3D.
+
 ## Installation
 
 For detailed instructions refer to [INSTALL.md](INSTALL.md).
@@ -35,25 +38,30 @@ PyTorch3D is released under the [BSD License](LICENSE).
 
 Get started with PyTorch3D by trying one of the tutorial notebooks.
 
-|<img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/master/.github/dolphin_deform.gif" width="310"/>|<img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/master/.github/bundle_adjust.gif" width="310"/>|
+|<img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/main/.github/dolphin_deform.gif" width="310"/>|<img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/main/.github/bundle_adjust.gif" width="310"/>|
 |:-----------------------------------------------------------------------------------------------------------:|:--------------------------------------------------:|
-| [Deform a sphere mesh to dolphin](https://github.com/facebookresearch/pytorch3d/blob/master/docs/tutorials/deform_source_mesh_to_target_mesh.ipynb)| [Bundle adjustment](https://github.com/facebookresearch/pytorch3d/blob/master/docs/tutorials/bundle_adjustment.ipynb) |
+| [Deform a sphere mesh to dolphin](https://github.com/facebookresearch/pytorch3d/blob/main/docs/tutorials/deform_source_mesh_to_target_mesh.ipynb)| [Bundle adjustment](https://github.com/facebookresearch/pytorch3d/blob/main/docs/tutorials/bundle_adjustment.ipynb) |
 
-| <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/master/.github/render_textured_mesh.gif" width="310"/> | <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/master/.github/camera_position_teapot.gif" width="310" height="310"/>
+| <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/main/.github/render_textured_mesh.gif" width="310"/> | <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/main/.github/camera_position_teapot.gif" width="310" height="310"/>
 |:------------------------------------------------------------:|:--------------------------------------------------:|
-| [Render textured meshes](https://github.com/facebookresearch/pytorch3d/blob/master/docs/tutorials/render_textured_meshes.ipynb)| [Camera position optimization](https://github.com/facebookresearch/pytorch3d/blob/master/docs/tutorials/camera_position_optimization_with_differentiable_rendering.ipynb)|
+| [Render textured meshes](https://github.com/facebookresearch/pytorch3d/blob/main/docs/tutorials/render_textured_meshes.ipynb)| [Camera position optimization](https://github.com/facebookresearch/pytorch3d/blob/main/docs/tutorials/camera_position_optimization_with_differentiable_rendering.ipynb)|
 
-| <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/master/.github/pointcloud_render.png" width="310"/> | <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/master/.github/cow_deform.gif" width="310" height="310"/>
+| <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/main/.github/pointcloud_render.png" width="310"/> | <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/main/.github/cow_deform.gif" width="310" height="310"/>
 |:------------------------------------------------------------:|:--------------------------------------------------:|
-| [Render textured pointclouds](https://github.com/facebookresearch/pytorch3d/blob/master/docs/tutorials/render_colored_points.ipynb)| [Fit a mesh with texture](https://github.com/facebookresearch/pytorch3d/blob/master/docs/tutorials/fit_textured_mesh.ipynb)|
+| [Render textured pointclouds](https://github.com/facebookresearch/pytorch3d/blob/main/docs/tutorials/render_colored_points.ipynb)| [Fit a mesh with texture](https://github.com/facebookresearch/pytorch3d/blob/main/docs/tutorials/fit_textured_mesh.ipynb)|
 
-| <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/master/.github/densepose_render.png" width="310"/> | <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/master/.github/shapenet_render.png" width="310" height="310"/>
+| <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/main/.github/densepose_render.png" width="310"/> | <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/main/.github/shapenet_render.png" width="310" height="310"/>
 |:------------------------------------------------------------:|:--------------------------------------------------:|
-| [Render DensePose data](https://github.com/facebookresearch/pytorch3d/blob/master/docs/tutorials/render_densepose.ipynb)| [Load & Render ShapeNet data](https://github.com/facebookresearch/pytorch3d/blob/master/docs/tutorials/dataloaders_ShapeNetCore_R2N2.ipynb)|
+| [Render DensePose data](https://github.com/facebookresearch/pytorch3d/blob/main/docs/tutorials/render_densepose.ipynb)| [Load & Render ShapeNet data](https://github.com/facebookresearch/pytorch3d/blob/main/docs/tutorials/dataloaders_ShapeNetCore_R2N2.ipynb)|
 
-| <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/master/.github/fit_textured_volume.gif" width="310"/> | <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/master/.github/fit_nerf.gif" width="310" height="310"/>
+| <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/main/.github/fit_textured_volume.gif" width="310"/> | <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/main/.github/fit_nerf.gif" width="310" height="310"/>
 |:------------------------------------------------------------:|:--------------------------------------------------:|
-| [Fit Textured Volume](https://github.com/facebookresearch/pytorch3d/blob/master/docs/tutorials/fit_textured_volume.ipynb)| [Fit A Simple Neural Radiance Field](https://github.com/facebookresearch/pytorch3d/blob/master/docs/tutorials/fit_simple_neural_radiance_field.ipynb)|
+| [Fit Textured Volume](https://github.com/facebookresearch/pytorch3d/blob/main/docs/tutorials/fit_textured_volume.ipynb)| [Fit A Simple Neural Radiance Field](https://github.com/facebookresearch/pytorch3d/blob/main/docs/tutorials/fit_simple_neural_radiance_field.ipynb)|
+
+| <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/main/.github/fit_textured_volume.gif" width="310"/> | <img src="https://raw.githubusercontent.com/facebookresearch/pytorch3d/main/.github/implicitron_config.gif" width="310" height="310"/>
+|:------------------------------------------------------------:|:--------------------------------------------------:|
+| [Fit Textured Volume in Implicitron](https://github.com/facebookresearch/pytorch3d/blob/main/docs/tutorials/implicitron_volumes.ipynb)| [Implicitron Config System](https://github.com/facebookresearch/pytorch3d/blob/main/docs/tutorials/implicitron_config_system.ipynb)|
+
 
 
 
@@ -64,9 +72,9 @@ Learn more about the API by reading the PyTorch3D [documentation](https://pytorc
 
 We also have deep dive notes on several API components:
 
-- [Heterogeneous Batching](https://github.com/facebookresearch/pytorch3d/tree/master/docs/notes/batching.md)
-- [Mesh IO](https://github.com/facebookresearch/pytorch3d/tree/master/docs/notes/meshes_io.md)
-- [Differentiable Rendering](https://github.com/facebookresearch/pytorch3d/tree/master/docs/notes/renderer_getting_started.md)
+- [Heterogeneous Batching](https://github.com/facebookresearch/pytorch3d/tree/main/docs/notes/batching.md)
+- [Mesh IO](https://github.com/facebookresearch/pytorch3d/tree/main/docs/notes/meshes_io.md)
+- [Differentiable Rendering](https://github.com/facebookresearch/pytorch3d/tree/main/docs/notes/renderer_getting_started.md)
 
 ### Overview Video
 
@@ -78,6 +86,13 @@ We have created a short (~14 min) video tutorial providing an overview of the Py
 
 We welcome new contributions to PyTorch3D and we will be actively maintaining this library! Please refer to [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for full instructions on how to run the code, tests and linter, and submit your pull requests.
 
+## Development and Compatibility
+
+- `main` branch: actively developed, without any guarantee, Anything can be broken at any time
+  - REMARK: this includes nightly builds which are built from `main`
+  - HINT: the commit history can help locate regressions or changes
+- backward-compatibility between releases: no guarantee. Best efforts to communicate breaking changes and facilitate migration of code or data (incl. models).
+
 ## Contributors
 
 PyTorch3D is written and maintained by the Facebook AI Research Computer Vision Team.
@@ -86,11 +101,13 @@ In alphabetical order:
 
 * Amitav Baruah
 * Steve Branson
+* Krzysztof Chalupka
+* Jiali Duan
 * Luya Gao
 * Georgia Gkioxari
 * Taylor Gordon
 * Justin Johnson
-* Patrick Labtut
+* Patrick Labatut
 * Christoph Lassner
 * Wan-Yen Lo
 * David Novotny
@@ -129,7 +146,27 @@ If you are using the pulsar backend for sphere-rendering (the `PulsarPointRender
 
 Please see below for a timeline of the codebase updates in reverse chronological order. We are sharing updates on the releases as well as research projects which are built with PyTorch3D. The changelogs for the releases are available under [`Releases`](https://github.com/facebookresearch/pytorch3d/releases),  and the builds can be installed using `conda` as per the instructions in [INSTALL.md](INSTALL.md).
 
-**[Feb 9th 2021]:** PyTorch3D [v0.4.0](https://github.com/facebookresearch/pytorch3d/releases/tag/v0.4.0) released with support for implicit functions, volume rendering and a [reimplementation of NeRF](https://github.com/facebookresearch/pytorch3d/tree/master/projects/nerf).
+**[Oct 31st 2023]:**   PyTorch3D [v0.7.5](https://github.com/facebookresearch/pytorch3d/releases/tag/v0.7.5) released.
+
+**[May 10th 2023]:**   PyTorch3D [v0.7.4](https://github.com/facebookresearch/pytorch3d/releases/tag/v0.7.4) released.
+
+**[Apr 5th 2023]:**   PyTorch3D [v0.7.3](https://github.com/facebookresearch/pytorch3d/releases/tag/v0.7.3) released.
+
+**[Dec 19th 2022]:**   PyTorch3D [v0.7.2](https://github.com/facebookresearch/pytorch3d/releases/tag/v0.7.2) released.
+
+**[Oct 23rd 2022]:**   PyTorch3D [v0.7.1](https://github.com/facebookresearch/pytorch3d/releases/tag/v0.7.1) released.
+
+**[Aug 10th 2022]:**   PyTorch3D [v0.7.0](https://github.com/facebookresearch/pytorch3d/releases/tag/v0.7.0) released with Implicitron and MeshRasterizerOpenGL.
+
+**[Apr 28th 2022]:**   PyTorch3D [v0.6.2](https://github.com/facebookresearch/pytorch3d/releases/tag/v0.6.2) released
+
+**[Dec 16th 2021]:**   PyTorch3D [v0.6.1](https://github.com/facebookresearch/pytorch3d/releases/tag/v0.6.1) released
+
+**[Oct 6th 2021]:**   PyTorch3D [v0.6.0](https://github.com/facebookresearch/pytorch3d/releases/tag/v0.6.0) released
+
+**[Aug 5th 2021]:**   PyTorch3D [v0.5.0](https://github.com/facebookresearch/pytorch3d/releases/tag/v0.5.0) released
+
+**[Feb 9th 2021]:** PyTorch3D [v0.4.0](https://github.com/facebookresearch/pytorch3d/releases/tag/v0.4.0) released with support for implicit functions, volume rendering and a [reimplementation of NeRF](https://github.com/facebookresearch/pytorch3d/tree/main/projects/nerf).
 
 **[November 2nd 2020]:** PyTorch3D [v0.3.0](https://github.com/facebookresearch/pytorch3d/releases/tag/v0.3.0) released, integrating the pulsar backend.
 

dev/linter.sh

@@ -1,5 +1,5 @@
 #!/bin/bash -e
-# Copyright (c) Facebook, Inc. and its affiliates.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
 # All rights reserved.
 #
 # This source code is licensed under the BSD-style license found in the
@@ -7,20 +7,17 @@
 
 # Run this script at project root by "./dev/linter.sh" before you commit
 
-{
-  V=$(black --version|cut '-d ' -f3)
-  code='import distutils.version; assert "19.3" < distutils.version.LooseVersion("'$V'")'
-  python -c "${code}" 2> /dev/null
-} || {
-  echo "Linter requires black 19.3b0 or higher!"
-  exit 1
-}
-
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 DIR=$(dirname "${DIR}")
 
-echo "Running isort..."
-isort -y -sp "${DIR}"
+if [[ -f "${DIR}/BUCK" ]]
+then
+  pyfmt "${DIR}"
+else
+# run usort externally only
+  echo "Running usort..."
+  usort  "${DIR}"
+fi
 
 echo "Running black..."
 black "${DIR}"
@@ -33,11 +30,11 @@ clangformat=$(command -v clang-format-8 || echo clang-format)
 find "${DIR}" -regex ".*\.\(cpp\|c\|cc\|cu\|cuh\|cxx\|h\|hh\|hpp\|hxx\|tcc\|mm\|m\)" -print0 | xargs -0 "${clangformat}" -i
 
 # Run arc and pyre internally only.
-if [[ -f "${DIR}/tests/TARGETS" ]]
+if [[ -f "${DIR}/TARGETS" ]]
 then
   (cd "${DIR}"; command -v arc > /dev/null && arc lint) || true
 
   echo "Running pyre..."
   echo "To restart/kill pyre server, run 'pyre restart' or 'pyre kill' in fbcode/"
-  ( cd ~/fbsource/fbcode; pyre -l vision/fair/pytorch3d/ )
+  ( cd ~/fbsource/fbcode; arc pyre check //vision/fair/pytorch3d/... )
 fi

dev/run_tutorials.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/bash
-# Copyright (c) Facebook, Inc. and its affiliates.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
 # All rights reserved.
 #
 # This source code is licensed under the BSD-style license found in the
@@ -23,7 +23,7 @@ conda init bash
 source ~/.bashrc
 conda create -y -n myenv python=3.8 matplotlib ipython ipywidgets nbconvert
 conda activate myenv
-conda install -y -c fvcore -c iopath -c conda-forge fvcore iopath
+conda install -y -c iopath iopath
 conda install -y -c pytorch pytorch=1.6.0 cudatoolkit=10.1 torchvision
 conda install -y -c pytorch3d-nightly pytorch3d
 pip install plotly scikit-image

dev/test_list.py

@@ -0,0 +1,65 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+#
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+import ast
+from pathlib import Path
+from typing import List
+
+
+"""
+This module outputs a list of tests for completion.
+It has no dependencies.
+"""
+
+
+def get_test_files() -> List[Path]:
+    root = Path(__file__).parent.parent
+    dirs = ["tests", "projects/implicitron_trainer"]
+    return [i for dir in dirs for i in (root / dir).glob("**/test*.py")]
+
+
+def tests_from_file(path: Path, base: str) -> List[str]:
+    """
+    Returns all the tests in the given file, in format
+    expected as arguments when running the tests.
+    e.g.
+        file_stem
+        file_stem.TestFunctionality
+        file_stem.TestFunctionality.test_f
+        file_stem.TestFunctionality.test_g
+    """
+    with open(path) as f:
+        node = ast.parse(f.read())
+    out = [base]
+    for cls in node.body:
+        if not isinstance(cls, ast.ClassDef):
+            continue
+        if not cls.name.startswith("Test"):
+            continue
+        class_base = base + "." + cls.name
+        out.append(class_base)
+        for method in cls.body:
+            if not isinstance(method, ast.FunctionDef):
+                continue
+            if not method.name.startswith("test"):
+                continue
+            out.append(class_base + "." + method.name)
+    return out
+
+
+def main() -> None:
+    files = get_test_files()
+    test_root = Path(__file__).parent.parent
+    all_tests = []
+    for f in files:
+        file_base = str(f.relative_to(test_root))[:-3].replace("/", ".")
+        all_tests.extend(tests_from_file(f, file_base))
+    for test in sorted(all_tests):
+        print(test)
+
+
+if __name__ == "__main__":
+    main()

docs/.readthedocs.yaml

@@ -0,0 +1,27 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+#
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: docs/requirements.txt

docs/Makefile

@@ -1,4 +1,8 @@
-# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+#
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
 
 # Minimal makefile for Sphinx documentation
 

docs/README.md

@@ -3,7 +3,7 @@
 ### Install dependencies
 
 ```
-pip install -U recommonmark mock sphinx sphinx_rtd_theme sphinx_markdown_tables
+pip install -U recommonmark sphinx sphinx_rtd_theme sphinx_markdown_tables
 ```
 
 ### Add symlink to the root README.md

docs/conf.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (c) Facebook, Inc. and its affiliates.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
 # All rights reserved.
 #
 # This source code is licensed under the BSD-style license found in the
@@ -19,8 +19,8 @@
 #
 import os
 import sys
+import unittest.mock as mock
 
-import mock
 from recommonmark.parser import CommonMarkParser
 from recommonmark.states import DummyStateMachine
 from sphinx.builders.html import StandaloneHTMLBuilder
@@ -82,11 +82,11 @@ for m in ["cv2", "scipy", "numpy", "pytorch3d._C", "np.eye", "np.zeros"]:
 # -- Project information -----------------------------------------------------
 
 project = "PyTorch3D"
-copyright = "2019, facebookresearch"
+copyright = "Meta Platforms, Inc"
 author = "facebookresearch"
 
 # The short X.Y version
-version = "0.2.0"
+version = ""
 
 # The full version, including alpha/beta/rc tags
 release = version
@@ -159,7 +159,7 @@ html_theme_options = {"collapse_navigation": True}
 def url_resolver(url):
     if ".html" not in url:
         url = url.replace("../", "")
-        return "https://github.com/facebookresearch/pytorch3d/blob/master/" + url
+        return "https://github.com/facebookresearch/pytorch3d/blob/main/" + url
     else:
         if DEPLOY:
             return "http://pytorch3d.readthedocs.io/" + url

docs/examples/pulsar_basic.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# Copyright (c) Facebook, Inc. and its affiliates.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
 # All rights reserved.
 #
 # This source code is licensed under the BSD-style license found in the
@@ -10,6 +10,7 @@ This example demonstrates the most trivial, direct interface of the pulsar
 sphere renderer. It renders and saves an image with 10 random spheres.
 Output: basic.png.
 """
+
 import logging
 import math
 from os import path

docs/examples/pulsar_basic_unified.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# Copyright (c) Facebook, Inc. and its affiliates.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
 # All rights reserved.
 #
 # This source code is licensed under the BSD-style license found in the
@@ -11,6 +11,7 @@ interface for sphere renderering. It renders and saves an image with
 10 random spheres.
 Output: basic-pt3d.png.
 """
+
 import logging
 from os import path
 

docs/examples/pulsar_cam.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# Copyright (c) Facebook, Inc. and its affiliates.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
 # All rights reserved.
 #
 # This source code is licensed under the BSD-style license found in the
@@ -14,6 +14,7 @@ distorted. Gradient-based optimization is used to converge towards the
 original camera parameters.
 Output: cam.gif.
 """
+
 import logging
 import math
 from os import path

docs/examples/pulsar_cam_unified.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# Copyright (c) Facebook, Inc. and its affiliates.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
 # All rights reserved.
 #
 # This source code is licensed under the BSD-style license found in the
@@ -14,6 +14,7 @@ distorted. Gradient-based optimization is used to converge towards the
 original camera parameters.
 Output: cam-pt3d.gif
 """
+
 import logging
 from os import path
 

docs/examples/pulsar_multiview.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# Copyright (c) Facebook, Inc. and its affiliates.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
 # All rights reserved.
 #
 # This source code is licensed under the BSD-style license found in the
@@ -18,6 +18,7 @@ This example is not available yet through the 'unified' interface,
 because opacity support has not landed in PyTorch3D for general data
 structures yet.
 """
+
 import logging
 import math
 from os import path

docs/examples/pulsar_optimization.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# Copyright (c) Facebook, Inc. and its affiliates.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
 # All rights reserved.
 #
 # This source code is licensed under the BSD-style license found in the
@@ -13,6 +13,7 @@ The scene is initialized with random spheres. Gradient-based
 optimization is used to converge towards a faithful
 scene representation.
 """
+
 import logging
 import math
 

docs/examples/pulsar_optimization_unified.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-# Copyright (c) Facebook, Inc. and its affiliates.
+# Copyright (c) Meta Platforms, Inc. and affiliates.
 # All rights reserved.
 #
 # This source code is licensed under the BSD-style license found in the
@@ -13,6 +13,7 @@ The scene is initialized with random spheres. Gradient-based
 optimization is used to converge towards a faithful
 scene representation.
 """
+
 import logging
 import math
 

docs/generate_stubs.py

@@ -0,0 +1,162 @@
+#!/usr/bin/env python3
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+#
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+"""
+This script makes the stubs for implicitron in docs/modules.
+"""
+
+from pathlib import Path
+
+ROOT_DIR = Path(__file__).resolve().parent.parent
+
+
+def paths_to_modules(paths):
+    """
+    Given an iterable of paths, return equivalent list of modules.
+    """
+    return [
+        str(i.relative_to(ROOT_DIR))[:-3].replace("/", ".")
+        for i in paths
+        if "__pycache__" not in str(i)
+    ]
+
+
+def create_one_file(title, description, sources, dest_file):
+    with open(dest_file, "w") as f:
+        print(title, file=f)
+        print("=" * len(title), file=f)
+        print(file=f)
+        print(description, file=f)
+        for source in sources:
+            if source.find("._") != -1:
+                # ignore internal modules including __init__.py
+                continue
+            print(f"\n.. automodule:: {source}", file=f)
+            print("    :members:", file=f)
+            print("    :undoc-members:", file=f)
+            print("    :show-inheritance:", file=f)
+
+
+def iterate_directory(directory_path, dest):
+    """
+    Create a file for each module in the given path
+    """
+    toc = []
+    if not dest.exists():
+        dest.mkdir()
+    for file in sorted(directory_path.glob("*.py")):
+        if file.stem.startswith("_"):
+            continue
+        module = paths_to_modules([file])
+        create_one_file(module[0], file.stem, module, dest / f"{file.stem}.rst")
+        toc.append(file.stem)
+
+    for subdir in directory_path.iterdir():
+        if not subdir.is_dir():
+            continue
+        if subdir.name == "fb":
+            continue
+        if subdir.name.startswith("_"):
+            continue
+        iterate_directory(subdir, dest / (subdir.name))
+        toc.append(f"{subdir.name}/index")
+
+    paths_to_modules_ = paths_to_modules([directory_path.with_suffix(".XX")])
+    if len(paths_to_modules_) == 0:
+        return
+    title = paths_to_modules_[0]
+
+    with open(dest / "index.rst", "w") as f:
+        print(title, file=f)
+        print("=" * len(title), file=f)
+        print("\n.. toctree::\n", file=f)
+        for item in toc:
+            print(f"    {item}", file=f)
+
+
+def make_directory_index(title: str, directory_path: Path):
+    index_file = directory_path / "index.rst"
+    directory_rsts = sorted(directory_path.glob("*.rst"))
+    subdirs = sorted([f for f in directory_path.iterdir() if f.is_dir()])
+    with open(index_file, "w") as f:
+        print(title, file=f)
+        print("=" * len(title), file=f)
+        print("\n.. toctree::\n", file=f)
+        for subdir in subdirs:
+            print(f"    {subdir.stem}/index.rst", file=f)
+        for rst in directory_rsts:
+            if rst.stem == "index":
+                continue
+            print(f"    {rst.stem}", file=f)
+
+
+def do_implicitron():
+    DEST_DIR = Path(__file__).resolve().parent / "modules/implicitron"
+
+    iterate_directory(ROOT_DIR / "pytorch3d/implicitron/models", DEST_DIR / "models")
+
+    unwanted_tools = ["configurable", "depth_cleanup", "utils"]
+    tools_sources = sorted(ROOT_DIR.glob("pytorch3d/implicitron/tools/*.py"))
+    tools_modules = [
+        str(i.relative_to(ROOT_DIR))[:-3].replace("/", ".")
+        for i in tools_sources
+        if i.stem not in unwanted_tools
+    ]
+    create_one_file(
+        "pytorch3d.implicitron.tools",
+        "Tools for implicitron",
+        tools_modules,
+        DEST_DIR / "tools.rst",
+    )
+
+    dataset_files = sorted(ROOT_DIR.glob("pytorch3d/implicitron/dataset/*.py"))
+    basic_dataset = [
+        "dataset_base",
+        "dataset_map_provider",
+        "data_loader_map_provider",
+        "data_source",
+        "scene_batch_sampler",
+    ]
+    basic_dataset_modules = [
+        f"pytorch3d.implicitron.dataset.{i}" for i in basic_dataset
+    ]
+    create_one_file(
+        "pytorch3d.implicitron.dataset in general",
+        "Basics of data for implicitron",
+        basic_dataset_modules,
+        DEST_DIR / "data_basics.rst",
+    )
+
+    specific_dataset_files = [
+        i for i in dataset_files if i.stem.find("_dataset_map_provider") != -1
+    ]
+    create_one_file(
+        "pytorch3d.implicitron.dataset specific datasets",
+        "specific datasets",
+        paths_to_modules(specific_dataset_files),
+        DEST_DIR / "datasets.rst",
+    )
+
+    evaluation_files = sorted(ROOT_DIR.glob("pytorch3d/implicitron/evaluation/*.py"))
+    create_one_file(
+        "pytorch3d.implicitron.evaluation",
+        "evaluation",
+        paths_to_modules(evaluation_files),
+        DEST_DIR / "evaluation.rst",
+    )
+
+    make_directory_index("pytorch3d.implicitron", DEST_DIR)
+
+
+def iterate_toplevel_module(name: str) -> None:
+    dest_dir = Path(__file__).resolve().parent / "modules" / name
+    iterate_directory(ROOT_DIR / "pytorch3d" / name, dest_dir)
+
+
+do_implicitron()
+iterate_toplevel_module("renderer")
+iterate_toplevel_module("vis")

docs/modules/implicitron/data_basics.rst

@@ -0,0 +1,29 @@
+pytorch3d.implicitron.dataset in general
+========================================
+
+Basics of data for implicitron
+
+.. automodule:: pytorch3d.implicitron.dataset.dataset_base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.dataset.dataset_map_provider
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.dataset.data_loader_map_provider
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.dataset.data_source
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.dataset.scene_batch_sampler
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/datasets.rst

@@ -0,0 +1,29 @@
+pytorch3d.implicitron.dataset specific datasets
+===============================================
+
+specific datasets
+
+.. automodule:: pytorch3d.implicitron.dataset.blender_dataset_map_provider
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.dataset.json_index_dataset_map_provider
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.dataset.json_index_dataset_map_provider_v2
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.dataset.llff_dataset_map_provider
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.dataset.rendered_mesh_dataset_map_provider
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/evaluation.rst

@@ -0,0 +1,14 @@
+pytorch3d.implicitron.evaluation
+================================
+
+evaluation
+
+.. automodule:: pytorch3d.implicitron.evaluation.evaluate_new_view_synthesis
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.evaluation.evaluator
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/index.rst

@@ -0,0 +1,10 @@
+pytorch3d.implicitron
+=====================
+
+.. toctree::
+
+    models/index.rst
+    data_basics
+    datasets
+    evaluation
+    tools

docs/modules/implicitron/models/base_model.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.base_model
+=======================================
+
+base_model
+
+.. automodule:: pytorch3d.implicitron.models.base_model
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/feature_extractor/feature_extractor.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.feature_extractor.feature_extractor
+================================================================
+
+feature_extractor
+
+.. automodule:: pytorch3d.implicitron.models.feature_extractor.feature_extractor
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/feature_extractor/index.rst

@@ -0,0 +1,7 @@
+pytorch3d.implicitron.models.feature_extractor
+==============================================
+
+.. toctree::
+
+    feature_extractor
+    resnet_feature_extractor

docs/modules/implicitron/models/feature_extractor/resnet_feature_extractor.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.feature_extractor.resnet_feature_extractor
+=======================================================================
+
+resnet_feature_extractor
+
+.. automodule:: pytorch3d.implicitron.models.feature_extractor.resnet_feature_extractor
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/generic_model.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.generic_model
+==========================================
+
+generic_model
+
+.. automodule:: pytorch3d.implicitron.models.generic_model
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/global_encoder/autodecoder.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.global_encoder.autodecoder
+=======================================================
+
+autodecoder
+
+.. automodule:: pytorch3d.implicitron.models.global_encoder.autodecoder
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/global_encoder/global_encoder.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.global_encoder.global_encoder
+==========================================================
+
+global_encoder
+
+.. automodule:: pytorch3d.implicitron.models.global_encoder.global_encoder
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/global_encoder/index.rst

@@ -0,0 +1,7 @@
+pytorch3d.implicitron.models.global_encoder
+===========================================
+
+.. toctree::
+
+    autodecoder
+    global_encoder

docs/modules/implicitron/models/implicit_function/base.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.implicit_function.base
+===================================================
+
+base
+
+.. automodule:: pytorch3d.implicitron.models.implicit_function.base
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/implicit_function/decoding_functions.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.implicit_function.decoding_functions
+=================================================================
+
+decoding_functions
+
+.. automodule:: pytorch3d.implicitron.models.implicit_function.decoding_functions
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/implicit_function/idr_feature_field.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.implicit_function.idr_feature_field
+================================================================
+
+idr_feature_field
+
+.. automodule:: pytorch3d.implicitron.models.implicit_function.idr_feature_field
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/implicit_function/index.rst

@@ -0,0 +1,13 @@
+pytorch3d.implicitron.models.implicit_function
+==============================================
+
+.. toctree::
+
+    base
+    decoding_functions
+    idr_feature_field
+    neural_radiance_field
+    scene_representation_networks
+    utils
+    voxel_grid
+    voxel_grid_implicit_function

docs/modules/implicitron/models/implicit_function/neural_radiance_field.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.implicit_function.neural_radiance_field
+====================================================================
+
+neural_radiance_field
+
+.. automodule:: pytorch3d.implicitron.models.implicit_function.neural_radiance_field
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/implicit_function/scene_representation_networks.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.implicit_function.scene_representation_networks
+============================================================================
+
+scene_representation_networks
+
+.. automodule:: pytorch3d.implicitron.models.implicit_function.scene_representation_networks
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/implicit_function/utils.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.implicit_function.utils
+====================================================
+
+utils
+
+.. automodule:: pytorch3d.implicitron.models.implicit_function.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/implicit_function/voxel_grid.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.implicit_function.voxel_grid
+=========================================================
+
+voxel_grid
+
+.. automodule:: pytorch3d.implicitron.models.implicit_function.voxel_grid
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/implicit_function/voxel_grid_implicit_function.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.implicit_function.voxel_grid_implicit_function
+===========================================================================
+
+voxel_grid_implicit_function
+
+.. automodule:: pytorch3d.implicitron.models.implicit_function.voxel_grid_implicit_function
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/index.rst

@@ -0,0 +1,15 @@
+pytorch3d.implicitron.models
+============================
+
+.. toctree::
+
+    base_model
+    generic_model
+    metrics
+    model_dbir
+    feature_extractor/index
+    global_encoder/index
+    implicit_function/index
+    renderer/index
+    view_pooler/index
+    visualization/index

docs/modules/implicitron/models/metrics.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.metrics
+====================================
+
+metrics
+
+.. automodule:: pytorch3d.implicitron.models.metrics
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/model_dbir.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.model_dbir
+=======================================
+
+model_dbir
+
+.. automodule:: pytorch3d.implicitron.models.model_dbir
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/renderer/base.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.renderer.base
+==========================================
+
+base
+
+.. automodule:: pytorch3d.implicitron.models.renderer.base
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/renderer/index.rst

@@ -0,0 +1,14 @@
+pytorch3d.implicitron.models.renderer
+=====================================
+
+.. toctree::
+
+    base
+    lstm_renderer
+    multipass_ea
+    ray_point_refiner
+    ray_sampler
+    ray_tracing
+    raymarcher
+    rgb_net
+    sdf_renderer

docs/modules/implicitron/models/renderer/lstm_renderer.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.renderer.lstm_renderer
+===================================================
+
+lstm_renderer
+
+.. automodule:: pytorch3d.implicitron.models.renderer.lstm_renderer
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/renderer/multipass_ea.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.renderer.multipass_ea
+==================================================
+
+multipass_ea
+
+.. automodule:: pytorch3d.implicitron.models.renderer.multipass_ea
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/renderer/ray_point_refiner.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.renderer.ray_point_refiner
+=======================================================
+
+ray_point_refiner
+
+.. automodule:: pytorch3d.implicitron.models.renderer.ray_point_refiner
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/renderer/ray_sampler.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.renderer.ray_sampler
+=================================================
+
+ray_sampler
+
+.. automodule:: pytorch3d.implicitron.models.renderer.ray_sampler
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/renderer/ray_tracing.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.renderer.ray_tracing
+=================================================
+
+ray_tracing
+
+.. automodule:: pytorch3d.implicitron.models.renderer.ray_tracing
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/renderer/raymarcher.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.renderer.raymarcher
+================================================
+
+raymarcher
+
+.. automodule:: pytorch3d.implicitron.models.renderer.raymarcher
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/renderer/rgb_net.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.renderer.rgb_net
+=============================================
+
+rgb_net
+
+.. automodule:: pytorch3d.implicitron.models.renderer.rgb_net
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/renderer/sdf_renderer.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.renderer.sdf_renderer
+==================================================
+
+sdf_renderer
+
+.. automodule:: pytorch3d.implicitron.models.renderer.sdf_renderer
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/view_pooler/feature_aggregator.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.view_pooler.feature_aggregator
+===========================================================
+
+feature_aggregator
+
+.. automodule:: pytorch3d.implicitron.models.view_pooler.feature_aggregator
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/view_pooler/index.rst

@@ -0,0 +1,8 @@
+pytorch3d.implicitron.models.view_pooler
+========================================
+
+.. toctree::
+
+    feature_aggregator
+    view_pooler
+    view_sampler

docs/modules/implicitron/models/view_pooler/view_pooler.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.view_pooler.view_pooler
+====================================================
+
+view_pooler
+
+.. automodule:: pytorch3d.implicitron.models.view_pooler.view_pooler
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/view_pooler/view_sampler.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.view_pooler.view_sampler
+=====================================================
+
+view_sampler
+
+.. automodule:: pytorch3d.implicitron.models.view_pooler.view_sampler
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/models/visualization/index.rst

@@ -0,0 +1,6 @@
+pytorch3d.implicitron.models.visualization
+==========================================
+
+.. toctree::
+
+    render_flyaround

docs/modules/implicitron/models/visualization/render_flyaround.rst

@@ -0,0 +1,9 @@
+pytorch3d.implicitron.models.visualization.render_flyaround
+===========================================================
+
+render_flyaround
+
+.. automodule:: pytorch3d.implicitron.models.visualization.render_flyaround
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/implicitron/tools.rst

@@ -0,0 +1,64 @@
+pytorch3d.implicitron.tools
+===========================
+
+Tools for implicitron
+
+.. automodule:: pytorch3d.implicitron.tools.camera_utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.tools.circle_fitting
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.tools.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.tools.eval_video_trajectory
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.tools.image_utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.tools.metric_utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.tools.model_io
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.tools.point_cloud_utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.tools.rasterize_mc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.tools.stats
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.tools.video_writer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+.. automodule:: pytorch3d.implicitron.tools.vis_utils
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/index.rst

@@ -3,7 +3,6 @@ API Documentation
 
 .. toctree::
 
-    common
     structures
     io
     loss
@@ -12,3 +11,6 @@ API Documentation
     transforms
     utils
     datasets
+    common
+    vis/index
+    implicitron/index

docs/modules/renderer/blending.rst

@@ -1,7 +1,9 @@
-blending
+pytorch3d.renderer.blending
 ===========================
 
+blending
+
 .. automodule:: pytorch3d.renderer.blending
     :members:
     :undoc-members:
-    :show-inheritance:
+    :show-inheritance:

docs/modules/renderer/camera_conversions.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.camera_conversions
+=====================================
+
+camera_conversions
+
+.. automodule:: pytorch3d.renderer.camera_conversions
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/camera_utils.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.camera_utils
+===============================
+
+camera_utils
+
+.. automodule:: pytorch3d.renderer.camera_utils
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/cameras.rst

@@ -1,7 +1,9 @@
+pytorch3d.renderer.cameras
+==========================
+
 cameras
-===========================
 
 .. automodule:: pytorch3d.renderer.cameras
     :members:
     :undoc-members:
-    :show-inheritance:
+    :show-inheritance:

docs/modules/renderer/compositing.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.compositing
+==============================
+
+compositing
+
+.. automodule:: pytorch3d.renderer.compositing
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/fisheyecameras.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.fisheyecameras
+=================================
+
+fisheyecameras
+
+.. automodule:: pytorch3d.renderer.fisheyecameras
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/implicit/harmonic_embedding.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.implicit.harmonic_embedding
+==============================================
+
+harmonic_embedding
+
+.. automodule:: pytorch3d.renderer.implicit.harmonic_embedding
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/implicit/index.rst

@@ -0,0 +1,11 @@
+pytorch3d.renderer.implicit
+===========================
+
+.. toctree::
+
+    harmonic_embedding
+    raymarching
+    raysampling
+    renderer
+    sample_pdf
+    utils

docs/modules/renderer/implicit/raymarching.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.implicit.raymarching
+=======================================
+
+raymarching
+
+.. automodule:: pytorch3d.renderer.implicit.raymarching
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/implicit/raysampling.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.implicit.raysampling
+=======================================
+
+raysampling
+
+.. automodule:: pytorch3d.renderer.implicit.raysampling
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/implicit/renderer.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.implicit.renderer
+====================================
+
+renderer
+
+.. automodule:: pytorch3d.renderer.implicit.renderer
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/implicit/sample_pdf.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.implicit.sample_pdf
+======================================
+
+sample_pdf
+
+.. automodule:: pytorch3d.renderer.implicit.sample_pdf
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/implicit/utils.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.implicit.utils
+=================================
+
+utils
+
+.. automodule:: pytorch3d.renderer.implicit.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/index.rst

@@ -1,15 +1,19 @@
-pytorch3d.renderer 
-===========================
+pytorch3d.renderer
+==================
 
 .. toctree::
 
-    rasterizer
+    blending
+    camera_conversions
+    camera_utils
     cameras
+    compositing
+    fisheyecameras
     lighting
     materials
-    texturing
-    blending
-    shading
-    shader
-    renderer
-    utils
+    splatter_blend
+    utils
+    implicit/index
+    mesh/index
+    opengl/index
+    points/index

docs/modules/renderer/lighting.rst

@@ -1,6 +1,9 @@
-lighting
+pytorch3d.renderer.lighting
 ===========================
 
+lighting
+
 .. automodule:: pytorch3d.renderer.lighting
     :members:
-    :undoc-members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/materials.rst

@@ -1,7 +1,9 @@
+pytorch3d.renderer.materials
+============================
+
 materials
-===========================
 
 .. automodule:: pytorch3d.renderer.materials
     :members:
     :undoc-members:
-    :show-inheritance:
+    :show-inheritance:

docs/modules/renderer/mesh/clip.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.mesh.clip
+============================
+
+clip
+
+.. automodule:: pytorch3d.renderer.mesh.clip
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/mesh/index.rst

@@ -0,0 +1,13 @@
+pytorch3d.renderer.mesh
+=======================
+
+.. toctree::
+
+    clip
+    rasterize_meshes
+    rasterizer
+    renderer
+    shader
+    shading
+    textures
+    utils

docs/modules/renderer/mesh/rasterize_meshes.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.mesh.rasterize_meshes
+========================================
+
+rasterize_meshes
+
+.. automodule:: pytorch3d.renderer.mesh.rasterize_meshes
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/mesh/rasterizer.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.mesh.rasterizer
+==================================
+
+rasterizer
+
+.. automodule:: pytorch3d.renderer.mesh.rasterizer
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/mesh/renderer.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.mesh.renderer
+================================
+
+renderer
+
+.. automodule:: pytorch3d.renderer.mesh.renderer
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/mesh/shader.rst

@@ -1,7 +1,9 @@
+pytorch3d.renderer.mesh.shader
+==============================
+
 shader
-===========================
 
 .. automodule:: pytorch3d.renderer.mesh.shader
     :members:
     :undoc-members:
-    
+    :show-inheritance:

docs/modules/renderer/mesh/shading.rst

@@ -1,7 +1,9 @@
+pytorch3d.renderer.mesh.shading
+===============================
+
 shading
-===========================
 
 .. automodule:: pytorch3d.renderer.mesh.shading
     :members:
     :undoc-members:
-    
+    :show-inheritance:

docs/modules/renderer/mesh/textures.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.mesh.textures
+================================
+
+textures
+
+.. automodule:: pytorch3d.renderer.mesh.textures
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/mesh/utils.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.mesh.utils
+=============================
+
+utils
+
+.. automodule:: pytorch3d.renderer.mesh.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/opengl/index.rst

@@ -0,0 +1,7 @@
+pytorch3d.renderer.opengl
+=========================
+
+.. toctree::
+
+    opengl_utils
+    rasterizer_opengl

docs/modules/renderer/opengl/opengl_utils.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.opengl.opengl_utils
+======================================
+
+opengl_utils
+
+.. automodule:: pytorch3d.renderer.opengl.opengl_utils
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/opengl/rasterizer_opengl.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.opengl.rasterizer_opengl
+===========================================
+
+rasterizer_opengl
+
+.. automodule:: pytorch3d.renderer.opengl.rasterizer_opengl
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/modules/renderer/points/compositor.rst

@@ -0,0 +1,9 @@
+pytorch3d.renderer.points.compositor
+====================================
+
+compositor
+
+.. automodule:: pytorch3d.renderer.points.compositor
+    :members:
+    :undoc-members:
+    :show-inheritance: