From 3aba989fbc902ec3d1c69780963c9f4136766230 Mon Sep 17 00:00:00 2001
From: Mashiro <57566630+HAOCHENYE@users.noreply.github.com>
Date: Tue, 1 Nov 2022 17:31:09 +0800
Subject: [PATCH] [Docs] Fix docstring of BaseDataset (#656)
* [Fix] Fix docstring of BaseDataset
* minor refine
---
mmengine/dataset/base_dataset.py | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/mmengine/dataset/base_dataset.py b/mmengine/dataset/base_dataset.py
index fcbb24a5..fe5cdc07 100644
--- a/mmengine/dataset/base_dataset.py
+++ b/mmengine/dataset/base_dataset.py
@@ -180,9 +180,9 @@ class BaseDataset(Dataset):
image. Defaults to 1000.
Note:
- BaseDataset collects meta information from `annotation file` (the
- lowest priority), ``BaseDataset.METAINFO``(medium) and `metainfo
- parameter` (highest) passed to constructors. The lower priority meta
+ BaseDataset collects meta information from ``annotation file`` (the
+ lowest priority), ``BaseDataset.METAINFO``(medium) and ``metainfo
+ parameter`` (highest) passed to constructors. The lower priority meta
information will be overwritten by higher one.
Note:
@@ -192,7 +192,7 @@ class BaseDataset(Dataset):
conflicts with original dataset.
Examples:
- Assume the annotation file is given above.
+ >>> # Assume the annotation file is given above.
>>> class CustomDataset(BaseDataset):
>>> METAINFO: dict = dict(task_name='custom_task',
>>> dataset_type='custom_type')
--
GitLab