From cd113efd98dad0fabcc19e8bce73540329f52d95 Mon Sep 17 00:00:00 2001 From: Jeremy Reizenstein Date: Mon, 31 Oct 2022 14:44:41 -0700 Subject: [PATCH] Add implicitron to readthedocs Summary: Try to document implicitron. Most of this is autogenerated. Reviewed By: shapovalov Differential Revision: D40623742 fbshipit-source-id: 453508277903b7d987b1703656ba1ee09bc2c570 --- docs/generate_implicitron_stubs.py | 120 ++++++++++++++++++ docs/modules/implicitron/data_basics.rst | 29 +++++ docs/modules/implicitron/datasets.rst | 29 +++++ docs/modules/implicitron/evaluation.rst | 14 ++ .../modules/implicitron/models/base_model.rst | 9 ++ .../feature_extractor/feature_extractor.rst | 9 ++ .../models/feature_extractor/index.rst | 7 + .../resnet_feature_extractor.rst | 9 ++ .../implicitron/models/generic_model.rst | 9 ++ .../models/global_encoder/autodecoder.rst | 9 ++ .../models/global_encoder/global_encoder.rst | 9 ++ .../models/global_encoder/index.rst | 7 + .../models/implicit_function/base.rst | 9 ++ .../implicit_function/decoding_functions.rst | 9 ++ .../implicit_function/idr_feature_field.rst | 9 ++ .../models/implicit_function/index.rst | 13 ++ .../neural_radiance_field.rst | 9 ++ .../scene_representation_networks.rst | 9 ++ .../models/implicit_function/utils.rst | 9 ++ .../models/implicit_function/voxel_grid.rst | 9 ++ .../voxel_grid_implicit_function.rst | 9 ++ docs/modules/implicitron/models/index.rst | 15 +++ docs/modules/implicitron/models/metrics.rst | 9 ++ .../modules/implicitron/models/model_dbir.rst | 9 ++ .../implicitron/models/renderer/base.rst | 9 ++ .../implicitron/models/renderer/index.rst | 14 ++ .../models/renderer/lstm_renderer.rst | 9 ++ .../models/renderer/multipass_ea.rst | 9 ++ .../models/renderer/ray_point_refiner.rst | 9 ++ .../models/renderer/ray_sampler.rst | 9 ++ .../models/renderer/ray_tracing.rst | 9 ++ .../models/renderer/raymarcher.rst | 9 ++ .../implicitron/models/renderer/rgb_net.rst | 9 ++ .../models/renderer/sdf_renderer.rst | 9 ++ .../models/view_pooler/feature_aggregator.rst | 9 ++ .../implicitron/models/view_pooler/index.rst | 8 ++ .../models/view_pooler/view_pooler.rst | 9 ++ .../models/view_pooler/view_sampler.rst | 9 ++ .../models/visualization/index.rst | 6 + .../models/visualization/render_flyaround.rst | 9 ++ docs/modules/implicitron/tools.rst | 64 ++++++++++ docs/modules/index.rst | 1 + docs/requirements.txt | 1 + 43 files changed, 589 insertions(+) create mode 100755 docs/generate_implicitron_stubs.py create mode 100644 docs/modules/implicitron/data_basics.rst create mode 100644 docs/modules/implicitron/datasets.rst create mode 100644 docs/modules/implicitron/evaluation.rst create mode 100644 docs/modules/implicitron/models/base_model.rst create mode 100644 docs/modules/implicitron/models/feature_extractor/feature_extractor.rst create mode 100644 docs/modules/implicitron/models/feature_extractor/index.rst create mode 100644 docs/modules/implicitron/models/feature_extractor/resnet_feature_extractor.rst create mode 100644 docs/modules/implicitron/models/generic_model.rst create mode 100644 docs/modules/implicitron/models/global_encoder/autodecoder.rst create mode 100644 docs/modules/implicitron/models/global_encoder/global_encoder.rst create mode 100644 docs/modules/implicitron/models/global_encoder/index.rst create mode 100644 docs/modules/implicitron/models/implicit_function/base.rst create mode 100644 docs/modules/implicitron/models/implicit_function/decoding_functions.rst create mode 100644 docs/modules/implicitron/models/implicit_function/idr_feature_field.rst create mode 100644 docs/modules/implicitron/models/implicit_function/index.rst create mode 100644 docs/modules/implicitron/models/implicit_function/neural_radiance_field.rst create mode 100644 docs/modules/implicitron/models/implicit_function/scene_representation_networks.rst create mode 100644 docs/modules/implicitron/models/implicit_function/utils.rst create mode 100644 docs/modules/implicitron/models/implicit_function/voxel_grid.rst create mode 100644 docs/modules/implicitron/models/implicit_function/voxel_grid_implicit_function.rst create mode 100644 docs/modules/implicitron/models/index.rst create mode 100644 docs/modules/implicitron/models/metrics.rst create mode 100644 docs/modules/implicitron/models/model_dbir.rst create mode 100644 docs/modules/implicitron/models/renderer/base.rst create mode 100644 docs/modules/implicitron/models/renderer/index.rst create mode 100644 docs/modules/implicitron/models/renderer/lstm_renderer.rst create mode 100644 docs/modules/implicitron/models/renderer/multipass_ea.rst create mode 100644 docs/modules/implicitron/models/renderer/ray_point_refiner.rst create mode 100644 docs/modules/implicitron/models/renderer/ray_sampler.rst create mode 100644 docs/modules/implicitron/models/renderer/ray_tracing.rst create mode 100644 docs/modules/implicitron/models/renderer/raymarcher.rst create mode 100644 docs/modules/implicitron/models/renderer/rgb_net.rst create mode 100644 docs/modules/implicitron/models/renderer/sdf_renderer.rst create mode 100644 docs/modules/implicitron/models/view_pooler/feature_aggregator.rst create mode 100644 docs/modules/implicitron/models/view_pooler/index.rst create mode 100644 docs/modules/implicitron/models/view_pooler/view_pooler.rst create mode 100644 docs/modules/implicitron/models/view_pooler/view_sampler.rst create mode 100644 docs/modules/implicitron/models/visualization/index.rst create mode 100644 docs/modules/implicitron/models/visualization/render_flyaround.rst create mode 100644 docs/modules/implicitron/tools.rst diff --git a/docs/generate_implicitron_stubs.py b/docs/generate_implicitron_stubs.py new file mode 100755 index 00000000..43a9516a --- /dev/null +++ b/docs/generate_implicitron_stubs.py @@ -0,0 +1,120 @@ +#!/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 +DEST_DIR = Path(__file__).resolve().parent / "modules/implicitron" + + +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] + + +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 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 + iterate_directory(subdir, dest / (subdir.name)) + toc.append(f"{subdir.name}/index") + + with open(dest / "index.rst", "w") as f: + title = paths_to_modules([directory_path.with_suffix(".XX")])[0] + print(title, file=f) + print("=" * len(title), file=f) + print("\n.. toctree::\n", file=f) + for item in toc: + print(f" {item}", file=f) + + +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", + "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.impliciton.dataset", + "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.impliciton.evaluation", + "evaluation", + paths_to_modules(evaluation_files), + DEST_DIR / "evaluation.rst", +) diff --git a/docs/modules/implicitron/data_basics.rst b/docs/modules/implicitron/data_basics.rst new file mode 100644 index 00000000..078e0762 --- /dev/null +++ b/docs/modules/implicitron/data_basics.rst @@ -0,0 +1,29 @@ +pytorch3d.implicitron.dataset +============================= + +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: diff --git a/docs/modules/implicitron/datasets.rst b/docs/modules/implicitron/datasets.rst new file mode 100644 index 00000000..144afb41 --- /dev/null +++ b/docs/modules/implicitron/datasets.rst @@ -0,0 +1,29 @@ +pytorch3d.impliciton.dataset +============================ + +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: diff --git a/docs/modules/implicitron/evaluation.rst b/docs/modules/implicitron/evaluation.rst new file mode 100644 index 00000000..326f5557 --- /dev/null +++ b/docs/modules/implicitron/evaluation.rst @@ -0,0 +1,14 @@ +pytorch3d.impliciton.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: diff --git a/docs/modules/implicitron/models/base_model.rst b/docs/modules/implicitron/models/base_model.rst new file mode 100644 index 00000000..9208d491 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/feature_extractor/feature_extractor.rst b/docs/modules/implicitron/models/feature_extractor/feature_extractor.rst new file mode 100644 index 00000000..1121a201 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/feature_extractor/index.rst b/docs/modules/implicitron/models/feature_extractor/index.rst new file mode 100644 index 00000000..51a22ac0 --- /dev/null +++ b/docs/modules/implicitron/models/feature_extractor/index.rst @@ -0,0 +1,7 @@ +pytorch3d.implicitron.models.feature_extractor +============================================== + +.. toctree:: + + feature_extractor + resnet_feature_extractor diff --git a/docs/modules/implicitron/models/feature_extractor/resnet_feature_extractor.rst b/docs/modules/implicitron/models/feature_extractor/resnet_feature_extractor.rst new file mode 100644 index 00000000..13d37ed4 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/generic_model.rst b/docs/modules/implicitron/models/generic_model.rst new file mode 100644 index 00000000..41ccc89a --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/global_encoder/autodecoder.rst b/docs/modules/implicitron/models/global_encoder/autodecoder.rst new file mode 100644 index 00000000..ee7e36c9 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/global_encoder/global_encoder.rst b/docs/modules/implicitron/models/global_encoder/global_encoder.rst new file mode 100644 index 00000000..d8c3fb2f --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/global_encoder/index.rst b/docs/modules/implicitron/models/global_encoder/index.rst new file mode 100644 index 00000000..b861de01 --- /dev/null +++ b/docs/modules/implicitron/models/global_encoder/index.rst @@ -0,0 +1,7 @@ +pytorch3d.implicitron.models.global_encoder +=========================================== + +.. toctree:: + + autodecoder + global_encoder diff --git a/docs/modules/implicitron/models/implicit_function/base.rst b/docs/modules/implicitron/models/implicit_function/base.rst new file mode 100644 index 00000000..1161b181 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/implicit_function/decoding_functions.rst b/docs/modules/implicitron/models/implicit_function/decoding_functions.rst new file mode 100644 index 00000000..7a1f135f --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/implicit_function/idr_feature_field.rst b/docs/modules/implicitron/models/implicit_function/idr_feature_field.rst new file mode 100644 index 00000000..8a6d9b5b --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/implicit_function/index.rst b/docs/modules/implicitron/models/implicit_function/index.rst new file mode 100644 index 00000000..60fdcd7a --- /dev/null +++ b/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 diff --git a/docs/modules/implicitron/models/implicit_function/neural_radiance_field.rst b/docs/modules/implicitron/models/implicit_function/neural_radiance_field.rst new file mode 100644 index 00000000..7d81e4f8 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/implicit_function/scene_representation_networks.rst b/docs/modules/implicitron/models/implicit_function/scene_representation_networks.rst new file mode 100644 index 00000000..8c9eba80 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/implicit_function/utils.rst b/docs/modules/implicitron/models/implicit_function/utils.rst new file mode 100644 index 00000000..5c8dddb9 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/implicit_function/voxel_grid.rst b/docs/modules/implicitron/models/implicit_function/voxel_grid.rst new file mode 100644 index 00000000..137dea9c --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/implicit_function/voxel_grid_implicit_function.rst b/docs/modules/implicitron/models/implicit_function/voxel_grid_implicit_function.rst new file mode 100644 index 00000000..5687bc40 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/index.rst b/docs/modules/implicitron/models/index.rst new file mode 100644 index 00000000..4bd70a44 --- /dev/null +++ b/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 diff --git a/docs/modules/implicitron/models/metrics.rst b/docs/modules/implicitron/models/metrics.rst new file mode 100644 index 00000000..6895e1ea --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/model_dbir.rst b/docs/modules/implicitron/models/model_dbir.rst new file mode 100644 index 00000000..c47c784e --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/renderer/base.rst b/docs/modules/implicitron/models/renderer/base.rst new file mode 100644 index 00000000..67ad3661 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/renderer/index.rst b/docs/modules/implicitron/models/renderer/index.rst new file mode 100644 index 00000000..24e7dde7 --- /dev/null +++ b/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 diff --git a/docs/modules/implicitron/models/renderer/lstm_renderer.rst b/docs/modules/implicitron/models/renderer/lstm_renderer.rst new file mode 100644 index 00000000..f23d985c --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/renderer/multipass_ea.rst b/docs/modules/implicitron/models/renderer/multipass_ea.rst new file mode 100644 index 00000000..745c3249 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/renderer/ray_point_refiner.rst b/docs/modules/implicitron/models/renderer/ray_point_refiner.rst new file mode 100644 index 00000000..f5387ce8 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/renderer/ray_sampler.rst b/docs/modules/implicitron/models/renderer/ray_sampler.rst new file mode 100644 index 00000000..5c638abe --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/renderer/ray_tracing.rst b/docs/modules/implicitron/models/renderer/ray_tracing.rst new file mode 100644 index 00000000..fe2033df --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/renderer/raymarcher.rst b/docs/modules/implicitron/models/renderer/raymarcher.rst new file mode 100644 index 00000000..687202e9 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/renderer/rgb_net.rst b/docs/modules/implicitron/models/renderer/rgb_net.rst new file mode 100644 index 00000000..dc40dc07 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/renderer/sdf_renderer.rst b/docs/modules/implicitron/models/renderer/sdf_renderer.rst new file mode 100644 index 00000000..ca0e48df --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/view_pooler/feature_aggregator.rst b/docs/modules/implicitron/models/view_pooler/feature_aggregator.rst new file mode 100644 index 00000000..fb874f03 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/view_pooler/index.rst b/docs/modules/implicitron/models/view_pooler/index.rst new file mode 100644 index 00000000..b6822598 --- /dev/null +++ b/docs/modules/implicitron/models/view_pooler/index.rst @@ -0,0 +1,8 @@ +pytorch3d.implicitron.models.view_pooler +======================================== + +.. toctree:: + + feature_aggregator + view_pooler + view_sampler diff --git a/docs/modules/implicitron/models/view_pooler/view_pooler.rst b/docs/modules/implicitron/models/view_pooler/view_pooler.rst new file mode 100644 index 00000000..bfd90434 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/view_pooler/view_sampler.rst b/docs/modules/implicitron/models/view_pooler/view_sampler.rst new file mode 100644 index 00000000..eb02e856 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/models/visualization/index.rst b/docs/modules/implicitron/models/visualization/index.rst new file mode 100644 index 00000000..ebc041f2 --- /dev/null +++ b/docs/modules/implicitron/models/visualization/index.rst @@ -0,0 +1,6 @@ +pytorch3d.implicitron.models.visualization +========================================== + +.. toctree:: + + render_flyaround diff --git a/docs/modules/implicitron/models/visualization/render_flyaround.rst b/docs/modules/implicitron/models/visualization/render_flyaround.rst new file mode 100644 index 00000000..49779a12 --- /dev/null +++ b/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: diff --git a/docs/modules/implicitron/tools.rst b/docs/modules/implicitron/tools.rst new file mode 100644 index 00000000..a694ed3e --- /dev/null +++ b/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: diff --git a/docs/modules/index.rst b/docs/modules/index.rst index c2f301dc..18017a16 100644 --- a/docs/modules/index.rst +++ b/docs/modules/index.rst @@ -13,3 +13,4 @@ API Documentation datasets common vis + implicitron/index diff --git a/docs/requirements.txt b/docs/requirements.txt index 867cdd45..e541c2bd 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -9,3 +9,4 @@ iopath fvcore https://download.pytorch.org/whl/cpu/torchvision-0.8.2%2Bcpu-cp37-cp37m-linux_x86_64.whl https://download.pytorch.org/whl/cpu/torch-1.7.1%2Bcpu-cp37-cp37m-linux_x86_64.whl +omegaconf