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

[Docs] Fix docstring format and rescale the image (#802)

Browse Source
This commit is contained in:
Zaida Zhou 2022-12-08 14:29:27 +08:00 committed by GitHub
parent 381c5f103c
commit 65eb39bfc6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 36 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/en/advanced_tutorials/basedataset.md
View File

@ -57,7 +57,9 @@ data
The initialization process of the `BaseDataset` is shown as follows: The initialization process of the `BaseDataset` is shown as follows:
![image](https://user-images.githubusercontent.com/26813582/201585974-1360e2b5-f95f-4273-8cbf-6024e33204ab.png) <div align="center">
<img src="https://user-images.githubusercontent.com/26813582/201585974-1360e2b5-f95f-4273-8cbf-6024e33204ab.png" height="500"/>
</div>
1. `load metainfo`: Obtain the meta information of the dataset. The meta information can be obtained from three sources with the priority from high to low: 1. `load metainfo`: Obtain the meta information of the dataset. The meta information can be obtained from three sources with the priority from high to low:

4
docs/zh_cn/advanced_tutorials/basedataset.md
View File

@ -57,7 +57,9 @@ data
数据集基类的初始化流程如下图所示： 数据集基类的初始化流程如下图所示：
![image](https://user-images.githubusercontent.com/26813582/201585974-1360e2b5-f95f-4273-8cbf-6024e33204ab.png) <div align="center">
<img src="https://user-images.githubusercontent.com/26813582/201585974-1360e2b5-f95f-4273-8cbf-6024e33204ab.png" height="500"/>
</div>
1. `load metainfo`：获取数据集的元信息，元信息有三种来源，优先级从高到低为： 1. `load metainfo`：获取数据集的元信息，元信息有三种来源，优先级从高到低为：

10
mmengine/visualization/visualizer.py
View File

@ -375,9 +375,9 @@ class Visualizer(ManagerMixin):
for more details. Defaults to 'g. for more details. Defaults to 'g.
marker (str, optional): The marker style. marker (str, optional): The marker style.
See :mod:`matplotlib.markers` for more information about See :mod:`matplotlib.markers` for more information about
marker styles. Default to None. marker styles. Defaults to None.
sizes (Optional[Union[np.ndarray, torch.Tensor]]): The marker size. sizes (Optional[Union[np.ndarray, torch.Tensor]]): The marker size.
Default to None. Defaults to None.
""" """
check_type('positions', positions, (np.ndarray, torch.Tensor)) check_type('positions', positions, (np.ndarray, torch.Tensor))
positions = tensor2ndarray(positions) positions = tensor2ndarray(positions)
@ -689,7 +689,7 @@ class Visualizer(ManagerMixin):
If ``line_widths`` is single value, all the lines will If ``line_widths`` is single value, all the lines will
have the same linewidth. Defaults to 2. have the same linewidth. Defaults to 2.
face_colors (Union[str, tuple, List[str], List[tuple]]): face_colors (Union[str, tuple, List[str], List[tuple]]):
The face colors. Default to None. The face colors. Defaults to None.
alpha (Union[int, float]): The transparency of bboxes. alpha (Union[int, float]): The transparency of bboxes.
Defaults to 0.8. Defaults to 0.8.
""" """
@ -734,7 +734,7 @@ class Visualizer(ManagerMixin):
"""Draw single or multiple bboxes. """Draw single or multiple bboxes.
Args: Args:
polygons (Union[Union[np.ndarray, torch.Tensor], polygons (Union[Union[np.ndarray, torch.Tensor],\
List[Union[np.ndarray, torch.Tensor]]]): The polygons to draw List[Union[np.ndarray, torch.Tensor]]]): The polygons to draw
with the format of (x1,y1,x2,y2,...,xn,yn). with the format of (x1,y1,x2,y2,...,xn,yn).
edge_colors (Union[str, tuple, List[str], List[tuple]]): The edge_colors (Union[str, tuple, List[str], List[tuple]]): The
@ -756,7 +756,7 @@ class Visualizer(ManagerMixin):
If ``line_widths`` is single value, all the lines will If ``line_widths`` is single value, all the lines will
have the same linewidth. Defaults to 2. have the same linewidth. Defaults to 2.
face_colors (Union[str, tuple, List[str], List[tuple]]): face_colors (Union[str, tuple, List[str], List[tuple]]):
The face colors. Default to None. The face colors. Defaults to None.
alpha (Union[int, float]): The transparency of polygons. alpha (Union[int, float]): The transparency of polygons.
Defaults to 0.8. Defaults to 0.8.
""" """