read the doc
parent
7732a69f1b
commit
222e70e527
docs/zh_CN
advanced_tutorials
algorithm_introduction
data_preparation
faq_series
image_recognition_pipeline
inference_deployment
installation
models
models_training
others
quick_start
|
@ -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 = source
|
||||
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)
|
|
@ -0,0 +1,11 @@
|
|||
高级教程
|
||||
================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
model_prune_quantization.md
|
||||
knowledge_distillation.md
|
||||
how_to_contribute.md
|
||||
code_overview.md
|
||||
DataAugmentation.md
|
|
@ -0,0 +1,12 @@
|
|||
算法介绍
|
||||
================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
model_prune_quantization.md
|
||||
ImageNet_models.md
|
||||
metric_learning.md
|
||||
knowledge_distillation.md
|
||||
image_classification.md
|
||||
DataAugmentation.md
|
|
@ -0,0 +1,69 @@
|
|||
# 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('.'))
|
||||
import sphinx_rtd_theme
|
||||
from recommonmark.parser import CommonMarkParser
|
||||
#import sphinx-markdown-tables
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'PaddleClas'
|
||||
copyright = '2021, PaddleClas'
|
||||
author = 'PaddleClas'
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = '2.3.0'
|
||||
|
||||
|
||||
# -- 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.
|
||||
source_parsers = {
|
||||
'.md': CommonMarkParser,
|
||||
}
|
||||
source_suffix = ['.rst', '.md']
|
||||
extensions = [
|
||||
'recommonmark',
|
||||
'sphinx_markdown_tables'
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# 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 = 'zh_CN'
|
||||
|
||||
# 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 = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
|
||||
|
||||
# -- 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 = "sphinx_rtd_theme"
|
||||
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
||||
# 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,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
|
@ -0,0 +1,8 @@
|
|||
数据准备
|
||||
================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
recognition_dataset.md
|
||||
classification_dataset.md
|
|
@ -0,0 +1,10 @@
|
|||
FAQ系列
|
||||
================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
faq_2021_s2.md
|
||||
faq_2021_s1.md
|
||||
faq_selected_30.md
|
||||
faq_2020_s1.md
|
|
@ -0,0 +1,9 @@
|
|||
图像识别流程
|
||||
================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
vector_search.md
|
||||
mainbody_detection.md
|
||||
feature_extraction.md
|
|
@ -0,0 +1,23 @@
|
|||
欢迎使用PaddleClas图像分类库!
|
||||
================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
introduction/index
|
||||
installation/index
|
||||
quick_start/index
|
||||
image_recognition_pipeline/index
|
||||
data_preparation/index
|
||||
models_training/index
|
||||
inference_deployment/index
|
||||
models/index
|
||||
algorithm_introduction/index
|
||||
advanced_tutorials/index
|
||||
others/index
|
||||
faq_series/index
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
推理部署
|
||||
================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
paddle_serving_deploy.md
|
||||
whl_deploy.md
|
||||
cpp_deploy_on_windows.md
|
||||
python_deploy.md
|
||||
paddle_hub_serving_deploy.md
|
||||
cpp_deploy.md
|
||||
paddle_lite_deploy.md
|
||||
export_model.md
|
|
@ -0,0 +1,8 @@
|
|||
安装
|
||||
================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
install_paddle.md
|
||||
install_paddleclas.md
|
|
@ -0,0 +1,8 @@
|
|||
介绍
|
||||
================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
function_intro.md
|
||||
more_demo/index
|
|
@ -0,0 +1,11 @@
|
|||
介绍
|
||||
================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
cartoon.md
|
||||
logo.md
|
||||
more_demo.md
|
||||
product.md
|
||||
vehicle.md
|
|
@ -0,0 +1,35 @@
|
|||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=source
|
||||
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.https://www.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
|
|
@ -2,15 +2,29 @@
|
|||
================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
models_intro.md
|
||||
Tricks.md
|
||||
ResNet_and_vd.md
|
||||
Mobile.md
|
||||
SEResNext_and_Res2Net.md
|
||||
Inception.md
|
||||
HRNet.md
|
||||
:maxdepth: 2
|
||||
|
||||
DPN_DenseNet.md
|
||||
models_intro.md
|
||||
RepVGG.md
|
||||
EfficientNet_and_ResNeXt101_wsl.md
|
||||
ViT_and_DeiT.md
|
||||
SwinTransformer.md
|
||||
Tricks.md
|
||||
Others.md
|
||||
SEResNext_and_Res2Net.md
|
||||
ESNet.md
|
||||
HRNet.md
|
||||
ReXNet.md
|
||||
Inception.md
|
||||
TNT.md
|
||||
RedNet.md
|
||||
DLA.md
|
||||
ResNeSt_RegNet.md
|
||||
PP-LCNet.md
|
||||
HarDNet.md
|
||||
ResNet_and_vd.md
|
||||
LeViT.md
|
||||
Mobile.md
|
||||
MixNet.md
|
||||
Twins.md
|
||||
|
|
|
@ -0,0 +1,10 @@
|
|||
模型训练
|
||||
================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
config_description.md
|
||||
train_strategy.md
|
||||
classification.md
|
||||
recognition.md
|
|
@ -0,0 +1,15 @@
|
|||
其他
|
||||
================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
competition_support.md
|
||||
paddle_mobile_inference.md
|
||||
feature_visiualization.md
|
||||
VisualDL.md
|
||||
versions.md
|
||||
update_history.md
|
||||
train_on_xpu.md
|
||||
transfer_learning.md
|
||||
train_with_DALI.md
|
|
@ -0,0 +1,10 @@
|
|||
快速开始
|
||||
================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
quick_start_classification_new_user.md
|
||||
quick_start_classification_professional.md
|
||||
quick_start_recognition.md
|
||||
quick_start_multilabel_classification.md
|
|
@ -0,0 +1,64 @@
|
|||
import os
|
||||
|
||||
def file_name(file_dir):
|
||||
temp = []
|
||||
for root, dirs, files in os.walk(file_dir):
|
||||
print(dirs) #当前路径下所有子目录
|
||||
temp = dirs #存储需要的子目录
|
||||
break
|
||||
|
||||
# 删除不需要的子目录
|
||||
temp.remove('_templates')
|
||||
temp.remove('_build')
|
||||
temp.remove('_static')
|
||||
chinese_name = ['模型训练', '介绍', '图像识别流程', '其他', 'FAQ系列', '数据准备', '安装', '模型库', '高级教程', '算法介绍', '推理部署', '快速开始']
|
||||
# 写根目录下的rst文件
|
||||
with open('./index.rst', 'w') as f:
|
||||
f.write('欢迎使用PaddleClas图像分类库!\n')
|
||||
f.write('================================\n\n')
|
||||
f.write('.. toctree::\n')
|
||||
f.write(' :maxdepth: 1\n\n')
|
||||
for dir in temp:
|
||||
f.write(' ' + dir + '/index\n')
|
||||
f.close()
|
||||
|
||||
# 写各个子目录下的rst文件
|
||||
for dir in temp:
|
||||
for root, dirs, files in os.walk(dir):
|
||||
print(root) #当前目录路径
|
||||
if 'index.rst' in files:
|
||||
files.remove('index.rst')
|
||||
print(files) #当前路径下所有非目录子文件
|
||||
curDir = os.path.join(file_dir, dir)
|
||||
filename = curDir + '/index.rst'
|
||||
idx = temp.index(dir)
|
||||
ch_name = chinese_name[idx]
|
||||
with open(filename, 'w') as f:
|
||||
f.write(ch_name+'\n')
|
||||
f.write('================================\n\n')
|
||||
f.write('.. toctree::\n')
|
||||
f.write(' :maxdepth: 2\n\n')
|
||||
|
||||
for f1 in files:
|
||||
f.write(' ' + f1 + '\n')
|
||||
|
||||
f.close()
|
||||
|
||||
|
||||
def readfile(filename):
|
||||
file = open(filename)
|
||||
i = 0
|
||||
while 1:
|
||||
line = file.readline()
|
||||
print(i)
|
||||
print(line)
|
||||
i += 1
|
||||
if not line:
|
||||
break
|
||||
pass # do something
|
||||
file.close()
|
||||
|
||||
|
||||
file_name('./')
|
||||
#filename = './index.rst'
|
||||
#readfile(filename)
|
Loading…
Reference in New Issue