[Docs] Add Overview #2042

MeowZheng · 2022-09-07T12:33:37Z

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

Add overview documentation

Modification

add docs/en/overview.md
rename docs/en/advanced_guides/add_modules.md to docs/en/advanced_guides/add_models.md

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repos?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

Checklist

Pre-commit or other linting tools are used to fix the potential lint issues.
The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMDet3D.
The documentation has been modified accordingly, like docstring or example tutorials.

docs/en/overview.md

MengzhangLI · 2022-09-15T17:54:57Z

docs/en/overview.md

+  - **backbones** contains various backbone networks that transform an image to feature maps.
+  - **necks** contains various neck components that connect the backbone and heads.
+  - **decode_heads** contains various head components that take feature map as input and predict segmentation results.
+  - **losses** contains various loss functions


Suggested change

- **losses** contains various loss functions

- **losses** contains various loss functions.

docs/en/overview.md

MeowZheng · 2022-09-16T03:18:25Z

docs/en/overview.md

+
+## What is semantic segmentation?
+
+Semantic segmentation is the task of clustering parts of an image together that belong to the same object class.


it might not suit semantic segmentation. Semantic segmentation does nothing about Object

* [Docs] Add Overview * comments * refine * refine

* refactor onnxruntime integration * fix requirements.txt bug * make style * add support for textual_inversion * make style * add readme * cleanup README files * 1/27/2023 update to training scripts * make style * 1/30 update to train_unconditional * style with black-22.8.0 --------- Co-authored-by: Prathik Rao <prathikrao@microsoft.com> Co-authored-by: anton- <anton@huggingface.co>

* [Docs] Add Overview * comments * refine * refine

[Docs] Add Overview

1c7405e

mm-assistant bot assigned MeowZheng Sep 7, 2022

MeowZheng requested review from MengzhangLI and xiexinch September 8, 2022 05:58

xiexinch reviewed Sep 14, 2022

View reviewed changes

docs/en/overview.md Outdated Show resolved Hide resolved

docs/en/overview.md Outdated Show resolved Hide resolved

docs/en/overview.md Outdated Show resolved Hide resolved

comments

54f9415