mirror of
https://github.com/open-mmlab/mmsegmentation.git
synced 2025-06-03 22:03:48 +08:00
add readme of chinese version (#383)
This commit is contained in:
Kai Chen
GitHub
parent
45f07af4c8
commit
67d71504a7
@ -13,12 +13,14 @@
|
||||
|
||||
Documentation: https://mmsegmentation.readthedocs.io/
|
||||
|
||||
English | [简体中文](README_zh-CN.md)
|
||||
|
||||
## Introduction
|
||||
|
||||
MMSegmentation is an open source semantic segmentation toolbox based on PyTorch.
|
||||
It is a part of the OpenMMLab project.
|
||||
|
||||
The master branch works with **PyTorch 1.3 to 1.6**.
|
||||
The master branch works with **PyTorch 1.3+**.
|
||||
|
||||
|
||||
|
||||
@ -105,7 +107,7 @@ If you find this project useful in your research, please consider cite:
|
||||
|
||||
```latex
|
||||
@misc{mmseg2020,
|
||||
title={MMSegmentation, an Open Source Semantic Segmentation Toolbox},
|
||||
title={{MMSegmentation}: OpenMMLab Semantic Segmentation Toolbox and Benchmark},
|
||||
author={MMSegmentation Contributors},
|
||||
howpublished = {\url{https://github.com/open-mmlab/mmsegmentation}},
|
||||
year={2020}
|
||||
|
||||
134
README_zh-CN.md
Normal file
134
README_zh-CN.md
Normal file
@ -0,0 +1,134 @@
|
||||
<div align="center">
|
||||
<img src="resources/mmseg-logo.png" width="600"/>
|
||||
</div>
|
||||
<br />
|
||||
|
||||
[](https://pypi.org/project/mmsegmentation)
|
||||
[](https://mmsegmentation.readthedocs.io/en/latest/)
|
||||
[](https://github.com/open-mmlab/mmsegmentation/actions)
|
||||
[](https://codecov.io/gh/open-mmlab/mmsegmentation)
|
||||
[](https://github.com/open-mmlab/mmsegmentation/blob/master/LICENSE)
|
||||
[](https://github.com/open-mmlab/mmsegmentation/issues)
|
||||
[](https://github.com/open-mmlab/mmsegmentation/issues)
|
||||
|
||||
文档: https://mmsegmentation.readthedocs.io/
|
||||
|
||||
[English](README.md) | 简体中文
|
||||
|
||||
## 简介
|
||||
|
||||
MMSegmentation 是一个基于 PyTorch 的语义分割开源工具箱。它是 OpenMMLab 项目的一部分。
|
||||
|
||||
主分支代码目前支持 PyTorch 1.3 以上的版本。
|
||||
|
||||
|
||||
|
||||
### 主要特性
|
||||
|
||||
- **统一的基准平台**
|
||||
|
||||
我们将各种各样的语义分割算法集成到了一个统一的工具箱，进行基准测试。
|
||||
|
||||
- **模块化设计**
|
||||
|
||||
MMSegmentation 将分割框架解耦成不同的模块组件，通过组合不同的模块组件，用户可以便捷地构建自定义的分割模型。
|
||||
|
||||
- **丰富的即插即用的算法和模型**
|
||||
|
||||
MMSegmentation 支持了众多主流的和最新的检测算法，例如 PSPNet，DeepLabV3，PSANet，DeepLabV3+ 等.
|
||||
|
||||
- **速度快**
|
||||
|
||||
训练速度比其他语义分割代码库更快或者相当。
|
||||
|
||||
## 开源许可证
|
||||
|
||||
该项目采用 [Apache 2.0 开源许可证](LICENSE)。
|
||||
|
||||
## 更新日志
|
||||
|
||||
最新的月度版本 v0.11.0 在 2021.02.02 发布。
|
||||
如果想了解更多版本更新细节和历史信息，请阅读[更新日志](docs/changelog.md)。
|
||||
|
||||
## 基准测试和模型库
|
||||
|
||||
测试结果和模型可以在[模型库](docs/model_zoo.md)中找到。
|
||||
|
||||
已支持的骨干网络：
|
||||
|
||||
- [x] ResNet
|
||||
- [x] ResNeXt
|
||||
- [x] [HRNet](configs/hrnet/README.md)
|
||||
- [x] [ResNeSt](configs/resnest/README.md)
|
||||
- [x] [MobileNetV2](configs/mobilenet_v2/README.md)
|
||||
- [x] [MobileNetV3](configs/mobilenet_v3/README.md)
|
||||
|
||||
已支持的算法：
|
||||
|
||||
- [x] [FCN](configs/fcn)
|
||||
- [x] [PSPNet](configs/pspnet)
|
||||
- [x] [DeepLabV3](configs/deeplabv3)
|
||||
- [x] [PSANet](configs/psanet)
|
||||
- [x] [DeepLabV3+](configs/deeplabv3plus)
|
||||
- [x] [UPerNet](configs/upernet)
|
||||
- [x] [NonLocal Net](configs/nonlocal_net)
|
||||
- [x] [EncNet](configs/encnet)
|
||||
- [x] [CCNet](configs/ccnet)
|
||||
- [x] [DANet](configs/danet)
|
||||
- [x] [APCNet](configs/apcnet)
|
||||
- [x] [GCNet](configs/gcnet)
|
||||
- [x] [DMNet](configs/dmnet)
|
||||
- [x] [ANN](configs/ann)
|
||||
- [x] [OCRNet](configs/ocrnet)
|
||||
- [x] [Fast-SCNN](configs/fastscnn)
|
||||
- [x] [Semantic FPN](configs/sem_fpn)
|
||||
- [x] [PointRend](configs/point_rend)
|
||||
- [x] [EMANet](configs/emanet)
|
||||
- [x] [DNLNet](configs/dnlnet)
|
||||
- [x] [CGNet](configs/cgnet)
|
||||
- [x] [Mixed Precision (FP16) Training](configs/fp16/README.md)
|
||||
|
||||
## 安装
|
||||
|
||||
请参考[快速入门文档](docs/get_started.md#installation)进行安装和数据集准备。
|
||||
|
||||
## 快速入门
|
||||
|
||||
请参考[训练教程](docs/train.md)和[测试教程](docs/inference.md)学习 MMSegmentation 的基本使用。
|
||||
我们也提供了一些进阶教程，内容覆盖了[增加自定义数据集](docs/tutorials/customize_datasets.md)，[设计新的数据预处理流程](docs/tutorials/data_pipeline.md)，[增加自定义模型](docs/tutorials/customize_models.md)，[增加自定义的运行时配置](docs/tutorials/customize_runtime.md)。
|
||||
除此之外，我们也提供了很多实用的[训练技巧说明](docs/tutorials/training_tricks.md)。
|
||||
|
||||
同时，我们提供了 Colab 教程。你可以在[这里](demo/MMSegmentation_Tutorial.ipynb)浏览教程，或者直接在 Colab 上[运行](https://colab.research.google.com/github/open-mmlab/mmsegmentation/blob/master/demo/MMSegmentation_Tutorial.ipynb)。
|
||||
|
||||
## 引用
|
||||
|
||||
如果你觉得本项目对你的研究工作有所帮助，请参考如下 bibtex 引用 MMSegmentation。
|
||||
|
||||
```latex
|
||||
@misc{mmseg2020,
|
||||
title={{MMSegmentation}: OpenMMLab Semantic Segmentation Toolbox and Benchmark},
|
||||
author={MMSegmentation Contributors},
|
||||
howpublished = {\url{https://github.com/open-mmlab/mmsegmentation}},
|
||||
year={2020}
|
||||
}
|
||||
```
|
||||
|
||||
## 贡献指南
|
||||
|
||||
我们感谢所有的贡献者为改进和提升 MMSegmentation 所作出的努力。请参考[贡献指南](.github/CONTRIBUTING.md)来了解参与项目贡献的相关指引。
|
||||
|
||||
## 致谢
|
||||
|
||||
MMSegmentation 是一个由来自不同高校和企业的研发人员共同参与贡献的开源项目。我们感谢所有为项目提供算法复现和新功能支持的贡献者，以及提供宝贵反馈的用户。 我们希望这个工具箱和基准测试可以为社区提供灵活的代码工具，供用户复现已有算法并开发自己的新模型，从而不断为开源社区提供贡献。
|
||||
|
||||
## OpenMMLab 的其他项目
|
||||
|
||||
- [MMCV](https://github.com/open-mmlab/mmcv): OpenMMLab 计算机视觉基础库
|
||||
- [MMClassification](https://github.com/open-mmlab/mmclassification): OpenMMLab 图像分类工具箱
|
||||
- [MMDetection](https://github.com/open-mmlab/mmdetection): OpenMMLab 目标检测工具箱
|
||||
- [MMDetection3D](https://github.com/open-mmlab/mmdetection3d): OpenMMLab 新一代通用 3D 目标检测平台
|
||||
- [MMSegmentation](https://github.com/open-mmlab/mmsegmentation): OpenMMLab 语义分割工具箱
|
||||
- [MMAction2](https://github.com/open-mmlab/mmaction2): OpenMMLab 新一代视频理解工具箱
|
||||
- [MMTracking](https://github.com/open-mmlab/mmtracking): OpenMMLab 一体化视频目标感知平台
|
||||
- [MMPose](https://github.com/open-mmlab/mmpose): OpenMMLab 姿态估计工具箱
|
||||
- [MMEditing](https://github.com/open-mmlab/mmediting): OpenMMLab 图像视频编辑工具箱
|
||||
Loading…
x
Reference in New Issue
Block a user