dtflow 0.4.2__tar.gz → 0.5.0__tar.gz

{dtflow-0.4.2 → dtflow-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dtflow
-Version: 0.4.2
+Version: 0.5.0
 Summary: A flexible data transformation tool for ML training formats (SFT, RLHF, Pretrain)
 Project-URL: Homepage, https://github.com/yourusername/DataTransformer
 Project-URL: Documentation, https://github.com/yourusername/DataTransformer#readme
@@ -126,6 +126,64 @@ dt.filter(lambda x: x.score > 0.8)
 dt.filter(lambda x: x.language == "zh")
 ```
 
+### 数据验证
+
+```python
+# 简单验证，返回不通过的记录列表
+errors = dt.validate(lambda x: len(x.messages) >= 2)
+
+if errors:
+    for e in errors[:5]:
+        print(f"第 {e.index} 行: {e.error}")
+```
+
+### Schema 验证
+
+使用 Schema 进行结构化数据验证：
+
+```python
+from dtflow import Schema, Field, openai_chat_schema
+
+# 使用预设 Schema
+result = dt.validate_schema(openai_chat_schema)
+print(result)  # ValidationResult(valid=950, invalid=50, errors=[...])
+
+# 自定义 Schema
+schema = Schema({
+    "messages": Field(type="list", required=True, min_length=1),
+    "messages[*].role": Field(type="str", choices=["user", "assistant", "system"]),
+    "messages[*].content": Field(type="str", min_length=1),
+    "score": Field(type="float", min=0, max=1),
+})
+
+result = dt.validate_schema(schema)
+
+# 过滤出有效数据
+valid_dt = dt.validate_schema(schema, filter_invalid=True)
+valid_dt.save("valid.jsonl")
+```
+
+**预设 Schema**：
+
+| Schema 名称 | 用途 |
+|------------|------|
+| `openai_chat_schema` | OpenAI messages 格式验证 |
+| `alpaca_schema` | Alpaca instruction/output 格式 |
+| `sharegpt_schema` | ShareGPT conversations 格式 |
+| `dpo_schema` | DPO prompt/chosen/rejected 格式 |
+
+**Field 参数**：
+
+| 参数 | 说明 | 示例 |
+|------|------|------|
+| `type` | 类型验证 | `"str"`, `"int"`, `"float"`, `"bool"`, `"list"`, `"dict"` |
+| `required` | 是否必填 | `True` / `False` |
+| `min` / `max` | 数值范围 | `min=0, max=1` |
+| `min_length` / `max_length` | 长度范围 | `min_length=1` |
+| `choices` | 枚举值 | `choices=["user", "assistant"]` |
+| `pattern` | 正则匹配 | `pattern=r"^\d{4}-\d{2}-\d{2}$"` |
+| `custom` | 自定义验证 | `custom=lambda x: x > 0` |
+
 ### 数据转换
 
 ```python
@@ -275,6 +333,58 @@ dt.transform(to_swift_vlm(images_field="images")).save("swift_vlm.jsonl")
 # 输出: {"messages": [...], "images": ["/path/to/img.jpg"]}
 ```
 
+### 训练框架一键导出
+
+将数据导出为目标训练框架可直接使用的格式，自动生成配置文件：
+
+```python
+from dtflow import DataTransformer
+
+dt = DataTransformer.load("data.jsonl")
+
+# 1. 检查框架兼容性
+result = dt.check_compatibility("llama-factory")
+print(result)
+# ✅ 兼容 - LLaMA-Factory (openai_chat)
+# 或
+# ❌ 不兼容 - 错误: xxx
+
+# 2. 一键导出到 LLaMA-Factory
+files = dt.export_for("llama-factory", "./llama_ready/")
+# 生成文件:
+# - ./llama_ready/custom_dataset.json      # 数据文件
+# - ./llama_ready/dataset_info.json        # 数据集配置
+# - ./llama_ready/train_args.yaml          # 训练参数模板
+
+# 3. 导出到 ms-swift
+files = dt.export_for("swift", "./swift_ready/")
+# 生成: data.jsonl + train_swift.sh
+
+# 4. 导出到 Axolotl
+files = dt.export_for("axolotl", "./axolotl_ready/")
+# 生成: data.jsonl + config.yaml
+
+# 指定数据集名称
+dt.export_for("llama-factory", "./output/", dataset_name="my_sft_data")
+```
+
+**支持的框架**：
+
+| 框架 | 导出内容 | 使用方式 |
+|------|---------|---------|
+| `llama-factory` | data.json + dataset_info.json + train_args.yaml | `llamafactory-cli train train_args.yaml` |
+| `swift` | data.jsonl + train_swift.sh | `bash train_swift.sh` |
+| `axolotl` | data.jsonl + config.yaml | `accelerate launch -m axolotl.cli.train config.yaml` |
+
+**自动格式检测**：
+
+| 检测到的格式 | 数据结构 |
+|------------|---------|
+| `openai_chat` | `{"messages": [{"role": "user", ...}]}` |
+| `alpaca` | `{"instruction": ..., "output": ...}` |
+| `sharegpt` | `{"conversations": [{"from": "human", ...}]}` |
+| `dpo` | `{"prompt": ..., "chosen": ..., "rejected": ...}` |
+
 ### 其他操作
 
 ```python
@@ -350,6 +460,12 @@ dt concat a.jsonl b.jsonl -o merged.jsonl
 
 # 数据统计
 dt stats data.jsonl
+
+# 数据验证
+dt validate data.jsonl --preset=openai_chat           # 使用预设 schema 验证
+dt validate data.jsonl --preset=alpaca --verbose      # 详细输出
+dt validate data.jsonl --preset=sharegpt --filter-invalid -o valid.jsonl  # 过滤出有效数据
+dt validate data.jsonl --preset=dpo --max-errors=100  # 限制错误输出数量
 ```
 
 ### 字段路径语法

{dtflow-0.4.2 → dtflow-0.5.0}/README.md

@@ -50,6 +50,64 @@ dt.filter(lambda x: x.score > 0.8)
 dt.filter(lambda x: x.language == "zh")
 ```
 
+### 数据验证
+
+```python
+# 简单验证，返回不通过的记录列表
+errors = dt.validate(lambda x: len(x.messages) >= 2)
+
+if errors:
+    for e in errors[:5]:
+        print(f"第 {e.index} 行: {e.error}")
+```
+
+### Schema 验证
+
+使用 Schema 进行结构化数据验证：
+
+```python
+from dtflow import Schema, Field, openai_chat_schema
+
+# 使用预设 Schema
+result = dt.validate_schema(openai_chat_schema)
+print(result)  # ValidationResult(valid=950, invalid=50, errors=[...])
+
+# 自定义 Schema
+schema = Schema({
+    "messages": Field(type="list", required=True, min_length=1),
+    "messages[*].role": Field(type="str", choices=["user", "assistant", "system"]),
+    "messages[*].content": Field(type="str", min_length=1),
+    "score": Field(type="float", min=0, max=1),
+})
+
+result = dt.validate_schema(schema)
+
+# 过滤出有效数据
+valid_dt = dt.validate_schema(schema, filter_invalid=True)
+valid_dt.save("valid.jsonl")
+```
+
+**预设 Schema**：
+
+| Schema 名称 | 用途 |
+|------------|------|
+| `openai_chat_schema` | OpenAI messages 格式验证 |
+| `alpaca_schema` | Alpaca instruction/output 格式 |
+| `sharegpt_schema` | ShareGPT conversations 格式 |
+| `dpo_schema` | DPO prompt/chosen/rejected 格式 |
+
+**Field 参数**：
+
+| 参数 | 说明 | 示例 |
+|------|------|------|
+| `type` | 类型验证 | `"str"`, `"int"`, `"float"`, `"bool"`, `"list"`, `"dict"` |
+| `required` | 是否必填 | `True` / `False` |
+| `min` / `max` | 数值范围 | `min=0, max=1` |
+| `min_length` / `max_length` | 长度范围 | `min_length=1` |
+| `choices` | 枚举值 | `choices=["user", "assistant"]` |
+| `pattern` | 正则匹配 | `pattern=r"^\d{4}-\d{2}-\d{2}$"` |
+| `custom` | 自定义验证 | `custom=lambda x: x > 0` |
+
 ### 数据转换
 
 ```python
@@ -199,6 +257,58 @@ dt.transform(to_swift_vlm(images_field="images")).save("swift_vlm.jsonl")
 # 输出: {"messages": [...], "images": ["/path/to/img.jpg"]}
 ```
 
+### 训练框架一键导出
+
+将数据导出为目标训练框架可直接使用的格式，自动生成配置文件：
+
+```python
+from dtflow import DataTransformer
+
+dt = DataTransformer.load("data.jsonl")
+
+# 1. 检查框架兼容性
+result = dt.check_compatibility("llama-factory")
+print(result)
+# ✅ 兼容 - LLaMA-Factory (openai_chat)
+# 或
+# ❌ 不兼容 - 错误: xxx
+
+# 2. 一键导出到 LLaMA-Factory
+files = dt.export_for("llama-factory", "./llama_ready/")
+# 生成文件:
+# - ./llama_ready/custom_dataset.json      # 数据文件
+# - ./llama_ready/dataset_info.json        # 数据集配置
+# - ./llama_ready/train_args.yaml          # 训练参数模板
+
+# 3. 导出到 ms-swift
+files = dt.export_for("swift", "./swift_ready/")
+# 生成: data.jsonl + train_swift.sh
+
+# 4. 导出到 Axolotl
+files = dt.export_for("axolotl", "./axolotl_ready/")
+# 生成: data.jsonl + config.yaml
+
+# 指定数据集名称
+dt.export_for("llama-factory", "./output/", dataset_name="my_sft_data")
+```
+
+**支持的框架**：
+
+| 框架 | 导出内容 | 使用方式 |
+|------|---------|---------|
+| `llama-factory` | data.json + dataset_info.json + train_args.yaml | `llamafactory-cli train train_args.yaml` |
+| `swift` | data.jsonl + train_swift.sh | `bash train_swift.sh` |
+| `axolotl` | data.jsonl + config.yaml | `accelerate launch -m axolotl.cli.train config.yaml` |
+
+**自动格式检测**：
+
+| 检测到的格式 | 数据结构 |
+|------------|---------|
+| `openai_chat` | `{"messages": [{"role": "user", ...}]}` |
+| `alpaca` | `{"instruction": ..., "output": ...}` |
+| `sharegpt` | `{"conversations": [{"from": "human", ...}]}` |
+| `dpo` | `{"prompt": ..., "chosen": ..., "rejected": ...}` |
+
 ### 其他操作
 
 ```python
@@ -274,6 +384,12 @@ dt concat a.jsonl b.jsonl -o merged.jsonl
 
 # 数据统计
 dt stats data.jsonl
+
+# 数据验证
+dt validate data.jsonl --preset=openai_chat           # 使用预设 schema 验证
+dt validate data.jsonl --preset=alpaca --verbose      # 详细输出
+dt validate data.jsonl --preset=sharegpt --filter-invalid -o valid.jsonl  # 过滤出有效数据
+dt validate data.jsonl --preset=dpo --max-errors=100  # 限制错误输出数量
 ```
 
 ### 字段路径语法

{dtflow-0.4.2 → dtflow-0.5.0}/dtflow/__init__.py

@@ -4,6 +4,7 @@ DataTransformer: 简洁的数据格式转换工具
 核心功能:
 - DataTransformer: 数据加载、转换、保存
 - presets: 预设转换模板 (openai_chat, alpaca, sharegpt, dpo_pair, simple_qa)
+- schema: 数据结构验证 (Schema, Field)
 - tokenizers: Token 统计和过滤
 - converters: HuggingFace/OpenAI 等格式转换
 """
@@ -26,6 +27,23 @@ from .converters import (  # LLaMA-Factory 扩展; ms-swift
 )
 from .core import DataTransformer, DictWrapper, TransformError, TransformErrors
 from .presets import get_preset, list_presets
+from .schema import (
+    Field,
+    Schema,
+    ValidationError,
+    ValidationResult,
+    alpaca_schema,
+    dpo_schema,
+    openai_chat_schema,
+    sharegpt_schema,
+    validate_data,
+)
+from .framework import (
+    CompatibilityResult,
+    check_compatibility,
+    detect_format,
+    export_for,
+)
 from .storage import load_data, sample_file, save_data
 from .streaming import StreamingTransformer, load_sharded, load_stream, process_shards
 from .tokenizers import (
@@ -42,7 +60,7 @@ from .tokenizers import (
     token_stats,
 )
 
-__version__ = "0.4.2"
+__version__ = "0.5.0"
 
 __all__ = [
     # core
@@ -53,6 +71,21 @@ __all__ = [
     # presets
     "get_preset",
     "list_presets",
+    # schema
+    "Schema",
+    "Field",
+    "ValidationResult",
+    "ValidationError",
+    "validate_data",
+    "openai_chat_schema",
+    "alpaca_schema",
+    "dpo_schema",
+    "sharegpt_schema",
+    # framework
+    "CompatibilityResult",
+    "check_compatibility",
+    "detect_format",
+    "export_for",
     # storage
     "save_data",
     "load_data",

{dtflow-0.4.2 → dtflow-0.5.0}/dtflow/__main__.py

@@ -18,6 +18,7 @@ Commands:
     clean        数据清洗
     run          执行 Pipeline 配置文件
     history      显示数据血缘历史
+    validate     使用 Schema 验证数据格式
     mcp          MCP 服务管理（install/uninstall/status）
     logs         日志查看工具使用说明
 """
@@ -40,6 +41,7 @@ from .cli.commands import stats as _stats
 from .cli.commands import tail as _tail
 from .cli.commands import token_stats as _token_stats
 from .cli.commands import transform as _transform
+from .cli.commands import validate as _validate
 
 # 创建主应用
 app = typer.Typer(
@@ -64,10 +66,11 @@ def sample(
     by: Optional[str] = typer.Option(None, "--by", help="分层采样字段"),
     uniform: bool = typer.Option(False, "--uniform", help="均匀采样模式"),
     fields: Optional[str] = typer.Option(None, "--fields", "-f", help="只显示指定字段（逗号分隔）"),
+    raw: bool = typer.Option(False, "--raw", "-r", help="输出原始 JSON（不截断）"),
 ):
     """从数据文件中采样指定数量的数据"""
     actual_num = num_arg if num_arg is not None else num
-    _sample(filename, actual_num, type, output, seed, by, uniform, fields)
+    _sample(filename, actual_num, type, output, seed, by, uniform, fields, raw)
 
 
 @app.command()
@@ -77,11 +80,12 @@ def head(
     num: int = typer.Option(10, "--num", "-n", help="显示数量", show_default=True),
     output: Optional[str] = typer.Option(None, "--output", "-o", help="输出文件路径"),
     fields: Optional[str] = typer.Option(None, "--fields", "-f", help="只显示指定字段"),
+    raw: bool = typer.Option(False, "--raw", "-r", help="输出原始 JSON（不截断）"),
 ):
     """显示文件的前 N 条数据"""
     # 位置参数优先于选项参数
     actual_num = num_arg if num_arg is not None else num
-    _head(filename, actual_num, output, fields)
+    _head(filename, actual_num, output, fields, raw)
 
 
 @app.command()
@@ -91,11 +95,12 @@ def tail(
     num: int = typer.Option(10, "--num", "-n", help="显示数量", show_default=True),
     output: Optional[str] = typer.Option(None, "--output", "-o", help="输出文件路径"),
     fields: Optional[str] = typer.Option(None, "--fields", "-f", help="只显示指定字段"),
+    raw: bool = typer.Option(False, "--raw", "-r", help="输出原始 JSON（不截断）"),
 ):
     """显示文件的后 N 条数据"""
     # 位置参数优先于选项参数
     actual_num = num_arg if num_arg is not None else num
-    _tail(filename, actual_num, output, fields)
+    _tail(filename, actual_num, output, fields, raw)
 
 
 # ============ 数据转换命令 ============
@@ -208,6 +213,26 @@ def history(
     _history(filename, json)
 
 
+# ============ 验证命令 ============
+
+
+@app.command()
+def validate(
+    filename: str = typer.Argument(..., help="输入文件路径"),
+    preset: Optional[str] = typer.Option(
+        None, "--preset", "-p", help="预设 Schema: openai_chat, alpaca, dpo, sharegpt"
+    ),
+    output: Optional[str] = typer.Option(None, "--output", "-o", help="输出有效数据的文件路径"),
+    filter: bool = typer.Option(
+        False, "--filter", "-f", help="过滤无效数据并保存"
+    ),
+    max_errors: int = typer.Option(20, "--max-errors", help="最多显示的错误数量"),
+    verbose: bool = typer.Option(False, "--verbose", "-v", help="显示详细信息"),
+):
+    """使用预设 Schema 验证数据格式"""
+    _validate(filename, preset, output, filter, max_errors, verbose)
+
+
 # ============ 工具命令 ============