diff --git a/docs/en/basic_concepts/convention.md b/docs/en/basic_concepts/convention.md index 5779a325..4964cacb 100644 --- a/docs/en/basic_concepts/convention.md +++ b/docs/en/basic_concepts/convention.md @@ -1,3 +1,3 @@ -# Convention +# Convention\[coming soon\] Coming Soon! diff --git a/docs/en/basic_concepts/data_flow.md b/docs/en/basic_concepts/data_flow.md index a105511d..11957fa1 100644 --- a/docs/en/basic_concepts/data_flow.md +++ b/docs/en/basic_concepts/data_flow.md @@ -1,3 +1,3 @@ -# Data Flow +# Data Flow\[coming soon\] Coming Soon! diff --git a/docs/en/basic_concepts/datasets.md b/docs/en/basic_concepts/datasets.md index 8c1061cb..183b6328 100644 --- a/docs/en/basic_concepts/datasets.md +++ b/docs/en/basic_concepts/datasets.md @@ -1,3 +1,3 @@ -# Datasets +# Datasets\[coming soon\] Coming Soon! diff --git a/docs/en/basic_concepts/engine.md b/docs/en/basic_concepts/engine.md index 4e527ba7..a113015a 100644 --- a/docs/en/basic_concepts/engine.md +++ b/docs/en/basic_concepts/engine.md @@ -1,3 +1,3 @@ -# Engine +# Engine\[coming soon\] Coming Soon! diff --git a/docs/en/basic_concepts/models.md b/docs/en/basic_concepts/models.md index 71186aa8..7eab561e 100644 --- a/docs/en/basic_concepts/models.md +++ b/docs/en/basic_concepts/models.md @@ -1,3 +1,3 @@ -# Models +# Models\[coming soon\] Coming Soon! diff --git a/docs/en/basic_concepts/overview.md b/docs/en/basic_concepts/overview.md index 7f583f54..9e31fefa 100644 --- a/docs/en/basic_concepts/overview.md +++ b/docs/en/basic_concepts/overview.md @@ -1,3 +1,3 @@ -# Overview & Features +# Overview & Features\[coming soon\] Coming Soon! diff --git a/docs/en/basic_concepts/visualizers.md b/docs/en/basic_concepts/visualizers.md index 8086c9d1..bf620e1b 100644 --- a/docs/en/basic_concepts/visualizers.md +++ b/docs/en/basic_concepts/visualizers.md @@ -1,3 +1,3 @@ -# Visualizers +# Visualizers\[coming soon\] Coming Soon! diff --git a/docs/en/migration/overview.md b/docs/en/migration/overview.md index 77630605..fd431262 100644 --- a/docs/en/migration/overview.md +++ b/docs/en/migration/overview.md @@ -7,3 +7,11 @@ Next, please read the sections according to your requirements. - If you want to migrate a model trained in version 0.x to use it directly in version 1.0, please read [Pretrained Model Migration](./model.md). - If you want to train the model, please read [Dataset Migration](./dataset.md) and [Data Transform Migration](./transforms.md). - If you want to develop on MMOCR, please read [Code Migration](code.md) and [Upstream Library Changes](https://github.com/open-mmlab/mmengine/tree/main/docs/en/migration). + +```{note} +It should be noted that MMOCR 1.0 depends on the new foundational library for training deep learning models [MMEngine](https://github.com/open-mmlab/mmengine). Therefore, you need to create a new python environment to install the dependencies for MMOCR 1.0. We provide a detailed [installation guide](../get_started/install.md) for reference. +``` + +As shown in the following figure, the maintenance plan of MMOCR 1.x version is mainly divided into three stages, namely "Public Beta Period", "Compatibility Period" and "Maintenance Period". For old versions, we will no longer add major new features. Therefore, we strongly recommend users to migrate to MMOCR 1.x version as soon as possible. + +![plan](https://user-images.githubusercontent.com/45810070/192927112-70c0108d-58ed-4c77-8a0a-9d9685a48333.png) diff --git a/docs/zh_cn/basic_concepts/convention.md b/docs/zh_cn/basic_concepts/convention.md index 584b8eaf..a094becc 100644 --- a/docs/zh_cn/basic_concepts/convention.md +++ b/docs/zh_cn/basic_concepts/convention.md @@ -1,3 +1,3 @@ -# 开发默认约定 +# 开发默认约定\[待更新\] 待更新 diff --git a/docs/zh_cn/basic_concepts/data_flow.md b/docs/zh_cn/basic_concepts/data_flow.md index dadfa776..a07a158b 100644 --- a/docs/zh_cn/basic_concepts/data_flow.md +++ b/docs/zh_cn/basic_concepts/data_flow.md @@ -1,3 +1,3 @@ -# 数据流 +# 数据流\[待更新\] 待更新 diff --git a/docs/zh_cn/basic_concepts/datasets.md b/docs/zh_cn/basic_concepts/datasets.md index ace81ab7..cef1577a 100644 --- a/docs/zh_cn/basic_concepts/datasets.md +++ b/docs/zh_cn/basic_concepts/datasets.md @@ -1,3 +1,3 @@ -# 数据集 +# 数据集\[待更新\] 待更新 diff --git a/docs/zh_cn/basic_concepts/engine.md b/docs/zh_cn/basic_concepts/engine.md index 50f7dfdc..57cb62ae 100644 --- a/docs/zh_cn/basic_concepts/engine.md +++ b/docs/zh_cn/basic_concepts/engine.md @@ -1,3 +1,3 @@ -# 引擎 +# 引擎\[待更新\] 待更新 diff --git a/docs/zh_cn/basic_concepts/models.md b/docs/zh_cn/basic_concepts/models.md index 7c6155c6..7ec449d5 100644 --- a/docs/zh_cn/basic_concepts/models.md +++ b/docs/zh_cn/basic_concepts/models.md @@ -1,3 +1,3 @@ -# 模型 +# 模型\[待更新\] 待更新 diff --git a/docs/zh_cn/basic_concepts/overview.md b/docs/zh_cn/basic_concepts/overview.md index eb364962..bbd72139 100644 --- a/docs/zh_cn/basic_concepts/overview.md +++ b/docs/zh_cn/basic_concepts/overview.md @@ -1,3 +1,3 @@ -# 设计理念与特性 +# 设计理念与特性\[待更新\] 待更新 diff --git a/docs/zh_cn/basic_concepts/visualizers.md b/docs/zh_cn/basic_concepts/visualizers.md index 56620589..323dc0a2 100644 --- a/docs/zh_cn/basic_concepts/visualizers.md +++ b/docs/zh_cn/basic_concepts/visualizers.md @@ -1,3 +1,3 @@ -# 可视化组件 +# 可视化组件\[待更新\] 待更新 diff --git a/docs/zh_cn/migration/overview.md b/docs/zh_cn/migration/overview.md index 48d075cf..4692baa6 100644 --- a/docs/zh_cn/migration/overview.md +++ b/docs/zh_cn/migration/overview.md @@ -7,3 +7,11 @@ - 如果你需要把 0.x 版本中训练的模型直接迁移到 1.0 版本中使用，请阅读 [预训练模型迁移](./model.md) - 如果你需要训练模型，请阅读 [数据集迁移](./dataset.md) 和 [数据增强迁移](./transforms.md) - 如果你需要在 MMOCR 上进行开发，请阅读 [代码迁移](code.md) 和 [上游依赖库变更](https://github.com/open-mmlab/mmengine/tree/main/docs/zh_cn/migration) + +```{note} +需要注意的是，MMOCR 1.0 依赖于新的基础训练框架 [MMEngine](https://github.com/open-mmlab/mmengine)。因此，你需要创建新的 python 环境来安装 MMOCR 1.0 版本所需要的依赖库。我们提供了详细的[安装文档](../get_started/install.md)以供参考。 +``` + +如下图所示，MMOCR 1.x 版本的维护计划主要分为三个阶段，即“公测期”，“兼容期”以及“维护期”。对于旧版本，我们将不再增加主要新功能。因此，我们强烈建议用户尽早迁移至 MMOCR 1.x 版本。 + +![plan](https://user-images.githubusercontent.com/45810070/192678159-f8965f73-552b-48a1-bf65-659e8f519bdd.png)