modify docs

This commit is contained in:
jiangjiajun
2022-11-16 09:58:01 +00:00
parent 18669b539a
commit fac2a9bede
14 changed files with 28 additions and 22 deletions

View File

@@ -66,7 +66,8 @@ exclude_patterns = []
# 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 = 'furo' # html_theme = 'furo'
html_theme = 'sphinx_book_theme'
# -- Extension configuration ------------------------------------------------- # -- Extension configuration -------------------------------------------------
def setup(app): def setup(app):

View File

@@ -1,4 +1,4 @@
# Face Alignment API # Face Alignment(人脸对齐)
## fastdeploy.vision.facealign.PFLD ## fastdeploy.vision.facealign.PFLD

View File

@@ -1,4 +1,4 @@
# Face Detection API # Face Detection(人脸检测)
## fastdeploy.vision.facedet.RetinaFace ## fastdeploy.vision.facedet.RetinaFace

View File

@@ -1,4 +1,4 @@
# Face Recognition API # Face Recognition(人脸识别)
## fastdeploy.vision.faceid.AdaFace ## fastdeploy.vision.faceid.AdaFace

View File

@@ -1,4 +1,4 @@
# Headpose API # Headpose(头部姿态)
## fastdeploy.vision.headpose.FSANet ## fastdeploy.vision.headpose.FSANet

View File

@@ -1,4 +1,4 @@
# Image Classification API # Image Classification(图像分类)
## fastdeploy.vision.classification.PaddleClasModel ## fastdeploy.vision.classification.PaddleClasModel

View File

@@ -8,7 +8,7 @@ FastDeploy
* Contact Us: fastdeploy@baidu.com * Contact Us: fastdeploy@baidu.com
.. toctree:: .. toctree::
:caption: 文档目录 :caption: Vision Task Model API (视觉任务模型API)
:maxdepth: 2 :maxdepth: 2
:titlesonly: :titlesonly:
@@ -22,6 +22,19 @@ FastDeploy
face_detection.md face_detection.md
face_alignment.md face_alignment.md
headpose.md headpose.md
.. toctree::
:caption: Predict Result Struct (预测结果结构体)
:maxdepth: 3
:titlesonly:
vision_results_en.md vision_results_en.md
.. toctree::
:caption: FastDeploy Runtime API (多后端推理引擎API)
:maxdepth: 2
:titlesonly:
runtime.md runtime.md
runtime_option.md runtime_option.md

View File

@@ -1,4 +1,4 @@
# Keypoint Detection API # Keypoint Detection(关键点检测)
## fastdeploy.vision.keypointdetection.PPTinyPose ## fastdeploy.vision.keypointdetection.PPTinyPose

View File

@@ -1,4 +1,4 @@
# Matting API # Matting(图像抠图)
## fastdeploy.vision.matting.MODNet ## fastdeploy.vision.matting.MODNet

View File

@@ -1,4 +1,4 @@
# Object Detection API # Object Detection(目标检测)
## fastdeploy.vision.detection.PPYOLOE ## fastdeploy.vision.detection.PPYOLOE
@@ -16,14 +16,6 @@
:inherited-members: :inherited-members:
``` ```
## fastdeploy.vision.detection.PPYOLOv2
```{eval-rst}
.. autoclass:: fastdeploy.vision.detection.PPYOLOv2
:members:
:inherited-members:
```
## fastdeploy.vision.detection.PicoDet ## fastdeploy.vision.detection.PicoDet
```{eval-rst} ```{eval-rst}

View File

@@ -1,4 +1,4 @@
# OCR API # OCR(文字识别)
## fastdeploy.vision.ocr.DBDetector ## fastdeploy.vision.ocr.DBDetector

View File

@@ -1,4 +1,4 @@
# Runtime API # Runtime(模型推理Runtime)
## fastdeploy.Runtime ## fastdeploy.Runtime

View File

@@ -1,4 +1,4 @@
# Runtime Option API # Runtime Option(Runtime配置)
## fastdeploy.RuntimeOption ## fastdeploy.RuntimeOption

View File

@@ -1,4 +1,4 @@
# Semantic Segmentation API # Semantic Segmentation(语义分割)
## fastdeploy.vision.segmentation.PaddleSegModel ## fastdeploy.vision.segmentation.PaddleSegModel