WarpConvNet/mkdocs.yml at main · NVlabs/WarpConvNet · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
site_name: WarpConvNet
site_description: NVIDIA Library for 3D Spatially Sparse Neural Networks and Sparse Convolutions
repo_url: https://github.com/nvlabs/warpconvnet
repo_name: nvlabs/warpconvnet
site_author: NVIDIA
docs_dir: docs
site_dir: site

theme:
  name: readthedocs

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            show_source: true
            show_root_heading: true
            docstring_style: numpy
            show_signature_annotations: true
            filters: ["!^_"]

markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.details
  - admonition
  - toc:
      permalink: true

extra_javascript:
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js
  - javascripts/mermaid-init.js

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting_started/installation.md
      - Quick Start: getting_started/quickstart.md
      - Deployment: deployment.md
  - User Guide:
      - Basic Concepts: user_guide/concepts.md
      - Geometry Types: user_guide/geometry_types.md
      - Geometry Tutorial: user_guide/geometry_tutorial.md
      - Network Tutorial: user_guide/network_tutorial.md
      - Sparse Convolutions: user_guide/sparse_convolutions.md
      - Adaptive GEMM Grouping: user_guide/adaptive_gemm_grouping.md
      - Inspect Benchmark Cache: user_guide/inspect_benchmark_cache.md
      - Pre-Populate Benchmark Cache: user_guide/populate_benchmark_cache.md
      - Point Convolutions: user_guide/point_convolutions.md
      - Normalizations: user_guide/normalizations.md
      - Diagram Generation: user_guide/diagrams.md
  - Diagrams:
      - Architecture: diagrams/architecture.md
      - Class Hierarchy: diagrams/class_hierarchy.md
      - Data Flow: diagrams/data_flow.md
      - Geometry Types: diagrams/geometry_types.md
      - Model Architecture: diagrams/model_architecture.md
      - API Sequence: diagrams/api_sequence.md
  - API Reference:
      - Core: api/core.md
      - Dataset: api/dataset.md
      - Geometry: api/geometry.md
      - Batched Geometry: api/geometry_batched.md
      - Models: api/models.md
      - Neural Networks: api/nn.md
      - Neural Network Functionals: api/nn_functional.md
      - Operations: api/ops.md
      - Utils: api/utils.md
      - Types: api/types.md
      - Miscellaneous: api/misc.md
  - Examples:
      - ScanNet: examples/scannet.md
      - ModelNet: examples/modelnet.md
  - Contributing: contributing.md