diff --git a/docs/api_docs/python/conf.py b/docs/api_docs/python/conf.py index f22b0fd16..f3bb44d1f 100644 --- a/docs/api_docs/python/conf.py +++ b/docs/api_docs/python/conf.py @@ -66,7 +66,8 @@ exclude_patterns = [] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'furo' +# html_theme = 'furo' +html_theme = 'sphinx_book_theme' # -- Extension configuration ------------------------------------------------- def setup(app): diff --git a/docs/api_docs/python/face_alignment.md b/docs/api_docs/python/face_alignment.md index f0369b55a..85f79e2f0 100644 --- a/docs/api_docs/python/face_alignment.md +++ b/docs/api_docs/python/face_alignment.md @@ -1,4 +1,4 @@ -# Face Alignment API +# Face Alignment(人脸对齐) ## fastdeploy.vision.facealign.PFLD diff --git a/docs/api_docs/python/face_detection.md b/docs/api_docs/python/face_detection.md index 3e8d5762c..93068a4d1 100644 --- a/docs/api_docs/python/face_detection.md +++ b/docs/api_docs/python/face_detection.md @@ -1,4 +1,4 @@ -# Face Detection API +# Face Detection(人脸检测) ## fastdeploy.vision.facedet.RetinaFace diff --git a/docs/api_docs/python/face_recognition.md b/docs/api_docs/python/face_recognition.md index 344aab796..1f0c507ae 100644 --- a/docs/api_docs/python/face_recognition.md +++ b/docs/api_docs/python/face_recognition.md @@ -1,4 +1,4 @@ -# Face Recognition API +# Face Recognition(人脸识别) ## fastdeploy.vision.faceid.AdaFace diff --git a/docs/api_docs/python/headpose.md b/docs/api_docs/python/headpose.md index d1fba74f9..fb2b9080f 100644 --- a/docs/api_docs/python/headpose.md +++ b/docs/api_docs/python/headpose.md @@ -1,4 +1,4 @@ -# Headpose API +# Headpose(头部姿态) ## fastdeploy.vision.headpose.FSANet diff --git a/docs/api_docs/python/image_classification.md b/docs/api_docs/python/image_classification.md index ad284ca66..6b18f5c09 100755 --- a/docs/api_docs/python/image_classification.md +++ b/docs/api_docs/python/image_classification.md @@ -1,4 +1,4 @@ -# Image Classification API +# Image Classification(图像分类) ## fastdeploy.vision.classification.PaddleClasModel diff --git a/docs/api_docs/python/index.rst b/docs/api_docs/python/index.rst index 69b65b3b1..77d7d64ea 100644 --- a/docs/api_docs/python/index.rst +++ b/docs/api_docs/python/index.rst @@ -8,7 +8,7 @@ FastDeploy * Contact Us: fastdeploy@baidu.com .. toctree:: - :caption: 文档目录 + :caption: Vision Task Model API (视觉任务模型API) :maxdepth: 2 :titlesonly: @@ -22,6 +22,19 @@ FastDeploy face_detection.md face_alignment.md headpose.md + + +.. toctree:: + :caption: Predict Result Struct (预测结果结构体) + :maxdepth: 3 + :titlesonly: + vision_results_en.md + +.. toctree:: + :caption: FastDeploy Runtime API (多后端推理引擎API) + :maxdepth: 2 + :titlesonly: + runtime.md runtime_option.md diff --git a/docs/api_docs/python/keypoint_detection.md b/docs/api_docs/python/keypoint_detection.md index b2ee83704..b0510e1b9 100644 --- a/docs/api_docs/python/keypoint_detection.md +++ b/docs/api_docs/python/keypoint_detection.md @@ -1,4 +1,4 @@ -# Keypoint Detection API +# Keypoint Detection(关键点检测) ## fastdeploy.vision.keypointdetection.PPTinyPose diff --git a/docs/api_docs/python/matting.md b/docs/api_docs/python/matting.md index 5e9c2a227..5998f132d 100644 --- a/docs/api_docs/python/matting.md +++ b/docs/api_docs/python/matting.md @@ -1,4 +1,4 @@ -# Matting API +# Matting(图像抠图) ## fastdeploy.vision.matting.MODNet diff --git a/docs/api_docs/python/object_detection.md b/docs/api_docs/python/object_detection.md index 6bab167cf..efe7b5923 100644 --- a/docs/api_docs/python/object_detection.md +++ b/docs/api_docs/python/object_detection.md @@ -1,4 +1,4 @@ -# Object Detection API +# Object Detection(目标检测) ## fastdeploy.vision.detection.PPYOLOE @@ -16,14 +16,6 @@ :inherited-members: ``` -## fastdeploy.vision.detection.PPYOLOv2 - -```{eval-rst} -.. autoclass:: fastdeploy.vision.detection.PPYOLOv2 - :members: - :inherited-members: -``` - ## fastdeploy.vision.detection.PicoDet ```{eval-rst} diff --git a/docs/api_docs/python/ocr.md b/docs/api_docs/python/ocr.md index 622918203..a197263d5 100644 --- a/docs/api_docs/python/ocr.md +++ b/docs/api_docs/python/ocr.md @@ -1,4 +1,4 @@ -# OCR API +# OCR(文字识别) ## fastdeploy.vision.ocr.DBDetector diff --git a/docs/api_docs/python/runtime.md b/docs/api_docs/python/runtime.md index 4a519ee7e..6e7b8888e 100644 --- a/docs/api_docs/python/runtime.md +++ b/docs/api_docs/python/runtime.md @@ -1,4 +1,4 @@ -# Runtime API +# Runtime(模型推理Runtime) ## fastdeploy.Runtime diff --git a/docs/api_docs/python/runtime_option.md b/docs/api_docs/python/runtime_option.md index 96eff8672..3f0f8dde9 100644 --- a/docs/api_docs/python/runtime_option.md +++ b/docs/api_docs/python/runtime_option.md @@ -1,4 +1,4 @@ -# Runtime Option API +# Runtime Option(Runtime配置) ## fastdeploy.RuntimeOption diff --git a/docs/api_docs/python/semantic_segmentation.md b/docs/api_docs/python/semantic_segmentation.md index dd9a2a5ff..6d224e085 100644 --- a/docs/api_docs/python/semantic_segmentation.md +++ b/docs/api_docs/python/semantic_segmentation.md @@ -1,4 +1,4 @@ -# Semantic Segmentation API +# Semantic Segmentation(语义分割) ## fastdeploy.vision.segmentation.PaddleSegModel