Split Folders 开源项目教程

Split Folders 开源项目教程

split-folders🗂 Split folders with files (i.e. images) into training, validation and test (dataset) folders项目地址:https://gitcode.com/gh_mirrors/sp/split-folders

1. 项目的目录结构及介绍

Split Folders 项目的目录结构相对简单，主要包含以下几个部分：

split-folders/
├── LICENSE
├── README.md
├── setup.py
├── split_folders
│   ├── __init__.py
│   ├── _version.py
│   └── split.py
└── tests
    ├── __init__.py
    └── test_split_folders.py

• LICENSE: 项目的许可证文件，说明项目的使用条款。
• README.md: 项目的说明文档，包含项目的基本信息、安装和使用方法。
• setup.py: 用于安装项目的脚本文件。
• split_folders/: 核心代码目录。
  • __init__.py: 初始化文件，使 split_folders 成为一个 Python 包。
  • _version.py: 版本信息文件。
  • split.py: 主要功能实现文件，包含分割文件夹的逻辑。
• tests/: 测试代码目录。
  • __init__.py: 初始化文件，使 tests 成为一个 Python 包。
  • test_split_folders.py: 测试用例文件，包含对 split.py 中功能的测试。

2. 项目的启动文件介绍

项目的启动文件是 split_folders/split.py。这个文件包含了主要的函数 split_folders，用于实现文件夹的分割功能。以下是该文件的主要内容：

import os
import random
import shutil
from typing import Dict, List, Optional, Tuple, Union

def split_folders(input_dir: str, output: str = "output", seed: int = 1337, ratio: Tuple[float, float, float] = (0.8, 0.1, 0.1), group_prefix: Optional[int] = None) -> None:
    """
    Split folders with files (e.g. images) into train, validation and test (dataset) folders.
    """
    # 具体实现代码...

• split_folders 函数接受多个参数，包括输入目录、输出目录、随机种子、分割比例等，并根据这些参数将文件夹中的文件分割到不同的子目录中。

3. 项目的配置文件介绍

Split Folders 项目没有显式的配置文件，其行为主要通过函数参数来配置。例如，在调用 split_folders 函数时，可以通过以下参数进行配置：

• input_dir: 输入目录路径。
• output: 输出目录路径。
• seed: 随机种子，用于确保分割结果的可重复性。
• ratio: 分割比例，指定训练集、验证集和测试集的比例。
• group_prefix: 可选参数，用于指定文件分组的规则。

通过这些参数，用户可以灵活地配置文件夹分割的行为。

以上是 Split Folders 开源项目的详细教程，涵盖了项目的目录结构、启动文件和配置方法。希望这些信息能帮助你更好地理解和使用该项目。

split-folders🗂 Split folders with files (i.e. images) into training, validation and test (dataset) folders项目地址:https://gitcode.com/gh_mirrors/sp/split-folders