Skip to content

Commit 9a0b0c2

Browse files
bottlerfacebook-github-bot
bottler
authored and
facebook-github-bot
committed
renderer and vis readthedocs #1363
Summary: Autogenerate docs for the renderer too. This will be helpful but make a slightly ugly TOC Reviewed By: kjchalup Differential Revision: D40977315 fbshipit-source-id: 10831de3ced68080cb5671c5dc31d4da8500f761
1 parent d0fbe2c commit 9a0b0c2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+408
-99
lines changed

‎docs/generate_implicitron_stubs.py renamed to ‎docs/generate_stubs.py

+66-52
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
from pathlib import Path
1313

1414
ROOT_DIR = Path(__file__).resolve().parent.parent
15-
DEST_DIR = Path(__file__).resolve().parent / "modules/implicitron"
1615

1716

1817
def paths_to_modules(paths):
@@ -95,54 +94,69 @@ def make_directory_index(title: str, directory_path: Path):
9594
print(f" {rst.stem}", file=f)
9695

9796

98-
iterate_directory(ROOT_DIR / "pytorch3d/implicitron/models", DEST_DIR / "models")
99-
100-
unwanted_tools = ["configurable", "depth_cleanup", "utils"]
101-
tools_sources = sorted(ROOT_DIR.glob("pytorch3d/implicitron/tools/*.py"))
102-
tools_modules = [
103-
str(i.relative_to(ROOT_DIR))[:-3].replace("/", ".")
104-
for i in tools_sources
105-
if i.stem not in unwanted_tools
106-
]
107-
create_one_file(
108-
"pytorch3d.implicitron.tools",
109-
"Tools for implicitron",
110-
tools_modules,
111-
DEST_DIR / "tools.rst",
112-
)
113-
114-
dataset_files = sorted(ROOT_DIR.glob("pytorch3d/implicitron/dataset/*.py"))
115-
basic_dataset = [
116-
"dataset_base",
117-
"dataset_map_provider",
118-
"data_loader_map_provider",
119-
"data_source",
120-
"scene_batch_sampler",
121-
]
122-
basic_dataset_modules = [f"pytorch3d.implicitron.dataset.{i}" for i in basic_dataset]
123-
create_one_file(
124-
"pytorch3d.implicitron.dataset in general",
125-
"Basics of data for implicitron",
126-
basic_dataset_modules,
127-
DEST_DIR / "data_basics.rst",
128-
)
129-
130-
specific_dataset_files = [
131-
i for i in dataset_files if i.stem.find("_dataset_map_provider") != -1
132-
]
133-
create_one_file(
134-
"pytorch3d.implicitron.dataset specific datasets",
135-
"specific datasets",
136-
paths_to_modules(specific_dataset_files),
137-
DEST_DIR / "datasets.rst",
138-
)
139-
140-
evaluation_files = sorted(ROOT_DIR.glob("pytorch3d/implicitron/evaluation/*.py"))
141-
create_one_file(
142-
"pytorch3d.implicitron.evaluation",
143-
"evaluation",
144-
paths_to_modules(evaluation_files),
145-
DEST_DIR / "evaluation.rst",
146-
)
147-
148-
make_directory_index("pytorch3d.implicitron", DEST_DIR)
97+
def do_implicitron():
98+
DEST_DIR = Path(__file__).resolve().parent / "modules/implicitron"
99+
100+
iterate_directory(ROOT_DIR / "pytorch3d/implicitron/models", DEST_DIR / "models")
101+
102+
unwanted_tools = ["configurable", "depth_cleanup", "utils"]
103+
tools_sources = sorted(ROOT_DIR.glob("pytorch3d/implicitron/tools/*.py"))
104+
tools_modules = [
105+
str(i.relative_to(ROOT_DIR))[:-3].replace("/", ".")
106+
for i in tools_sources
107+
if i.stem not in unwanted_tools
108+
]
109+
create_one_file(
110+
"pytorch3d.implicitron.tools",
111+
"Tools for implicitron",
112+
tools_modules,
113+
DEST_DIR / "tools.rst",
114+
)
115+
116+
dataset_files = sorted(ROOT_DIR.glob("pytorch3d/implicitron/dataset/*.py"))
117+
basic_dataset = [
118+
"dataset_base",
119+
"dataset_map_provider",
120+
"data_loader_map_provider",
121+
"data_source",
122+
"scene_batch_sampler",
123+
]
124+
basic_dataset_modules = [
125+
f"pytorch3d.implicitron.dataset.{i}" for i in basic_dataset
126+
]
127+
create_one_file(
128+
"pytorch3d.implicitron.dataset in general",
129+
"Basics of data for implicitron",
130+
basic_dataset_modules,
131+
DEST_DIR / "data_basics.rst",
132+
)
133+
134+
specific_dataset_files = [
135+
i for i in dataset_files if i.stem.find("_dataset_map_provider") != -1
136+
]
137+
create_one_file(
138+
"pytorch3d.implicitron.dataset specific datasets",
139+
"specific datasets",
140+
paths_to_modules(specific_dataset_files),
141+
DEST_DIR / "datasets.rst",
142+
)
143+
144+
evaluation_files = sorted(ROOT_DIR.glob("pytorch3d/implicitron/evaluation/*.py"))
145+
create_one_file(
146+
"pytorch3d.implicitron.evaluation",
147+
"evaluation",
148+
paths_to_modules(evaluation_files),
149+
DEST_DIR / "evaluation.rst",
150+
)
151+
152+
make_directory_index("pytorch3d.implicitron", DEST_DIR)
153+
154+
155+
def iterate_toplevel_module(name: str) -> None:
156+
dest_dir = Path(__file__).resolve().parent / "modules" / name
157+
iterate_directory(ROOT_DIR / "pytorch3d" / name, dest_dir)
158+
159+
160+
do_implicitron()
161+
iterate_toplevel_module("renderer")
162+
iterate_toplevel_module("vis")

