From 6a709be23151912de4b67aa4e38b8b1d9ba9a8ef Mon Sep 17 00:00:00 2001 From: Tianlong Ai <50650583+AI-Tianlong@users.noreply.github.com> Date: Fri, 5 Jan 2024 10:28:01 +0800 Subject: [PATCH] [Docs] Optimize Home page format (#3483) # Optimized home page format for easier reading ## English version: ### Before: ![image](https://github.com/open-mmlab/mmsegmentation/assets/50650583/8d077bb7-0179-4e17-970a-87a4877a7b6e) ### After: ![image](https://github.com/open-mmlab/mmsegmentation/assets/50650583/68b26ff0-4c32-47e7-a105-73c29ceb19c9) ![image](https://github.com/open-mmlab/mmsegmentation/assets/50650583/88c9bb96-3fa4-4923-8ae4-9db28bf4eb4a) ## Chineses version ### Before: ![image](https://github.com/open-mmlab/mmsegmentation/assets/50650583/7821cc05-755f-47ef-9ffe-f5d839ee0b6d) ### After: ![image](https://github.com/open-mmlab/mmsegmentation/assets/50650583/f67100cc-6066-4cfa-b4b7-c99a15e4d7a2) --- README.md | 380 ++++++++++++++++++++++++++++++------------------ README_zh-CN.md | 380 ++++++++++++++++++++++++++++++------------------ 2 files changed, 474 insertions(+), 286 deletions(-) diff --git a/README.md b/README.md index 5d63f49279..fae3654f8e 100644 --- a/README.md +++ b/README.md @@ -118,154 +118,248 @@ To migrate from MMSegmentation 0.x, please refer to [migration](docs/en/migratio ## Tutorial -
-Get Started - -- [MMSeg overview](docs/en/overview.md) -- [MMSeg Installation](docs/en/get_started.md) -- [FAQ](docs/en/notes/faq.md) - -
- -
-MMSeg Basic Tutorial - -- [Tutorial 1: Learn about Configs](docs/en/user_guides/1_config.md) -- [Tutorial 2: Prepare datasets](docs/en/user_guides/2_dataset_prepare.md) -- [Tutorial 3: Inference with existing models](docs/en/user_guides/3_inference.md) -- [Tutorial 4: Train and test with existing models](docs/en/user_guides/4_train_test.md) -- [Tutorial 5: Model deployment](docs/en/user_guides/5_deployment.md) -- [Deploy mmsegmentation on Jetson platform](docs/zh_cn/user_guides/deploy_jetson.md) -- [Useful Tools](docs/en/user_guides/useful_tools.md) -- [Feature Map Visualization](docs/en/user_guides/visualization_feature_map.md) -- [Visualization](docs/en/user_guides/visualization.md) - -
- -
-MMSeg Detail Tutorial - -- [MMSeg Dataset](docs/en/advanced_guides/datasets.md) -- [MMSeg Models](docs/en/advanced_guides/models.md) -- [MMSeg Dataset Structures](docs/en/advanced_guides/structures.md) -- [MMSeg Data Transforms](docs/en/advanced_guides/transforms.md) -- [MMSeg Dataflow](docs/en/advanced_guides/data_flow.md) -- [MMSeg Training Engine](docs/en/advanced_guides/engine.md) -- [MMSeg Evaluation](docs/en/advanced_guides/evaluation.md) - -
- -
-MMSeg Development Tutorial - -- [Add New Datasets](docs/en/advanced_guides/add_datasets.md) -- [Add New Metrics](docs/en/advanced_guides/add_metrics.md) -- [Add New Modules](docs/en/advanced_guides/add_models.md) -- [Add New Data Transforms](docs/en/advanced_guides/add_transforms.md) -- [Customize Runtime Settings](docs/en/advanced_guides/customize_runtime.md) -- [Training Tricks](docs/en/advanced_guides/training_tricks.md) -- [Contribute code to MMSeg](.github/CONTRIBUTING.md) -- [Contribute a standard dataset in projects](docs/zh_cn/advanced_guides/contribute_dataset.md) -- [NPU (HUAWEI Ascend)](docs/en/device/npu.md) -- [0.x → 1.x migration](docs/en/migration/interface.md)，[0.x → 1.x package](docs/en/migration/package.md) - -
+
+ MMSegmentation Tutorials +
+ + + + + + + + + + + + + + + +
+ Get Started + + MMSeg Basic Tutorial + + MMSeg Detail Tutorial + + MMSeg Development Tutorial +
+ + + + + + + +
## Benchmark and model zoo Results and models are available in the [model zoo](docs/en/model_zoo.md). -
-Supported backbones: - -- [x] ResNet (CVPR'2016) -- [x] ResNeXt (CVPR'2017) -- [x] [HRNet (CVPR'2019)](configs/hrnet) -- [x] [ResNeSt (ArXiv'2020)](configs/resnest) -- [x] [MobileNetV2 (CVPR'2018)](configs/mobilenet_v2) -- [x] [MobileNetV3 (ICCV'2019)](configs/mobilenet_v3) -- [x] [Vision Transformer (ICLR'2021)](configs/vit) -- [x] [Swin Transformer (ICCV'2021)](configs/swin) -- [x] [Twins (NeurIPS'2021)](configs/twins) -- [x] [BEiT (ICLR'2022)](configs/beit) -- [x] [ConvNeXt (CVPR'2022)](configs/convnext) -- [x] [MAE (CVPR'2022)](configs/mae) -- [x] [PoolFormer (CVPR'2022)](configs/poolformer) -- [x] [SegNeXt (NeurIPS'2022)](configs/segnext) - -
- -
-Supported methods: - -- [x] [SAN (CVPR'2023)](configs/san/) -- [x] [VPD (ICCV'2023)](configs/vpd) -- [x] [DDRNet (T-ITS'2022)](configs/ddrnet) -- [x] [PIDNet (ArXiv'2022)](configs/pidnet) -- [x] [Mask2Former (CVPR'2022)](configs/mask2former) -- [x] [MaskFormer (NeurIPS'2021)](configs/maskformer) -- [x] [K-Net (NeurIPS'2021)](configs/knet) -- [x] [SegFormer (NeurIPS'2021)](configs/segformer) -- [x] [Segmenter (ICCV'2021)](configs/segmenter) -- [x] [DPT (ArXiv'2021)](configs/dpt) -- [x] [SETR (CVPR'2021)](configs/setr) -- [x] [STDC (CVPR'2021)](configs/stdc) -- [x] [BiSeNetV2 (IJCV'2021)](configs/bisenetv2) -- [x] [CGNet (TIP'2020)](configs/cgnet) -- [x] [PointRend (CVPR'2020)](configs/point_rend) -- [x] [DNLNet (ECCV'2020)](configs/dnlnet) -- [x] [OCRNet (ECCV'2020)](configs/ocrnet) -- [x] [ISANet (ArXiv'2019/IJCV'2021)](configs/isanet) -- [x] [Fast-SCNN (ArXiv'2019)](configs/fastscnn) -- [x] [FastFCN (ArXiv'2019)](configs/fastfcn) -- [x] [GCNet (ICCVW'2019/TPAMI'2020)](configs/gcnet) -- [x] [ANN (ICCV'2019)](configs/ann) -- [x] [EMANet (ICCV'2019)](configs/emanet) -- [x] [CCNet (ICCV'2019)](configs/ccnet) -- [x] [DMNet (ICCV'2019)](configs/dmnet) -- [x] [Semantic FPN (CVPR'2019)](configs/sem_fpn) -- [x] [DANet (CVPR'2019)](configs/danet) -- [x] [APCNet (CVPR'2019)](configs/apcnet) -- [x] [NonLocal Net (CVPR'2018)](configs/nonlocal_net) -- [x] [EncNet (CVPR'2018)](configs/encnet) -- [x] [DeepLabV3+ (CVPR'2018)](configs/deeplabv3plus) -- [x] [UPerNet (ECCV'2018)](configs/upernet) -- [x] [ICNet (ECCV'2018)](configs/icnet) -- [x] [PSANet (ECCV'2018)](configs/psanet) -- [x] [BiSeNetV1 (ECCV'2018)](configs/bisenetv1) -- [x] [DeepLabV3 (ArXiv'2017)](configs/deeplabv3) -- [x] [PSPNet (CVPR'2017)](configs/pspnet) -- [x] [ERFNet (T-ITS'2017)](configs/erfnet) -- [x] [UNet (MICCAI'2016/Nat. Methods'2019)](configs/unet) -- [x] [FCN (CVPR'2015/TPAMI'2017)](configs/fcn) - -
- -
-Supported datasets: - -- [x] [Cityscapes](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#cityscapes) -- [x] [PASCAL VOC](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#pascal-voc) -- [x] [ADE20K](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#ade20k) -- [x] [Pascal Context](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#pascal-context) -- [x] [COCO-Stuff 10k](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#coco-stuff-10k) -- [x] [COCO-Stuff 164k](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#coco-stuff-164k) -- [x] [CHASE_DB1](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#chase-db1) -- [x] [DRIVE](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#drive) -- [x] [HRF](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#hrf) -- [x] [STARE](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#stare) -- [x] [Dark Zurich](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#dark-zurich) -- [x] [Nighttime Driving](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#nighttime-driving) -- [x] [LoveDA](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#loveda) -- [x] [Potsdam](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#isprs-potsdam) -- [x] [Vaihingen](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#isprs-vaihingen) -- [x] [iSAID](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#isaid) -- [x] [Mapillary Vistas](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#mapillary-vistas-datasets) -- [x] [LEVIR-CD](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#levir-cd) -- [x] [BDD100K](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#bdd100K) -- [x] [NYU](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#nyu) - -
+
+ Overview +
+ + + + + + + + + + + + + + + + +
+ Supported backbones + + Supported methods + + Supported Head + + Supported datasets + + Other +
+ + + + + + + + + +
Please refer to [FAQ](docs/en/notes/faq.md) for frequently asked questions. diff --git a/README_zh-CN.md b/README_zh-CN.md index fa4c82a280..7a3e3ada72 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -107,154 +107,248 @@ MMSegmentation v1.x 在 0.x 版本的基础上有了显著的提升，提供了 ## 教程文档 -
-开启 MMSeg 之旅 - -- [MMSeg 概述](docs/zh_cn/overview.md) -- [安装和验证](docs/zh_cn/get_started.md) -- [常见问题解答](docs/zh_cn/notes/faq.md) - -
- -
-MMSeg 快速入门教程 - -- [教程1：了解配置文件](docs/zh_cn/user_guides/1_config.md) -- [教程2：准备数据集](docs/zh_cn/user_guides/2_dataset_prepare.md) -- [教程3：使用预训练模型推理](docs/zh_cn/user_guides/3_inference.md) -- [教程4：使用现有模型进行训练和测试](docs/zh_cn/user_guides/4_train_test.md) -- [教程5：模型部署](docs/zh_cn/user_guides/5_deployment.md) -- [在 Jetson 平台部署 mmsegmentation](docs/zh_cn/user_guides/deploy_jetson.md) -- [常用工具](docs/zh_cn/user_guides/useful_tools.md) -- [特征图可视化](docs/zh_cn/user_guides/visualization_feature_map.md) -- [可视化](docs/zh_cn/user_guides/visualization.md) - -
- -
-MMSeg 细节介绍 - -- [MMSeg 数据集介绍](docs/zh_cn/advanced_guides/datasets.md) -- [MMSeg 模型介绍](docs/zh_cn/advanced_guides/models.md) -- [MMSeg 数据结构介绍](docs/zh_cn/advanced_guides/structures.md) -- [MMSeg 数据增强介绍](docs/zh_cn/advanced_guides/transforms.md) -- [MMSeg 数据流介绍](docs/zh_cn/advanced_guides/data_flow.md) -- [MMSeg 训练引擎介绍](docs/zh_cn/advanced_guides/engine.md) -- [MMSeg 模型评测介绍](docs/zh_cn/advanced_guides/evaluation.md) - -
- -
-MMSeg 开发教程 - -- [新增自定义数据集](docs/zh_cn/advanced_guides/add_datasets.md) -- [新增评测指标](docs/zh_cn/advanced_guides/add_metrics.md) -- [新增自定义模型](docs/zh_cn/advanced_guides/add_models.md) -- [新增自定义数据增强](docs/zh_cn/advanced_guides/add_transforms.md) -- [自定义运行设定](docs/zh_cn/advanced_guides/customize_runtime.md) -- [训练技巧](docs/zh_cn/advanced_guides/training_tricks.md) -- [如何给 MMSeg贡献代码](.github/CONTRIBUTING.md) -- [在 projects 给 MMSeg 贡献一个标准数据集](docs/zh_cn/advanced_guides/contribute_dataset.md) -- [NPU (华为 昇腾)](docs/zh_cn/device/npu.md) -- [0.x → 1.x 迁移文档](docs/zh_cn/migration/interface.md)，[0.x → 1.x 库变更文档](docs/zh_cn/migration/package.md) - -
+
+ mmsegmentation 教程文档 +
+ + + + + + + + + + + + + + + +
+ 开启 MMSeg 之旅 + + MMSeg 快速入门教程 + + MMSeg 细节介绍 + + MMSeg 开发教程 +
+ + + + + + + +
## 基准测试和模型库 测试结果和模型可以在[模型库](docs/zh_cn/model_zoo.md)中找到。 -
-已支持的骨干网络： - -- [x] ResNet (CVPR'2016) -- [x] ResNeXt (CVPR'2017) -- [x] [HRNet (CVPR'2019)](configs/hrnet) -- [x] [ResNeSt (ArXiv'2020)](configs/resnest) -- [x] [MobileNetV2 (CVPR'2018)](configs/mobilenet_v2) -- [x] [MobileNetV3 (ICCV'2019)](configs/mobilenet_v3) -- [x] [Vision Transformer (ICLR'2021)](configs/vit) -- [x] [Swin Transformer (ICCV'2021)](configs/swin) -- [x] [Twins (NeurIPS'2021)](configs/twins) -- [x] [BEiT (ICLR'2022)](configs/beit) -- [x] [ConvNeXt (CVPR'2022)](configs/convnext) -- [x] [MAE (CVPR'2022)](configs/mae) -- [x] [PoolFormer (CVPR'2022)](configs/poolformer) -- [x] [SegNeXt (NeurIPS'2022)](configs/segnext) - -
- -
-已支持的算法： - -- [x] [SAN (CVPR'2023)](configs/san/) -- [x] [VPD (ICCV'2023)](configs/vpd) -- [x] [DDRNet (T-ITS'2022)](configs/ddrnet) -- [x] [PIDNet (ArXiv'2022)](configs/pidnet) -- [x] [Mask2Former (CVPR'2022)](configs/mask2former) -- [x] [MaskFormer (NeurIPS'2021)](configs/maskformer) -- [x] [K-Net (NeurIPS'2021)](configs/knet) -- [x] [SegFormer (NeurIPS'2021)](configs/segformer) -- [x] [Segmenter (ICCV'2021)](configs/segmenter) -- [x] [DPT (ArXiv'2021)](configs/dpt) -- [x] [SETR (CVPR'2021)](configs/setr) -- [x] [STDC (CVPR'2021)](configs/stdc) -- [x] [BiSeNetV2 (IJCV'2021)](configs/bisenetv2) -- [x] [CGNet (TIP'2020)](configs/cgnet) -- [x] [PointRend (CVPR'2020)](configs/point_rend) -- [x] [DNLNet (ECCV'2020)](configs/dnlnet) -- [x] [OCRNet (ECCV'2020)](configs/ocrnet) -- [x] [ISANet (ArXiv'2019/IJCV'2021)](configs/isanet) -- [x] [Fast-SCNN (ArXiv'2019)](configs/fastscnn) -- [x] [FastFCN (ArXiv'2019)](configs/fastfcn) -- [x] [GCNet (ICCVW'2019/TPAMI'2020)](configs/gcnet) -- [x] [ANN (ICCV'2019)](configs/ann) -- [x] [EMANet (ICCV'2019)](configs/emanet) -- [x] [CCNet (ICCV'2019)](configs/ccnet) -- [x] [DMNet (ICCV'2019)](configs/dmnet) -- [x] [Semantic FPN (CVPR'2019)](configs/sem_fpn) -- [x] [DANet (CVPR'2019)](configs/danet) -- [x] [APCNet (CVPR'2019)](configs/apcnet) -- [x] [NonLocal Net (CVPR'2018)](configs/nonlocal_net) -- [x] [EncNet (CVPR'2018)](configs/encnet) -- [x] [DeepLabV3+ (CVPR'2018)](configs/deeplabv3plus) -- [x] [UPerNet (ECCV'2018)](configs/upernet) -- [x] [ICNet (ECCV'2018)](configs/icnet) -- [x] [PSANet (ECCV'2018)](configs/psanet) -- [x] [BiSeNetV1 (ECCV'2018)](configs/bisenetv1) -- [x] [DeepLabV3 (ArXiv'2017)](configs/deeplabv3) -- [x] [PSPNet (CVPR'2017)](configs/pspnet) -- [x] [ERFNet (T-ITS'2017)](configs/erfnet) -- [x] [UNet (MICCAI'2016/Nat. Methods'2019)](configs/unet) -- [x] [FCN (CVPR'2015/TPAMI'2017)](configs/fcn) - -
- -
-已支持的数据集： - -- [x] [Cityscapes](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#cityscapes) -- [x] [PASCAL VOC](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#pascal-voc) -- [x] [ADE20K](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#ade20k) -- [x] [Pascal Context](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#pascal-context) -- [x] [COCO-Stuff 10k](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#coco-stuff-10k) -- [x] [COCO-Stuff 164k](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#coco-stuff-164k) -- [x] [CHASE_DB1](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#chase-db1) -- [x] [DRIVE](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#drive) -- [x] [HRF](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#hrf) -- [x] [STARE](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#stare) -- [x] [Dark Zurich](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#dark-zurich) -- [x] [Nighttime Driving](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#nighttime-driving) -- [x] [LoveDA](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#loveda) -- [x] [Potsdam](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#isprs-potsdam) -- [x] [Vaihingen](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#isprs-vaihingen) -- [x] [iSAID](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#isaid) -- [x] [Mapillary Vistas](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#mapillary-vistas-datasets) -- [x] [LEVIR-CD](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#levir-cd) -- [x] [BDD100K](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/zh_cn/user_guides/2_dataset_prepare.md#bdd100K) -- [x] [NYU](https://github.com/open-mmlab/mmsegmentation/blob/main/docs/en/user_guides/2_dataset_prepare.md#nyu) - -
+
+ 概览 +
+ + + + + + + + + + + + + + + + +
+ 已支持的主干网络 + + 已支持的算法架构 + + 已支持的分割头 + + 已支持的数据集 + + 其他 +
+ + + + + + + + + +
如果遇到问题，请参考 [常见问题解答](docs/zh_cn/notes/faq.md)。