注意

您正在阅读 MMSelfSup 0.x 版本的文档，而 MMSelfSup 0.x 版本将会在 2022 年末 开始逐步停止维护。我们建议您及时升级到 MMSelfSup 1.0.0rc 版本，享受由 OpenMMLab 2.0 带来的更多新特性和更佳的性能表现。阅读 MMSelfSup 1.0.0rc 的 发版日志, 代码 和 文档 获取更多信息。

教程 1: 添加新的数据格式

在本节教程中，我们将介绍创建自定义数据格式的基本步骤：

• 教程 1: 添加新的数据格式

  • 自定义数据格式示例

  • 创建DataSource子类

  • 创建Dataset子类

  • 修改配置文件

如果你的算法不需要任何定制的数据格式，你可以使用datasets目录中这些现成的数据格式。但是要使用这些现有的数据格式，你必须将你的数据集转换为现有的数据格式。

自定义数据格式示例

假设你的数据集的注释文件格式是：

000001.jpg 0
000002.jpg 1

要编写一个新的数据格式，你需要实现：

• 子类DataSource：继承自父类BaseDataSource——负责加载注释文件和读取图像。

• 子类Dataset：继承自父类 BaseDataset ——负责对图像进行转换和打包。

创建 DataSource 子类

假设你基于父类DataSource 创建的子类名为 NewDataSource， 你可以在mmselfsup/datasets/data_sources 目录下创建一个文件，文件名为 new_data_source.py ，并在这个文件中实现 NewDataSource 创建。

import mmcv
import numpy as np

from ..builder import DATASOURCES
from .base import BaseDataSource


@DATASOURCES.register_module()
class NewDataSource(BaseDataSource):

    def load_annotations(self):

        assert isinstance(self.ann_file, str)
        data_infos = []
        # writing your code here.
        return data_infos

然后， 在 mmselfsup/dataset/data_sources/__init__.py中添加NewDataSource。

from .base import BaseDataSource
...
from .new_data_source import NewDataSource

__all__ = [
    'BaseDataSource', ..., 'NewDataSource'
]

创建 Dataset 子类

假设你基于父类 Dataset 创建的子类名为 NewDataset，你可以在mmselfsup/datasets目录下创建一个文件，文件名为new_dataset.py ，并在这个文件中实现 NewDataset 创建。

# Copyright (c) OpenMMLab. All rights reserved.
import torch
from mmcv.utils import build_from_cfg
from torchvision.transforms import Compose

from .base import BaseDataset
from .builder import DATASETS, PIPELINES, build_datasource
from .utils import to_numpy


@DATASETS.register_module()
class NewDataset(BaseDataset):

    def __init__(self, data_source, num_views, pipelines, prefetch=False):
        # writing your code here
    def __getitem__(self, idx):
        # writing your code here
        return dict(img=img)

    def evaluate(self, results, logger=None):
        return NotImplemented

然后，在 mmselfsup/dataset/__init__.py中添加 NewDataset。

from .base import BaseDataset
...
from .new_dataset import NewDataset

__all__ = [
    'BaseDataset', ..., 'NewDataset'
]

修改配置文件

为了使用 NewDataset，你可以修改配置如下：

train=dict(
        type='NewDataset',
        data_source=dict(
            type='NewDataSource',
        ),
        num_views=[2],
        pipelines=[train_pipeline],
        prefetch=prefetch,
    ))