‎docs/modules/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ API Documentation
1212
utils
1313
datasets
1414
common
15-
vis
15+
vis/index
1616
implicitron/index

‎docs/modules/renderer/blending.rst

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
blending
1+
pytorch3d.renderer.blending
22
===========================
33

4+
blending
5+
46
.. automodule:: pytorch3d.renderer.blending
57
:members:
68
:undoc-members:
7-
:show-inheritance:
9+
:show-inheritance:

‎docs/modules/renderer/camera_conversions.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pytorch3d.renderer.camera_conversions
2+
=====================================
3+
4+
camera_conversions
5+
6+
.. automodule:: pytorch3d.renderer.camera_conversions
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/modules/renderer/camera_utils.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pytorch3d.renderer.camera_utils
2+
===============================
3+
4+
camera_utils
5+
6+
.. automodule:: pytorch3d.renderer.camera_utils
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/modules/renderer/cameras.rst

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
pytorch3d.renderer.cameras
2+
==========================
3+
14
cameras
2-
===========================
35

46
.. automodule:: pytorch3d.renderer.cameras
57
:members:
68
:undoc-members:
7-
:show-inheritance:
9+
:show-inheritance:

‎docs/modules/renderer/compositing.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pytorch3d.renderer.compositing
2+
==============================
3+
4+
compositing
5+
6+
.. automodule:: pytorch3d.renderer.compositing
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/modules/renderer/fisheyecameras.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pytorch3d.renderer.fisheyecameras
2+
=================================
3+
4+
fisheyecameras
5+
6+
.. automodule:: pytorch3d.renderer.fisheyecameras
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/modules/renderer/implicit/harmonic_embedding.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pytorch3d.renderer.implicit.harmonic_embedding
2+
==============================================
3+
4+
harmonic_embedding
5+
6+
.. automodule:: pytorch3d.renderer.implicit.harmonic_embedding
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/modules/renderer/implicit/index.rst

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
pytorch3d.renderer.implicit
2+
===========================
3+
4+
.. toctree::
5+
6+
harmonic_embedding
7+
raymarching
8+
raysampling
9+
renderer
10+
sample_pdf
11+
utils

‎docs/modules/renderer/implicit/raymarching.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pytorch3d.renderer.implicit.raymarching
2+
=======================================
3+
4+
raymarching
5+
6+
.. automodule:: pytorch3d.renderer.implicit.raymarching
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/modules/renderer/implicit/raysampling.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pytorch3d.renderer.implicit.raysampling
2+
=======================================
3+
4+
raysampling
5+
6+
.. automodule:: pytorch3d.renderer.implicit.raysampling
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/modules/renderer/implicit/renderer.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pytorch3d.renderer.implicit.renderer
2+
====================================
3+
4+
renderer
5+
6+
.. automodule:: pytorch3d.renderer.implicit.renderer
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/modules/renderer/implicit/sample_pdf.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pytorch3d.renderer.implicit.sample_pdf
2+
======================================
3+
4+
sample_pdf
5+
6+
.. automodule:: pytorch3d.renderer.implicit.sample_pdf
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/modules/renderer/implicit/utils.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pytorch3d.renderer.implicit.utils
2+
=================================
3+
4+
utils
5+
6+
.. automodule:: pytorch3d.renderer.implicit.utils
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/modules/renderer/index.rst

+13-9
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
1-
pytorch3d.renderer
2-
===========================
1+
pytorch3d.renderer
2+
==================
33

44
.. toctree::
55

6-
rasterizer
6+
blending
7+
camera_conversions
8+
camera_utils
79
cameras
10+
compositing
11+
fisheyecameras
812
lighting
913
materials
10-
texturing
11-
blending
12-
shading
13-
shader
14-
renderer
15-
utils
14+
splatter_blend
15+
utils
16+
implicit/index
17+
mesh/index
18+
opengl/index
19+
points/index

‎docs/modules/renderer/lighting.rst

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
lighting
1+
pytorch3d.renderer.lighting
22
===========================
33

4+
lighting
5+
46
.. automodule:: pytorch3d.renderer.lighting
57
:members:
6-
:undoc-members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/modules/renderer/materials.rst

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
pytorch3d.renderer.materials
2+
============================
3+
14
materials
2-
===========================
35

46
.. automodule:: pytorch3d.renderer.materials
57
:members:
68
:undoc-members:
7-
:show-inheritance:
9+
:show-inheritance:

‎docs/modules/renderer/mesh/clip.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pytorch3d.renderer.mesh.clip
2+
============================
3+
4+
clip
5+
6+
.. automodule:: pytorch3d.renderer.mesh.clip
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/modules/renderer/mesh/index.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
pytorch3d.renderer.mesh
2+
=======================
3+
4+
.. toctree::
5+
6+
clip
7+
rasterize_meshes
8+
rasterizer
9+
renderer
10+
shader
11+
shading
12+
textures
13+
utils

‎docs/modules/renderer/mesh/rasterize_meshes.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pytorch3d.renderer.mesh.rasterize_meshes
2+
========================================
3+
4+
rasterize_meshes
5+
6+
.. automodule:: pytorch3d.renderer.mesh.rasterize_meshes
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/modules/renderer/mesh/rasterizer.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pytorch3d.renderer.mesh.rasterizer
2+
==================================
3+
4+
rasterizer
5+
6+
.. automodule:: pytorch3d.renderer.mesh.rasterizer
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/modules/renderer/mesh/renderer.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
pytorch3d.renderer.mesh.renderer
2+
================================
3+
4+
renderer
5+
6+
.. automodule:: pytorch3d.renderer.mesh.renderer
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:

‎docs/modules/renderer/shader.rst renamed to ‎docs/modules/renderer/mesh/shader.rst

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
pytorch3d.renderer.mesh.shader
2+
==============================
3+
14
shader
2-
===========================
35

46
.. automodule:: pytorch3d.renderer.mesh.shader
57
:members:
68
:undoc-members:
7-
9+
:show-inheritance:

0 commit comments

Comments
 (0)