Skip to content

update inference model list in online docs #441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cn/inference/models_list.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## 推理 - MindOCR模型推理支持列表
## 推理 - MindOCR模型支持列表

MindOCR推理支持训练端ckpt导出的模型,本文档展示了已适配的模型列表。

Expand Down
2 changes: 1 addition & 1 deletion docs/cn/inference/models_list_thirdparty.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## 推理 - 第三方模型推理支持列表
## 推理 - 第三方模型支持列表

MindOCR可以支持第三方模型(如PaddleOCR、MMOCR等)的推理,本文档展示了已适配的模型列表。

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
---
hide:
- navigation
- toc
---

# Model Zoo
## 训练 - MindOCR模型支持列表

| model | type |dataset | fscore(detection)/accuracy(recognition) | mindocr recipe | vanilla mindspore
:-: | :-: | :-: | :-: | :-: | :-:
Expand Down
2 changes: 1 addition & 1 deletion docs/en/inference/model_perf_thirdparty.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Third-party Model Inference Performance Table

This document will give the inference performance of the third-party model (PaddleOCR, MMOCR, etc.) using the MindIR
This page shows the inference performance of the third-party model (PaddleOCR, MMOCR, etc.) using the MindIR
format after performing [model conversion](convert_tutorial.md).

### 1. Text detection
Expand Down
2 changes: 1 addition & 1 deletion docs/en/inference/models_list.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Inference - MindOCR Models Support List
## Inference - MindOCR Models List

MindOCR inference supports exported models from trained ckpt file, and this document displays a list of adapted models.

Expand Down
4 changes: 2 additions & 2 deletions docs/en/inference/models_list_thirdparty.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Inference - Third-party Models Support List
## Inference - Third-party Models List

MindOCR can support the inference of third-party models (PaddleOCR, MMOCR, etc.), and this document displays a list of
MindOCR supports the inference of third-party models (PaddleOCR, MMOCR, etc.), and this document displays a list of
adapted models.

After downloading the model file, it needs to be converted to a model file supported by ACL/MindSpore Lite inference (OM
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
---
hide:
- navigation
- toc
---

# 模型列表
## Training - MindOCR Models List

| model | type |dataset | fscore(detection)/accuracy(recognition) | mindocr recipe | vanilla mindspore
:-: | :-: | :-: | :-: | :-: | :-:
Expand Down
14 changes: 9 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,25 @@ copyright: Copyright © 2022 - 2023 MindSpore Lab
nav:
- Home: index.md
# - Installation: installation.md
- Model Zoo: mkdocs/modelzoo.md
- Model Zoo:
- 1. Training: mkdocs/modelzoo_training.md
- 2. Inference - MindOCR Models List: inference/models_list.md
- 3. Inference - Third-party Models List: inference/models_list_thirdparty.md
- Tutorials:
- Datasets:
- 1. Datasets:
- Dataset Preparation: datasets/converters.md
- Data Transformation Mechanism: tutorials/transform_tutorial.md
- Model Training:
- 2. Model Training:
- Yaml Configuration: tutorials/yaml_configuration.md
- Text Detection: tutorials/training_detection_custom_dataset.md
- Text Recognition: tutorials/training_recognition_custom_dataset.md
- Distributed Training on Ascend with OpenMPI/HCCL: tutorials/distribute_train.md
- Advance Training: tutorials/advanced_train.md
- Inference and Deployment:
- 3. Inference and Deployment:
# - Model Conversion: inference/convert_tutorial.md
- Python/C++ Inference on Ascend 310: inference/inference_tutorial.md
- Python Online Inference: mkdocs/online_inference.md
- Developer Guides:
- 4. Developer Guides:
- Customize Dataset: mkdocs/customize_dataset.md
- Customize Data Transformation: mkdocs/customize_data_transform.md
- Customize a New Model: mkdocs/customize_model.md
Expand Down Expand Up @@ -144,6 +147,7 @@ plugins:
Quick Start: 快速开始
Configuration: 配置
Finetune: 微调
Training: 训练
Inference: 推理
Deployment: 部署
Notes: 说明
Expand Down