Unverified Commit 26ab7ff2 authored by Wenhao Wu's avatar Wenhao Wu Committed by GitHub
Browse files

[Enhance] Use PyTorch Sphinx Theme (#958)

* [Enhance] Use PyTorch Sphinx Theme

* refine English docs

* refine Chinese docs

* fix type in Chinese docs
parent 75c5c6cd
.header-logo {
background-image: url("../image/mmdet3d-logo.png");
background-size: 182.5px 40px;
height: 40px;
width: 182.5px;
}
API Documentation
=================
mmdet3d.core mmdet3d.core
-------------- --------------
......
# Compatibility with Previous Versions of MMDetection3D ## 0.16.0
This document provides detailed descriptions of the BC-breaking changes in MMDetection3D.
## MMDetection3D 0.16.0
### Returned values of `QueryAndGroup` operation ### Returned values of `QueryAndGroup` operation
...@@ -26,7 +22,7 @@ We adopt a new pre-processing procedure for the ScanNet dataset in order to supp ...@@ -26,7 +22,7 @@ We adopt a new pre-processing procedure for the ScanNet dataset in order to supp
Please refer to the ScanNet [README.md](https://github.com/open-mmlab/mmdetection3d/blob/master/data/scannet/README.md/) for more details. Please refer to the ScanNet [README.md](https://github.com/open-mmlab/mmdetection3d/blob/master/data/scannet/README.md/) for more details.
## MMDetection3D 0.15.0 ## 0.15.0
### MMCV Version ### MMCV Version
...@@ -45,7 +41,7 @@ We modified the dataset augmentation function `BackgroundPointsFilter`([here](ht ...@@ -45,7 +41,7 @@ We modified the dataset augmentation function `BackgroundPointsFilter`([here](ht
We enhance the pipeline function `IndoorPatchPointSample` used in point cloud segmentation task by adding more choices for patch selection. Also, we plan to remove the unused parameter `sample_rate` in the future. Please modify the code as well as the config files accordingly if you use this transform. We enhance the pipeline function `IndoorPatchPointSample` used in point cloud segmentation task by adding more choices for patch selection. Also, we plan to remove the unused parameter `sample_rate` in the future. Please modify the code as well as the config files accordingly if you use this transform.
## MMDetection3D 0.14.0 ## 0.14.0
### Dataset class for 3D segmentation task ### Dataset class for 3D segmentation task
...@@ -65,7 +61,7 @@ We adopt new pre-processing and conversion steps of ScanNet dataset. In previous ...@@ -65,7 +61,7 @@ We adopt new pre-processing and conversion steps of ScanNet dataset. In previous
We have trained a [VoteNet](https://github.com/open-mmlab/mmdetection3d/blob/master/configs/votenet/votenet_8x8_scannet-3d-18class.py) model on the newly processed ScanNet dataset and get similar benchmark results. In order to prepare ScanNet data for both detection and segmentation tasks, please re-run the new pre-processing scripts following the ScanNet [README.md](https://github.com/open-mmlab/mmdetection3d/blob/master/data/scannet/README.md/). We have trained a [VoteNet](https://github.com/open-mmlab/mmdetection3d/blob/master/configs/votenet/votenet_8x8_scannet-3d-18class.py) model on the newly processed ScanNet dataset and get similar benchmark results. In order to prepare ScanNet data for both detection and segmentation tasks, please re-run the new pre-processing scripts following the ScanNet [README.md](https://github.com/open-mmlab/mmdetection3d/blob/master/data/scannet/README.md/).
## MMDetection3D 0.12.0 ## 0.12.0
### SUNRGBD dataset for ImVoteNet ### SUNRGBD dataset for ImVoteNet
...@@ -77,7 +73,7 @@ We adopt a new pre-processing procedure for the SUNRGBD dataset in order to supp ...@@ -77,7 +73,7 @@ We adopt a new pre-processing procedure for the SUNRGBD dataset in order to supp
Please refer to the SUNRGBD [README.md](https://github.com/open-mmlab/mmdetection3d/blob/master/data/sunrgbd/README.md/) for more details. Please refer to the SUNRGBD [README.md](https://github.com/open-mmlab/mmdetection3d/blob/master/data/sunrgbd/README.md/) for more details.
## MMDetection3D 0.6.0 ## 0.6.0
### VoteNet model structure update ### VoteNet model structure update
......
...@@ -11,6 +11,7 @@ ...@@ -11,6 +11,7 @@
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
# #
import os import os
import pytorch_sphinx_theme
import subprocess import subprocess
import sys import sys
from m2r import MdInclude from m2r import MdInclude
...@@ -48,6 +49,7 @@ extensions = [ ...@@ -48,6 +49,7 @@ extensions = [
'recommonmark', 'recommonmark',
'sphinx_markdown_tables', 'sphinx_markdown_tables',
'sphinx.ext.autosectionlabel', 'sphinx.ext.autosectionlabel',
'sphinx_copybutton',
] ]
autodoc_mock_imports = [ autodoc_mock_imports = [
...@@ -80,12 +82,103 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] ...@@ -80,12 +82,103 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
# #
html_theme = 'sphinx_rtd_theme' # html_theme = 'sphinx_rtd_theme'
html_theme = 'pytorch_sphinx_theme'
html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()]
html_theme_options = {
# 'logo_url': 'https://mmocr.readthedocs.io/en/latest/',
'menu': [
{
'name': 'GitHub',
'url': 'https://github.com/open-mmlab/mmdetection3d'
},
{
'name':
'Projects',
'children': [
{
'name': 'MMAction2',
'url': 'https://github.com/open-mmlab/mmaction2',
},
{
'name': 'MMClassification',
'url': 'https://github.com/open-mmlab/mmclassification',
},
{
'name': 'MMCV',
'url': 'https://github.com/open-mmlab/mmmmcv',
},
{
'name': 'MMDetection',
'url': 'https://github.com/open-mmlab/mmdetection',
},
{
'name': 'MMEditing',
'url': 'https://github.com/open-mmlab/mmediting',
},
{
'name': 'MMGeneration',
'url': 'https://github.com/open-mmlab/mmgeneration',
},
{
'name': 'MMOCR',
'url': 'https://github.com/open-mmlab/mmocr',
},
{
'name': 'MMPose',
'url': 'https://github.com/open-mmlab/mmpose',
},
{
'name': 'MMSegmentation',
'url': 'https://github.com/open-mmlab/mmsegmentation',
},
{
'name': 'MMTracking',
'url': 'https://github.com/open-mmlab/mmtracking',
},
]
},
{
'name':
'OpenMMLab',
'children': [
{
'name': 'Homepage',
'url': 'https://openmmlab.com/'
},
{
'name': 'GitHub',
'url': 'https://github.com/open-mmlab/'
},
{
'name': 'Twitter',
'url': 'https://twitter.com/OpenMMLab'
},
{
'name': 'Zhihu',
'url': 'https://zhihu.com/people/openmmlab'
},
]
},
]
}
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']
html_css_files = ['css/readthedocs.css']
latex_documents = [
(master_doc, 'mmcv.tex', 'mmcv Documentation', 'MMCV Contributors',
'manual'),
]
# -- Extension configuration -------------------------------------------------
# Ignore >>> when copying code
copybutton_prompt_text = r'>>> |\.\.\. '
copybutton_prompt_is_regexp = True
def builder_inited_handler(app): def builder_inited_handler(app):
......
...@@ -2,59 +2,91 @@ Welcome to MMDetection3D's documentation! ...@@ -2,59 +2,91 @@ Welcome to MMDetection3D's documentation!
========================================== ==========================================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: Get Started :caption: Get Started
getting_started.md getting_started.md
.. toctree::
:maxdepth: 1
:caption: Demo
demo.md demo.md
.. toctree::
:maxdepth: 1
:caption: Model Zoo
model_zoo.md model_zoo.md
.. toctree::
:maxdepth: 1
:caption: Data Preparation
data_preparation.md data_preparation.md
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: Quick Run :caption: Exist Data and Model
1_exist_data_model.md 1_exist_data_model.md
.. toctree::
:maxdepth: 1
:caption: New Data and Model
2_new_data_model.md 2_new_data_model.md
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: Supported Tasks :caption: Supported Tasks
supported_tasks/index.rst supported_tasks/index.rst
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: Datasets :caption: Datasets
datasets/index.rst datasets/index.rst
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: Tutorials :caption: Tutorials
tutorials/index.rst tutorials/index.rst
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: Useful Tools and Scripts :caption: Useful Tools and Scripts
useful_tools.md useful_tools.md
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: Notes :caption: Notes
benchmarks.md benchmarks.md
.. toctree::
:maxdepth: 1
:caption: FAQ
faq.md faq.md
.. toctree::
:maxdepth: 1
:caption: Compatibility
compatibility.md compatibility.md
.. toctree:: .. toctree::
:maxdepth: 1
:caption: API Reference :caption: API Reference
api.rst api.rst
.. toctree:: .. toctree::
:maxdepth: 1
:caption: Switch Language :caption: Switch Language
switch_language.md switch_language.md
......
# 1使用已有模型在标准数据集上进行推理和训练 # 1: 使用已有模型在标准数据集上进行推理和训练
## 使用已有模型进行推理 ## 使用已有模型进行推理
......
.header-logo {
background-image: url("../image/mmdet3d-logo.png");
background-size: 182.5px 40px;
height: 40px;
width: 182.5px;
}
API Documentation
=================
mmdet3d.core mmdet3d.core
-------------- --------------
......
# 和过去版本的 MMDetection3D 的兼容性 ## 0.16.0
\ No newline at end of file
...@@ -11,6 +11,7 @@ ...@@ -11,6 +11,7 @@
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
# #
import os import os
import pytorch_sphinx_theme
import subprocess import subprocess
import sys import sys
from m2r import MdInclude from m2r import MdInclude
...@@ -48,6 +49,7 @@ extensions = [ ...@@ -48,6 +49,7 @@ extensions = [
'recommonmark', 'recommonmark',
'sphinx_markdown_tables', 'sphinx_markdown_tables',
'sphinx.ext.autosectionlabel', 'sphinx.ext.autosectionlabel',
'sphinx_copybutton',
] ]
autodoc_mock_imports = [ autodoc_mock_imports = [
...@@ -80,12 +82,103 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] ...@@ -80,12 +82,103 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
# #
html_theme = 'sphinx_rtd_theme' # html_theme = 'sphinx_rtd_theme'
html_theme = 'pytorch_sphinx_theme'
html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()]
html_theme_options = {
# 'logo_url': 'https://mmocr.readthedocs.io/en/latest/',
'menu': [
{
'name': 'GitHub',
'url': 'https://github.com/open-mmlab/mmdetection3d'
},
{
'name':
'算法库',
'children': [
{
'name': 'MMAction2',
'url': 'https://github.com/open-mmlab/mmaction2',
},
{
'name': 'MMClassification',
'url': 'https://github.com/open-mmlab/mmclassification',
},
{
'name': 'MMCV',
'url': 'https://github.com/open-mmlab/mmmmcv',
},
{
'name': 'MMDetection',
'url': 'https://github.com/open-mmlab/mmdetection',
},
{
'name': 'MMEditing',
'url': 'https://github.com/open-mmlab/mmediting',
},
{
'name': 'MMGeneration',
'url': 'https://github.com/open-mmlab/mmgeneration',
},
{
'name': 'MMOCR',
'url': 'https://github.com/open-mmlab/mmocr',
},
{
'name': 'MMPose',
'url': 'https://github.com/open-mmlab/mmpose',
},
{
'name': 'MMSegmentation',
'url': 'https://github.com/open-mmlab/mmsegmentation',
},
{
'name': 'MMTracking',
'url': 'https://github.com/open-mmlab/mmtracking',
},
]
},
{
'name':
'OpenMMLab',
'children': [
{
'name': '官网',
'url': 'https://openmmlab.com/'
},
{
'name': 'GitHub',
'url': 'https://github.com/open-mmlab/'
},
{
'name': '推特',
'url': 'https://twitter.com/OpenMMLab'
},
{
'name': '知乎',
'url': 'https://zhihu.com/people/openmmlab'
},
]
},
]
}
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']
html_css_files = ['css/readthedocs.css']
latex_documents = [
(master_doc, 'mmcv.tex', 'mmcv Documentation', 'MMCV Contributors',
'manual'),
]
# -- Extension configuration -------------------------------------------------
# Ignore >>> when copying code
copybutton_prompt_text = r'>>> |\.\.\. '
copybutton_prompt_is_regexp = True
def builder_inited_handler(app): def builder_inited_handler(app):
......
...@@ -2,59 +2,91 @@ Welcome to MMDetection3D's documentation! ...@@ -2,59 +2,91 @@ Welcome to MMDetection3D's documentation!
========================================== ==========================================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: 开始你的第一步 :caption: 开始你的第一步
getting_started.md getting_started.md
.. toctree::
:maxdepth: 1
:caption: 演示
demo.md demo.md
.. toctree::
:maxdepth: 1
:caption: 模型库
model_zoo.md model_zoo.md
.. toctree::
:maxdepth: 1
:caption: 数据预处理
data_preparation.md data_preparation.md
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: 快速启动 :caption: 使用现有数据及模型
1_exist_data_model.md 1_exist_data_model.md
.. toctree::
:maxdepth: 1
:caption: 创建新的数据与模型
2_new_data_model.md 2_new_data_model.md
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: 支持的任务 :caption: 支持的任务
supported_tasks/index.rst supported_tasks/index.rst
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: 数据集介绍 :caption: 数据集介绍
datasets/index.rst datasets/index.rst
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: 教程 :caption: 教程
tutorials/index.rst tutorials/index.rst
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: 实用工具与脚本 :caption: 实用工具与脚本
useful_tools.md useful_tools.md
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
:caption: 说明 :caption: 说明
benchmarks.md benchmarks.md
.. toctree::
:maxdepth: 1
:caption: 常见问题
faq.md faq.md
.. toctree::
:maxdepth: 1
:caption: 兼容性
compatibility.md compatibility.md
.. toctree:: .. toctree::
:maxdepth: 1
:caption: 接口文档(英文) :caption: 接口文档(英文)
api.rst api.rst
.. toctree:: .. toctree::
:maxdepth: 1
:caption: 语言切换 :caption: 语言切换
switch_language.md switch_language.md
......
# 教程 5自定义运行时配置 # 教程 5: 自定义运行时配置
## 自定义优化器设置 ## 自定义优化器设置
......
...@@ -2,7 +2,8 @@ docutils==0.16.0 ...@@ -2,7 +2,8 @@ docutils==0.16.0
m2r m2r
myst-parser myst-parser
opencv-python opencv-python
-e git+https://github.com/open-mmlab/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme
sphinx==4.0.2 sphinx==4.0.2
sphinx-copybutton
sphinx_markdown_tables sphinx_markdown_tables
sphinx_rtd_theme==0.5.2
torch torch
...@@ -8,6 +8,6 @@ line_length = 79 ...@@ -8,6 +8,6 @@ line_length = 79
multi_line_output = 0 multi_line_output = 0
known_standard_library = setuptools known_standard_library = setuptools
known_first_party = mmdet,mmseg,mmdet3d known_first_party = mmdet,mmseg,mmdet3d
known_third_party = cv2,imageio,indoor3d_util,load_scannet_data,lyft_dataset_sdk,m2r,matplotlib,mmcv,nuimages,numba,numpy,nuscenes,pandas,plyfile,pycocotools,pyquaternion,pytest,recommonmark,scannet_utils,scipy,seaborn,shapely,skimage,tensorflow,terminaltables,torch,trimesh,waymo_open_dataset known_third_party = cv2,imageio,indoor3d_util,load_scannet_data,lyft_dataset_sdk,m2r,matplotlib,mmcv,nuimages,numba,numpy,nuscenes,pandas,plyfile,pycocotools,pyquaternion,pytest,pytorch_sphinx_theme,recommonmark,scannet_utils,scipy,seaborn,shapely,skimage,tensorflow,terminaltables,torch,trimesh,waymo_open_dataset
no_lines_before = STDLIB,LOCALFOLDER no_lines_before = STDLIB,LOCALFOLDER
default_section = THIRDPARTY default_section = THIRDPARTY
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment