Update docs

RapidAI · Mar 30, 2024 · 70f92f8 · 70f92f8
1 parent cd2c2cc
commit 70f92f8
Show file tree

Hide file tree

Showing 9 changed files with 50 additions and 38 deletions.
diff --git a/content/docs/SupportConversions/coco_to_labelimg.md b/content/docs/SupportConversions/coco_to_labelimg.md
@@ -19,7 +19,7 @@ publishdate: "2022-09-30"
 {{< alert text="具体结构示例文件，可移步：[COCO_dataset](https://github.com/RapidAI/LabelConvert/tree/main/tests/test_files/COCO_dataset)" />}}
 
 ```text {linenos=table}
-COCO_format
+COCO_dataset
 ├── annotations
 │   ├── instances_train2017.json
 │   └── instances_val2017.json
@@ -32,19 +32,19 @@ COCO_format
 
 #### 转换
 ```bash {linenos=table}
-coco_to_labelImg --data_dir dataset/COCO_format --save_dir dataset/labelImg_format
+coco_to_labelImg --data_dir dataset/COCO_dataset --save_dir dataset/labelImg_format
 ```
 
-- `--data_dir`: COCO格式数据集所在目录。默认是`dataset/COCO_format`
-- `--save_dir`: 保存转换后的数据集目录。默认是COCO数据集同级目录下
+- `--data_dir`: COCO格式数据集所在目录。示例为`dataset/COCO_dataset`
+- `--save_dir`: 保存转换后的数据集目录。默认为`dataset/COCO_dataset_labelImg`
 
 #### 转换后结构如下：
 
 {{< alert text="具体结构示例文件，可移步：[labelImg_dataset](https://github.com/RapidAI/LabelConvert/tree/main/tests/test_files/labelImg_dataset)" />}}
 
 
 ```text {linenos=table}
-labelImg_format
+labelImg_dataset
   ├── train
   │   ├── 000000000001.jpg
   │   ├── 000000000001.txt
@@ -58,7 +58,7 @@ labelImg_format
 
 #### labelImg可视化
 ```bash {linenos=table}
-$ cd dataset/labelImg_format
+$ cd dataset/labelImg_dataset
 $ labelImg train train/classes.txt
 
 # or

diff --git a/content/docs/SupportConversions/darknet_to_coco.md b/content/docs/SupportConversions/darknet_to_coco.md
@@ -32,9 +32,12 @@ darknet_dataset
 
 #### 转换
 ```bash {linenos=table}
-darknet_to_coco --data_path dataset/darknet/gen_config.data
+darknet_to_coco --data_dir dataset/darknet_dataset
 ```
 
+- `--data_dir`: COCO格式数据集所在目录。示例为`dataset/darknet_dataset`
+- `--save_dir`: 保存转换后的数据集目录。默认为`dataset/darknet_dataset_coco`
+
 #### 转换后结构如下：
 
 {{< alert text="具体结构示例文件，可移步：[COCO_dataset](https://github.com/RapidAI/LabelConvert/tree/main/tests/test_files/COCO_dataset)" />}}

diff --git a/content/docs/SupportConversions/labelimg_to_publaynet.md b/content/docs/SupportConversions/labelimg_to_publaynet.md
@@ -19,7 +19,7 @@ publishdate: "2022-09-30"
 {{< alert text="具体结构示例文件，可移步：[labelImg_dataset](https://github.com/RapidAI/LabelConvert/tree/main/tests/test_files/labelImg_dataset)" />}}
 
 ```text {linenos=table}
-labelImg_format
+labelImg_dataset
 ├── classes.txt
 ├── images(13).jpg
 ├── images(13).txt
@@ -44,11 +44,11 @@ labelImg_to_publaynet --data_dir dataset/labelImg_dataset \
 ```
 
 
-- `--data_dir`: COCO格式数据集所在目录。默认是`dataset/labelImg_dataset`
-- `--save_dir`: 保存转换后的数据集目录。默认是COCO数据集同级目录下
-- `--val_ratio`: 验证集数目占数据集总数比例，默认是`0.2`.
+- `--data_dir`: COCO格式数据集所在目录。示例为`dataset/labelImg_dataset`
+- `--save_dir`: 保存转换后的数据集目录。默认为`dataset/labelImg_dataset_publaynet`
+- `--val_ratio`: 验证集数目占数据集总数比例，默认为`0.2`.
 - `--have_test`: 是否有测试集。默认为`False`，如果出现，则为`True`
-- `--test_ratio`: 测试集数目占数据集总数比例，默认是`0.2`
+- `--test_ratio`: 测试集数目占数据集总数比例，默认为`0.2`
 
 
 #### 转换后结构如下：
@@ -57,7 +57,7 @@ labelImg_to_publaynet --data_dir dataset/labelImg_dataset \
 
 
 ````text {linenos=table}
-publaynet_format
+publaynet_dataset
 ├── test
 │   ├── images5.jpg
 │   └── images5.txt

diff --git a/content/docs/SupportConversions/labelimg_to_yolov5.md b/content/docs/SupportConversions/labelimg_to_yolov5.md
@@ -36,18 +36,18 @@ labelImg_dataset
 
 #### 转换
 ```bash {linenos=table}
-labelImg_to_yolov5 --src_dir dataset/labelImg_dataset \
+labelImg_to_yolov5 --data_dir dataset/labelImg_dataset \
                    --save_dir dataset/labelImg_dataset_output \
                    --val_ratio 0.2 \
                    --have_test \
                    --test_ratio 0.2
 ```
 
-- `--src_dir`: labelme标注的数据所在路径
-- `--save_dir`: 转换后数据存储路径
-- `--val_ratio`: 验证集所占比例，默认是总量的0.2
-- `--have_test`: 是否划出测试集，默认是False，如果想要划分测试集，直接加上该参数即可。
-- `--test_ratio`: 测试集的比例，默认是总量的0.2
+- `--data_dir`: labelme标注的数据所在路径，示例为`dataset/labelImg_dataset`
+- `--save_dir`: 转换后数据存储路径，默认为`dataset/labelImg_dataset_publaynet`
+- `--val_ratio`: 验证集所占比例，默认为总量的0.2
+- `--have_test`: 是否划出测试集，默认为`False`，如果想要划分测试集，直接加上该参数即可。
+- `--test_ratio`: 测试集的比例，默认为总量的0.2
 
 #### 转换后结构如下：
 

diff --git a/content/docs/SupportConversions/labelme_to_coco.md b/content/docs/SupportConversions/labelme_to_coco.md
@@ -28,17 +28,17 @@ labelme_dataset
 
 #### 转换
 ```bash {linenos=table}
-labelme_to_coco --src_dir dataset/labelme_dataset \
-                --out_dir dataset/coco_dataset \
+labelme_to_coco --data_dir dataset/labelme_dataset \
+                --save_dir dataset/coco_dataset \
                 --val_ratio 0.2 \
                 --have_test \
                 --test_ratio 0.2
 ```
-- `--src_dir`: labelme标注的数据所在路径
-- `--out_dir`: 转换后数据存储路径
-- `--val_ratio`: 验证集所占比例，默认是总量的0.2
-- `--have_test`: 是否划出测试集，默认是False，如果想要划分测试集，直接加上该参数即可。
-- `--test_ratio`: 测试集的比例，默认是总量的0.2
+- `--data_dir`: 数据集所在目录。示例为`dataset/labelme_dataset`
+- `--save_dir`: 保存转换后的数据集目录。默认为`dataset/labelme_dataset_coco`
+- `--val_ratio`: 验证集所占比例，示例为总量的0.2
+- `--have_test`: 是否划出测试集，示例为`False`，如果想要划分测试集，直接加上该参数即可。
+- `--test_ratio`: 测试集的比例，示例为总量的0.2
 
 #### 转换后结构如下：
 

diff --git a/content/docs/SupportConversions/vis_coco.md b/content/docs/SupportConversions/vis_coco.md
@@ -16,7 +16,7 @@ publishdate: "2022-09-30"
 vis_coco --img_id 1 --json_path dataset/COCO_format/annotations/instances_train2017.json -img_dir dataset/COCO_format/train2017
 ```
 
