mirrors/mmsegmentation
1
0
Fork 0
mirror of https://github.com/open-mmlab/mmsegmentation.git synced 2025-06-03 22:03:48 +08:00
Code Issues Projects Releases Wiki Activity

[Doc] Fix API document (#2483)

Browse Source 
## Motivation

As title.

## Modification

- docs/en/api.rst
- docs/zh_cn/api.rst
- add `scipy` to readthedocs requirement.
This commit is contained in:
谢昕辰 2023-01-13 20:06:30 +08:00 committed by GitHub
parent ce09639a21
commit d505ec1c94
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 58 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
docs/en/api.rst
View File

@ -11,8 +11,13 @@ datasets
.. automodule:: mmseg.datasets
:members:
transforms
samplers
^^^^^^^^^^
.. automodule:: mmseg.datasets.samplers
:members:
transforms
^^^^^^^^^^^^
.. automodule:: mmseg.datasets.transforms
:members:
@ -25,12 +30,12 @@ hooks
:members:
optimizers
^^^^^^^^^^
^^^^^^^^^^^^^^^
.. automodule:: mmseg.engine.optimizers
:members:
mmseg.evaluation
-----------------
--------------
metrics
^^^^^^^^^^
@ -40,9 +45,14 @@ metrics
mmseg.models
--------------
models
^^^^^^^^^^
.. automodule:: mmseg.models
backbones
^^^^^^^^^^^^^^^^^^
.. automodule:: mmseg.models.backbones
:members:
decode_heads
^^^^^^^^^^^^^^^
.. automodule:: mmseg.models.decode_heads
:members:
segmentors
@ -50,41 +60,27 @@ segmentors
.. automodule:: mmseg.models.segmentors
:members:
backbones
^^^^^^^^^^
.. automodule:: mmseg.models.backbones
:members:
decode_heads
^^^^^^^^^^^^
.. automodule:: mmseg.models.decode_heads
:members:
losses
^^^^^^^^^^
.. automodule:: mmseg.models.losses
:members:
necks
^^^^^^^^^^^^
.. automodule:: mmseg.models.necks
:members:
utils
^^^^^^^^^^
.. automodule:: mmseg.models.utils
:members:
necks
^^^^^^^^^^
.. automodule:: mmseg.models.necks
:members:
mmseg.registry
--------------
.. automodule:: mmseg.registry
:members:
mmseg.structures
-----------------
--------------------
structures
^^^^^^^^^^
^^^^^^^^^^^^^^^^^
.. automodule:: mmseg.structures
:members:
@ -93,12 +89,12 @@ sampler
.. automodule:: mmseg.structures.sampler
:members:
mmseg.visualization
--------------------
.. automodule:: mmseg.visualization
:members:
mmseg.utils
--------------
.. automodule:: mmseg.utils
:members:
mmseg.visualization
----------------------
.. automodule:: mmseg.visualization
:members:

58
docs/zh_cn/api.rst
View File

@ -11,8 +11,13 @@ datasets
.. automodule:: mmseg.datasets
:members:
transforms
samplers
^^^^^^^^^^
.. automodule:: mmseg.datasets.samplers
:members:
transforms
^^^^^^^^^^^^
.. automodule:: mmseg.datasets.transforms
:members:
@ -25,7 +30,7 @@ hooks
:members:
optimizers
^^^^^^^^^^
^^^^^^^^^^^^^^^
.. automodule:: mmseg.engine.optimizers
:members:
@ -40,9 +45,14 @@ metrics
mmseg.models
--------------
models
^^^^^^^^^^
.. automodule:: mmseg.models
backbones
^^^^^^^^^^^^^^^^^^
.. automodule:: mmseg.models.backbones
:members:
decode_heads
^^^^^^^^^^^^^^^
.. automodule:: mmseg.models.decode_heads
:members:
segmentors
@ -50,41 +60,27 @@ segmentors
.. automodule:: mmseg.models.segmentors
:members:
backbones
^^^^^^^^^^
.. automodule:: mmseg.models.backbones
:members:
decode_heads
^^^^^^^^^^^^
.. automodule:: mmseg.models.decode_heads
:members:
losses
^^^^^^^^^^
.. automodule:: mmseg.models.losses
:members:
necks
^^^^^^^^^^^^
.. automodule:: mmseg.models.necks
:members:
utils
^^^^^^^^^^
.. automodule:: mmseg.models.utils
:members:
necks
^^^^^^^^^^
.. automodule:: mmseg.models.necks
:members:
mmseg.registry
--------------
.. automodule:: mmseg.registry
:members:
mmseg.structures
--------------
--------------------
structures
^^^^^^^^^^
^^^^^^^^^^^^^^^^^
.. automodule:: mmseg.structures
:members:
@ -93,12 +89,12 @@ sampler
.. automodule:: mmseg.structures.sampler
:members:
mmseg.visualization
--------------------
.. automodule:: mmseg.visualization
:members:
mmseg.utils
--------------
.. automodule:: mmseg.utils
:members:
mmseg.visualization
--------------
.. automodule:: mmseg.visualization
:members:

5
requirements/readthedocs.txt
View File

@ -1,5 +1,6 @@
mmcv>=2.0.0rc0
mmengine
mmcv>=2.0.0rc1,<2.1.0
mmengine>=0.1.0,<1.0.0
prettytable
scipy
torch
torchvision