From ebb519f160ef1b437247aee926cff04c0ff0a045 Mon Sep 17 00:00:00 2001 From: sunyanfang01 Date: Tue, 19 May 2020 20:49:46 +0800 Subject: [PATCH] fix the doc --- docs/apis/datasets/dataset_convert.md | 42 +++++++++++++++++++++++++++ docs/apis/datasets/index.rst | 1 + docs/apis/visualize.md | 1 + docs/appendix/datasets.md | 14 ++++----- docs/datasets.md | 14 ++++----- 5 files changed, 58 insertions(+), 14 deletions(-) create mode 100644 docs/apis/datasets/dataset_convert.md diff --git a/docs/apis/datasets/dataset_convert.md b/docs/apis/datasets/dataset_convert.md new file mode 100644 index 0000000..2a04c80 --- /dev/null +++ b/docs/apis/datasets/dataset_convert.md @@ -0,0 +1,42 @@ +# 数据集转换 +## labelme2voc +```python +pdx.tools.labelme2voc(image_dir, json_dir, dataset_save_dir) +``` +将LabelMe标注的数据集转换为VOC数据集。 + +> **参数** +> > * **image_dir** (str): 图像文件存放的路径。 +> > * **json_dir** (str): 与每张图像对应的json文件的存放路径。 +> > * **dataset_save_dir** (str): 转换后数据集存放路径。 + +## 其它数据集转换 +### easydata2imagenet +```python +pdx.tools.easydata2imagenet(image_dir, json_dir, dataset_save_dir) +``` +### easydata2voc +```python +pdx.tools.easydata2voc(image_dir, json_dir, dataset_save_dir) +``` +### easydata2coco +```python +pdx.tools.easydata2coco(image_dir, json_dir, dataset_save_dir) +``` +### easydata2seg +```python +pdx.tools.easydata2seg(image_dir, json_dir, dataset_save_dir) +``` +### labelme2coco +```python +pdx.tools.labelme2coco(image_dir, json_dir, dataset_save_dir) +``` +### labelme2seg +```python +pdx.tools.labelme2seg(image_dir, json_dir, dataset_save_dir) +``` +### jingling2seg +```python +pdx.tools.jingling2seg(image_dir, json_dir, dataset_save_dir) +``` + diff --git a/docs/apis/datasets/index.rst b/docs/apis/datasets/index.rst index e04aa45..06326e4 100755 --- a/docs/apis/datasets/index.rst +++ b/docs/apis/datasets/index.rst @@ -29,3 +29,4 @@ PaddleX目前支持主流的CV数据集格式和 `EasyData 点击下载如下示例中的[模型](https://bj.bcebos.com/paddlex/interpret/mini_imagenet_veg_mobilenetv2.tar.gz)和[数据集](https://bj.bcebos.com/paddlex/interpret/mini_imagenet_veg.tar.gz)，参考[`paddlex.datasets.ImageNet`类](.//datasets/classification.html#imagenet)构建test_dataset。在该数据集上预测可解释性的过程可参见[代码](https://github.com/PaddlePaddle/PaddleX/blob/develop/tutorials/interpret/interpret.py)。 ``` import paddlex as pdx model = pdx.load_model('mini_imagenet_veg_mobilenetv2') diff --git a/docs/appendix/datasets.md b/docs/appendix/datasets.md index 3ffeae9..e966205 100644 --- a/docs/appendix/datasets.md +++ b/docs/appendix/datasets.md @@ -42,7 +42,7 @@ labelB ... ``` [点击这里](https://bj.bcebos.com/paddlex/datasets/vegetables_cls.tar.gz)，下载蔬菜分类分类数据集。 -在PaddleX中，使用`paddlex.cv.datasets.ImageNet`([API说明](./apis/datasets.html#imagenet))加载分类数据集。 +在PaddleX中，使用`paddlex.cv.datasets.ImageNet`([API说明](../apis/datasets/classification.html#imagenet))加载分类数据集。 ## 目标检测VOC 目标检测VOC数据集包含图像文件夹、标注信息文件夹、标签文件及图像列表文件。 @@ -82,7 +82,7 @@ labelB ... ``` [点击这里](https://bj.bcebos.com/paddlex/datasets/insect_det.tar.gz)，下载昆虫检测数据集。 -在PaddleX中，使用`paddlex.cv.datasets.VOCDetection`([API说明](./apis/datasets.html#vocdetection))加载目标检测VOC数据集。 +在PaddleX中，使用`paddlex.cv.datasets.VOCDetection`([API说明](../apis/datasets/detection.html#vocdetection))加载目标检测VOC数据集。 ## 目标检测和实例分割COCO 目标检测和实例分割COCO数据集包含图像文件夹及图像标注信息文件。 @@ -156,7 +156,7 @@ labelB [点击这里](https://bj.bcebos.com/paddlex/datasets/garbage_ins_det.tar.gz)，下载垃圾实例分割数据集。 -在PaddleX中，使用`paddlex.cv.datasets.COCODetection`([API说明](./apis/datasets.html#cocodetection))加载COCO格式数据集。 +在PaddleX中，使用`paddlex.cv.datasets.COCODetection`([API说明](../apis/datasets/detection.html#cocodetection))加载COCO格式数据集。 ## 语义分割数据 语义分割数据集包含原图、标注图及相应的文件列表文件。 @@ -201,7 +201,7 @@ labelB 例如0，1，2，3表示有4种类别，标注类别最多为256类。其中可以指定特定的像素值用于表示该值的像素不参与训练和评估（默认为255）。 [点击这里](https://bj.bcebos.com/paddlex/datasets/optic_disc_seg.tar.gz)，下载视盘语义分割数据集。 -在PaddleX中，使用`paddlex.cv.datasets.SegReader`([API说明](./apis/datasets.html#segreader))加载语义分割数据集。 +在PaddleX中，使用`paddlex.cv.datasets.SegReader`([API说明](../apis/datasets/semantic_segmentation.html#segdataset))加载语义分割数据集。 ## 图像分类EasyDataCls @@ -246,7 +246,7 @@ labelB ... ``` [点击这里](https://ai.baidu.com/easydata/)，可以标注图像分类EasyDataCls数据集。 -在PaddleX中，使用`paddlex.cv.datasets.EasyDataCls`([API说明](./apis/datasets.html#easydatacls))加载分类数据集。 +在PaddleX中，使用`paddlex.cv.datasets.EasyDataCls`([API说明](../apis/datasets/classification.html#easydatacls))加载分类数据集。 ## 目标检测和实例分割EasyDataDet @@ -305,7 +305,7 @@ labelB ``` [点击这里](https://ai.baidu.com/easydata/)，可以标注图像分类EasyDataDet数据集。 -在PaddleX中，使用`paddlex.cv.datasets.EasyDataDet`([API说明](./apis/datasets.html#easydatadet))加载分类数据集。 +在PaddleX中，使用`paddlex.cv.datasets.EasyDataDet`([API说明](../apis/datasets/detection.html#easydatadet))加载分类数据集。 ## 语义分割EasyDataSeg @@ -363,5 +363,5 @@ labelB ``` [点击这里](https://ai.baidu.com/easydata/)，可以标注图像分类EasyDataSeg数据集。 -在PaddleX中，使用`paddlex.cv.datasets.EasyDataSeg`([API说明](./apis/datasets.html#easydataseg))加载分类数据集。 +在PaddleX中，使用`paddlex.cv.datasets.EasyDataSeg`([API说明](../apis/datasets/semantic_segmentation.html#easydataseg))加载分类数据集。 diff --git a/docs/datasets.md b/docs/datasets.md index 3ffeae9..8227ae7 100644 --- a/docs/datasets.md +++ b/docs/datasets.md @@ -42,7 +42,7 @@ labelB ... ``` [点击这里](https://bj.bcebos.com/paddlex/datasets/vegetables_cls.tar.gz)，下载蔬菜分类分类数据集。 -在PaddleX中，使用`paddlex.cv.datasets.ImageNet`([API说明](./apis/datasets.html#imagenet))加载分类数据集。 +在PaddleX中，使用`paddlex.cv.datasets.ImageNet`([API说明](./apis/datasets/classification.html#imagenet))加载分类数据集。 ## 目标检测VOC 目标检测VOC数据集包含图像文件夹、标注信息文件夹、标签文件及图像列表文件。 @@ -82,7 +82,7 @@ labelB ... ``` [点击这里](https://bj.bcebos.com/paddlex/datasets/insect_det.tar.gz)，下载昆虫检测数据集。 -在PaddleX中，使用`paddlex.cv.datasets.VOCDetection`([API说明](./apis/datasets.html#vocdetection))加载目标检测VOC数据集。 +在PaddleX中，使用`paddlex.cv.datasets.VOCDetection`([API说明](./apis/datasets/detection.html#vocdetection))加载目标检测VOC数据集。 ## 目标检测和实例分割COCO 目标检测和实例分割COCO数据集包含图像文件夹及图像标注信息文件。 @@ -156,7 +156,7 @@ labelB [点击这里](https://bj.bcebos.com/paddlex/datasets/garbage_ins_det.tar.gz)，下载垃圾实例分割数据集。 -在PaddleX中，使用`paddlex.cv.datasets.COCODetection`([API说明](./apis/datasets.html#cocodetection))加载COCO格式数据集。 +在PaddleX中，使用`paddlex.cv.datasets.COCODetection`([API说明](./apis/datasets/detection.html#cocodetection))加载COCO格式数据集。 ## 语义分割数据 语义分割数据集包含原图、标注图及相应的文件列表文件。 @@ -201,7 +201,7 @@ labelB 例如0，1，2，3表示有4种类别，标注类别最多为256类。其中可以指定特定的像素值用于表示该值的像素不参与训练和评估（默认为255）。 [点击这里](https://bj.bcebos.com/paddlex/datasets/optic_disc_seg.tar.gz)，下载视盘语义分割数据集。 -在PaddleX中，使用`paddlex.cv.datasets.SegReader`([API说明](./apis/datasets.html#segreader))加载语义分割数据集。 +在PaddleX中，使用`paddlex.cv.datasets.SegReader`([API说明](./apis/datasets/semantic_segmentation.html#segdataset))加载语义分割数据集。 ## 图像分类EasyDataCls @@ -246,7 +246,7 @@ labelB ... ``` [点击这里](https://ai.baidu.com/easydata/)，可以标注图像分类EasyDataCls数据集。 -在PaddleX中，使用`paddlex.cv.datasets.EasyDataCls`([API说明](./apis/datasets.html#easydatacls))加载分类数据集。 +在PaddleX中，使用`paddlex.cv.datasets.EasyDataCls`([API说明](./apis/datasets/classification.html#easydatacls))加载分类数据集。 ## 目标检测和实例分割EasyDataDet @@ -305,7 +305,7 @@ labelB ``` [点击这里](https://ai.baidu.com/easydata/)，可以标注图像分类EasyDataDet数据集。 -在PaddleX中，使用`paddlex.cv.datasets.EasyDataDet`([API说明](./apis/datasets.html#easydatadet))加载分类数据集。 +在PaddleX中，使用`paddlex.cv.datasets.EasyDataDet`([API说明](./apis/datasets/detection.html#easydatadet))加载分类数据集。 ## 语义分割EasyDataSeg @@ -363,5 +363,5 @@ labelB ``` [点击这里](https://ai.baidu.com/easydata/)，可以标注图像分类EasyDataSeg数据集。 -在PaddleX中，使用`paddlex.cv.datasets.EasyDataSeg`([API说明](./apis/datasets.html#easydataseg))加载分类数据集。 +在PaddleX中，使用`paddlex.cv.datasets.EasyDataSeg`([API说明](./apis/datasets/semantic_segmentation.html#easydataseg))加载分类数据集。 -- GitLab