From c1178fad8fce4b19e8a640ddb76650af27b0bef1 Mon Sep 17 00:00:00 2001 From: MengzhangLI <mcmong@pku.edu.cn> Date: Tue, 13 Sep 2022 14:55:59 +0800 Subject: [PATCH] [Doc] Fix typo in docstring (#527) --- mmengine/structures/instance_data.py | 2 +- mmengine/structures/label_data.py | 2 +- mmengine/structures/pixel_data.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/mmengine/structures/instance_data.py b/mmengine/structures/instance_data.py index 5aecf608..2dc99ea8 100644 --- a/mmengine/structures/instance_data.py +++ b/mmengine/structures/instance_data.py @@ -16,7 +16,7 @@ IndexType = Union[str, slice, int, list, torch.LongTensor, # Modified from # https://github.com/open-mmlab/mmdetection/blob/master/mmdet/core/data_structures/instance_data.py # noqa class InstanceData(BaseDataElement): - """Data structure for instance-level annnotations or predictions. + """Data structure for instance-level annotations or predictions. Subclass of :class:`BaseDataElement`. All value in `data_fields` should have the same length. This design refer to diff --git a/mmengine/structures/label_data.py b/mmengine/structures/label_data.py index fa468598..d82c2d13 100644 --- a/mmengine/structures/label_data.py +++ b/mmengine/structures/label_data.py @@ -6,7 +6,7 @@ from .base_data_element import BaseDataElement class LabelData(BaseDataElement): - """Data structure for label-level annnotations or predictions.""" + """Data structure for label-level annotations or predictions.""" @staticmethod def onehot_to_label(onehot: torch.Tensor) -> torch.Tensor: diff --git a/mmengine/structures/pixel_data.py b/mmengine/structures/pixel_data.py index e52459e5..97c08a17 100644 --- a/mmengine/structures/pixel_data.py +++ b/mmengine/structures/pixel_data.py @@ -9,7 +9,7 @@ from .base_data_element import BaseDataElement class PixelData(BaseDataElement): - """Data structure for pixel-level annnotations or predictions. + """Data structure for pixel-level annotations or predictions. All data items in ``data_fields`` of ``PixelData`` meet the following requirements: -- GitLab