mirror of
https://github.com/PaddlePaddle/FastDeploy.git
synced 2025-10-13 12:23:55 +08:00
add new docs
This commit is contained in:
2494
.new_docs/api_docs/cpp/Doxyfile
Normal file
2494
.new_docs/api_docs/cpp/Doxyfile
Normal file
File diff suppressed because it is too large
Load Diff
13
.new_docs/api_docs/cpp/README.md
Normal file
13
.new_docs/api_docs/cpp/README.md
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
# Python API
|
||||||
|
|
||||||
|
This directory help to generate C++ API documents for FastDeploy.
|
||||||
|
|
||||||
|
In this directory, execute the following command,
|
||||||
|
|
||||||
|
```
|
||||||
|
sudo apt-get install doxygen
|
||||||
|
|
||||||
|
doxygen
|
||||||
|
```
|
||||||
|
|
||||||
|
After execution, use browsers open `docs/html/index.html`
|
2
.new_docs/api_docs/cpp/docs/.gitignore
vendored
Normal file
2
.new_docs/api_docs/cpp/docs/.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
html
|
||||||
|
latex
|
27
.new_docs/api_docs/cpp/main_page.md
Normal file
27
.new_docs/api_docs/cpp/main_page.md
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
# FastDeploy C++ API Summary
|
||||||
|
|
||||||
|
## Runtime
|
||||||
|
|
||||||
|
FastDeploy Runtime can be used as an inference engine with the same code, we can deploy Paddle/ONNX model on different device by different backends.
|
||||||
|
Currently, FastDeploy supported backends listed as below,
|
||||||
|
|
||||||
|
| Backend | Hardware | Support Model Format | Platform |
|
||||||
|
| :------ | :------- | :------------------- | :------- |
|
||||||
|
| Paddle Inference | CPU/Nvidia GPU | Paddle | Windows(x64)/Linux(x64) |
|
||||||
|
| ONNX Runtime | CPU/Nvidia GPU | Paddle/ONNX | Windows(x64)/Linux(x64/aarch64)/Mac(x86/arm64) |
|
||||||
|
| TensorRT | Nvidia GPU | Paddle/ONNX | Windows(x64)/Linux(x64)/Jetson |
|
||||||
|
| OpenVINO | CPU | Paddle/ONNX | Windows(x64)/Linux(x64)/Mac(x86) |
|
||||||
|
|
||||||
|
### Example code
|
||||||
|
- [Python examples](./)
|
||||||
|
- [C++ examples](./)
|
||||||
|
|
||||||
|
### Related APIs
|
||||||
|
- [RuntimeOption](./structfastdeploy_1_1RuntimeOption.html)
|
||||||
|
- [Runtime](./structfastdeploy_1_1Runtime.html)
|
||||||
|
|
||||||
|
## Vision Models
|
||||||
|
|
||||||
|
| Task | Model | API | Example |
|
||||||
|
| :---- | :---- | :---- | :----- |
|
||||||
|
| object detection | PaddleDetection/PPYOLOE | [fastdeploy::vision::detection::PPYOLOE](./classfastdeploy_1_1vision_1_1detection_1_1PPYOLOE.html) | [C++](./)/[Python](./) |
|
20
.new_docs/api_docs/python/Makefile
Normal file
20
.new_docs/api_docs/python/Makefile
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# Minimal makefile for Sphinx documentation
|
||||||
|
#
|
||||||
|
|
||||||
|
# You can set these variables from the command line, and also
|
||||||
|
# from the environment for the first two.
|
||||||
|
SPHINXOPTS ?=
|
||||||
|
SPHINXBUILD ?= sphinx-build
|
||||||
|
SOURCEDIR = .
|
||||||
|
BUILDDIR = _build
|
||||||
|
|
||||||
|
# Put it first so that "make" without argument is like "make help".
|
||||||
|
help:
|
||||||
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||||
|
|
||||||
|
.PHONY: help Makefile
|
||||||
|
|
||||||
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||||
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||||
|
%: Makefile
|
||||||
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
9
.new_docs/api_docs/python/README.md
Normal file
9
.new_docs/api_docs/python/README.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# Python API
|
||||||
|
|
||||||
|
This directory help to generate Python API documents for FastDeploy.
|
||||||
|
|
||||||
|
1. First, to generate the latest api documents, you need to install the latest FastDeploy, refer [build and install](en/build_and_install) to build FastDeploy python wheel package with the latest code.
|
||||||
|
2. After installed FastDeploy in your python environment, there are some dependencies need to install, execute command `pip install -r requirements.txt` in this directory
|
||||||
|
3. Execute command `make html` to generate API documents
|
||||||
|
|
||||||
|
After all the step done, use browser open `_build/html/index.html`.
|
76
.new_docs/api_docs/python/conf.py
Normal file
76
.new_docs/api_docs/python/conf.py
Normal file
@@ -0,0 +1,76 @@
|
|||||||
|
# Configuration file for the Sphinx documentation builder.
|
||||||
|
#
|
||||||
|
# This file only contains a selection of the most common options. For a full
|
||||||
|
# list see the documentation:
|
||||||
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||||
|
|
||||||
|
# -- Path setup --------------------------------------------------------------
|
||||||
|
|
||||||
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||||
|
#
|
||||||
|
# import os
|
||||||
|
# import sys
|
||||||
|
# sys.path.insert(0, os.path.abspath('../python'))
|
||||||
|
from recommonmark.transform import AutoStructify
|
||||||
|
from recommonmark.parser import CommonMarkParser
|
||||||
|
|
||||||
|
# -- Project information -----------------------------------------------------
|
||||||
|
|
||||||
|
project = 'FastDeploy Python API'
|
||||||
|
copyright = '2022, PaddlePaddle'
|
||||||
|
author = 'PaddlePaddle'
|
||||||
|
|
||||||
|
|
||||||
|
# The full version, including alpha/beta/rc tags
|
||||||
|
release = "latest"
|
||||||
|
# -- General configuration ---------------------------------------------------
|
||||||
|
# Add any Sphinx extension module names here, as strings. They can be
|
||||||
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||||
|
# ones.
|
||||||
|
extensions = [
|
||||||
|
'sphinx.ext.napoleon',
|
||||||
|
'myst_parser',
|
||||||
|
'sphinx.ext.autodoc',
|
||||||
|
'sphinx.ext.mathjax',
|
||||||
|
'sphinx_markdown_tables',
|
||||||
|
'sphinx.ext.viewcode'
|
||||||
|
]
|
||||||
|
|
||||||
|
autoclass_content = 'both'
|
||||||
|
package_dir = {"": ["python"]}
|
||||||
|
suppress_warnings = [ 'ref.myst']
|
||||||
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
|
templates_path = ['_templates']
|
||||||
|
# The suffix(es) of source filenames.
|
||||||
|
# You can specify multiple suffix as a list of string:
|
||||||
|
#
|
||||||
|
source_parsers = {'.md': CommonMarkParser}
|
||||||
|
# two wr style: reStructuredText/MarkDown
|
||||||
|
source_suffix = ['.rst', '.md']
|
||||||
|
# The master toctree document.
|
||||||
|
master_doc = 'index'
|
||||||
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
|
# for a list of supported languages.
|
||||||
|
#
|
||||||
|
# This is also used if you do content translation via gettext catalogs.
|
||||||
|
# Usually you set "language" from the command line for these cases.
|
||||||
|
language = "en"
|
||||||
|
# List of patterns, relative to source directory, that match files and
|
||||||
|
# directories to ignore when looking for source files.
|
||||||
|
# This pattern also affects html_static_path and html_extra_path.
|
||||||
|
exclude_patterns = []
|
||||||
|
# -- Options for HTML output -------------------------------------------------
|
||||||
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
|
# a list of builtin themes.
|
||||||
|
#
|
||||||
|
html_theme = 'furo'
|
||||||
|
|
||||||
|
# -- Extension configuration -------------------------------------------------
|
||||||
|
def setup(app):
|
||||||
|
app.add_config_value('recommonmark_config', {
|
||||||
|
'enable_eval_rst': True,
|
||||||
|
'enable_auto_toc_tree': False,
|
||||||
|
}, True)
|
||||||
|
app.add_transform(AutoStructify)
|
9
.new_docs/api_docs/python/image_classification.md
Normal file
9
.new_docs/api_docs/python/image_classification.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# Image Classification API
|
||||||
|
|
||||||
|
## fastdeploy.vision.classification.PaddleClasModel
|
||||||
|
|
||||||
|
```{eval-rst}
|
||||||
|
.. autoclass:: fastdeploy.vision.classification.PaddleClasModel
|
||||||
|
:members:
|
||||||
|
:inherited-members:
|
||||||
|
```
|
20
.new_docs/api_docs/python/index.rst
Normal file
20
.new_docs/api_docs/python/index.rst
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
FastDeploy
|
||||||
|
=======================================
|
||||||
|
|
||||||
|
* GitHub Repository: https://github.com/PaddlePaddle/FastDeploy
|
||||||
|
|
||||||
|
* Issue Feedback: http://www.github.com/PaddlePaddle/FastDeploy/issues
|
||||||
|
|
||||||
|
* Contact Us: fastdeploy@baidu.com
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:caption: 文档目录
|
||||||
|
:maxdepth: 2
|
||||||
|
:titlesonly:
|
||||||
|
|
||||||
|
object_detection.md
|
||||||
|
ocr.md
|
||||||
|
semantic_segmentation.md
|
||||||
|
image_classification.md
|
||||||
|
keypoint_detection.md
|
||||||
|
matting.md
|
3
.new_docs/api_docs/python/keypoint_detection.md
Normal file
3
.new_docs/api_docs/python/keypoint_detection.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Keypoint Detection API
|
||||||
|
|
||||||
|
comming soon...
|
35
.new_docs/api_docs/python/make.bat
Normal file
35
.new_docs/api_docs/python/make.bat
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
@ECHO OFF
|
||||||
|
|
||||||
|
pushd %~dp0
|
||||||
|
|
||||||
|
REM Command file for Sphinx documentation
|
||||||
|
|
||||||
|
if "%SPHINXBUILD%" == "" (
|
||||||
|
set SPHINXBUILD=sphinx-build
|
||||||
|
)
|
||||||
|
set SOURCEDIR=.
|
||||||
|
set BUILDDIR=_build
|
||||||
|
|
||||||
|
if "%1" == "" goto help
|
||||||
|
|
||||||
|
%SPHINXBUILD% >NUL 2>NUL
|
||||||
|
if errorlevel 9009 (
|
||||||
|
echo.
|
||||||
|
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
||||||
|
echo.installed, then set the SPHINXBUILD environment variable to point
|
||||||
|
echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
||||||
|
echo.may add the Sphinx directory to PATH.
|
||||||
|
echo.
|
||||||
|
echo.If you don't have Sphinx installed, grab it from
|
||||||
|
echo.http://sphinx-doc.org/
|
||||||
|
exit /b 1
|
||||||
|
)
|
||||||
|
|
||||||
|
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||||
|
goto end
|
||||||
|
|
||||||
|
:help
|
||||||
|
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
|
||||||
|
|
||||||
|
:end
|
||||||
|
popd
|
3
.new_docs/api_docs/python/matting.md
Normal file
3
.new_docs/api_docs/python/matting.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Matting API
|
||||||
|
|
||||||
|
comming soon...
|
65
.new_docs/api_docs/python/object_detection.md
Normal file
65
.new_docs/api_docs/python/object_detection.md
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
# Object Detection API
|
||||||
|
|
||||||
|
## fastdeploy.vision.detection.PPYOLOE
|
||||||
|
|
||||||
|
```{eval-rst}
|
||||||
|
.. autoclass:: fastdeploy.vision.detection.PPYOLOE
|
||||||
|
:members:
|
||||||
|
:inherited-members:
|
||||||
|
```
|
||||||
|
|
||||||
|
## fastdeploy.vision.detection.PPYOLO
|
||||||
|
|
||||||
|
```{eval-rst}
|
||||||
|
.. autoclass:: fastdeploy.vision.detection.PPYOLO
|
||||||
|
:members:
|
||||||
|
:inherited-members:
|
||||||
|
```
|
||||||
|
|
||||||
|
## fastdeploy.vision.detection.PPYOLOv2
|
||||||
|
|
||||||
|
```{eval-rst}
|
||||||
|
.. autoclass:: fastdeploy.vision.detection.PPYOLOv2
|
||||||
|
:members:
|
||||||
|
:inherited-members:
|
||||||
|
```
|
||||||
|
|
||||||
|
## fastdeploy.vision.detection.PicoDet
|
||||||
|
|
||||||
|
```{eval-rst}
|
||||||
|
.. autoclass:: fastdeploy.vision.detection.PicoDet
|
||||||
|
:members:
|
||||||
|
:inherited-members:
|
||||||
|
```
|
||||||
|
|
||||||
|
## fastdeploy.vision.detection.PaddleYOLOX
|
||||||
|
|
||||||
|
```{eval-rst}
|
||||||
|
.. autoclass:: fastdeploy.vision.detection.PaddleYOLOX
|
||||||
|
:members:
|
||||||
|
:inherited-members:
|
||||||
|
```
|
||||||
|
|
||||||
|
## fastdeploy.vision.detection.YOLOv3
|
||||||
|
|
||||||
|
```{eval-rst}
|
||||||
|
.. autoclass:: fastdeploy.vision.detection.PaddleYOLOX
|
||||||
|
:members:
|
||||||
|
:inherited-members:
|
||||||
|
```
|
||||||
|
|
||||||
|
## fastdeploy.vision.detection.FasterRCNN
|
||||||
|
|
||||||
|
```{eval-rst}
|
||||||
|
.. autoclass:: fastdeploy.vision.detection.FasterRCNN
|
||||||
|
:members:
|
||||||
|
:inherited-members:
|
||||||
|
```
|
||||||
|
|
||||||
|
## fastdeploy.vision.detection.MaskRCNN
|
||||||
|
|
||||||
|
```{eval-rst}
|
||||||
|
.. autoclass:: fastdeploy.vision.detection.MaskRCNN
|
||||||
|
:members:
|
||||||
|
:inherited-members:
|
||||||
|
```
|
3
.new_docs/api_docs/python/ocr.md
Normal file
3
.new_docs/api_docs/python/ocr.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# OCR API
|
||||||
|
|
||||||
|
comming soon...
|
5
.new_docs/api_docs/python/requirements.txt
Normal file
5
.new_docs/api_docs/python/requirements.txt
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
sphinx
|
||||||
|
recommonmark
|
||||||
|
sphinx_markdown_tables
|
||||||
|
sphinx_rtd_theme
|
||||||
|
furo
|
3
.new_docs/api_docs/python/semantic_segmentation.md
Normal file
3
.new_docs/api_docs/python/semantic_segmentation.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Semantic Segmentation API
|
||||||
|
|
||||||
|
comming soon...
|
Reference in New Issue
Block a user