-- `--img_id`: 指定显示图像的索引值，默认为1
+- `--img_id`: 指定显示图像的索引值，示例为1
 - `--json_path`: 图像所在的json路径
 - `--img_dir`: 图像所在的目录
 

diff --git a/content/docs/SupportConversions/yolov5_to_coco.md b/content/docs/SupportConversions/yolov5_to_coco.md
@@ -13,6 +13,8 @@ publishdate: "2022-09-30T"
 #### 简介
 将YOLOv5格式数据集转换为COCO格式。
 
+支持标注格式为矩形框和多边形框。
+
 #### YOLOV5数据结构如下
 
 {{< alert text="具体结构示例文件，可移步：[yolov5_dataset](https://github.com/RapidAI/LabelConvert/tree/main/tests/test_files/yolov5_dataset)" />}}
@@ -35,10 +37,11 @@ yolov5_dataset
 
 #### 转换
 ```bash {linenos=table}
-yolov5_to_coco --data_dir dataset/YOLOV5 --mode_list train,val
+yolov5_to_coco --data_dir dataset/yolov5_dataset --mode_list train,val
 ```
 
-- `--data_dir`: 数据集存放目录
+- `--data_dir`: 数据集所在目录。示例为`dataset/yolov5_dataset`
+- `--save_dir`: 保存转换后的数据集目录。默认为`dataset/yolov5_dataset_coco`
 - `--mode_list`: 指定划分的数据集种类。 (例如：`train,val,test` / `train,val`)
 
 #### 转换后结构如下：

diff --git a/content/docs/SupportConversions/yolov5_yaml_to_coco.md b/content/docs/SupportConversions/yolov5_yaml_to_coco.md
@@ -10,10 +10,11 @@ description: ""
 publishdate: "2022-09-30T"
 ---
 
-
 #### 简介
 将以yaml文件给出的YOLOv5格式数据集转换为COCO格式
 
+支持标注格式为矩形框和多边形框。
+
 #### YOLOv5 yaml结构如下：
 
 {{< alert text="具体结构示例文件，可移步：[yolov5_yaml_dataset](https://github.com/RapidAI/LabelConvert/tree/main/tests/test_files/yolov5_yaml_dataset)" />}}
@@ -39,8 +40,11 @@ yolov5_yaml_dataset
 
 #### 转换
 ```bash {linenos=table}
-yolov5_yaml_to_coco --yaml_path dataset/YOLOV5_yaml/sample.yaml
+yolov5_yaml_to_coco --yaml_path dataset/yolov5_yaml_dataset/sample.yaml
 ```
+- `--yaml_path`: yaml文件路径
+- `--save_dir`: 保存转换后的数据集目录。默认为`dataset/yolov5_yaml_dataset_coco`
+
 
 #### 转换后结构如下：
 

diff --git a/content/docs/overview.md b/content/docs/overview.md
@@ -35,13 +35,15 @@ publishdate: "2023-09-08"
 ```mermaid
 flowchart LR
 
-A(labelImg) --> B(YOLOv5)
-A --> C(PubLayNet)
-D(COCO) --> A
-B --> D
-E(YOLOv5 YAML) --> D
-F(darknet) --> D
-G(labelme) --> D
+A(YOLO) --> B(COCO)
+
+C(YOLO YMAL) --> B
+D(darknet) --> B
+E(labelme) --> B
+
+B --> F(labelImg)
+F --> G(PubLayNet)
+F --> J(YOLO)
 ```
 
 ### 安装