README_zh.md

# PHPWind 验证码数据集

用于在已获授权的 PHPWind 部署上训练、评估 OCR 的四位数字验证码标注图片。仓库按验证码的
视觉来源分别保存数据集，避免把不同版本、分支、主题或生成器的样本静默混在一起。

**English version**: [README.md](README.md)

**关联模型**：[FlanChanXwO/phpwind-captcha-ocr](https://huggingface.co/FlanChanXwO/phpwind-captcha-ocr)

## 数据集目录

| 数据集 ID | 部署或版本标识 | 状态 | 图片数 | 说明 |
|---|---|---|---:|---|
| `legacy-footer-v0.7-beta` | 目标部署页脚标识 `v0.7β` | 已发布 | 997 | 当前仓库中唯一已发布的数据集。页脚文字只是观测到的部署标识，不能视为 PHPWind 官方发布版本号。 |
| `phpwind-v7` | PHPWind v7 | 预留 | — | 仅在收集并标注一组独立、已获授权的 v7 样本后创建。 |
| `phpwind-v8` | PHPWind v8 | 预留 | — | 仅在收集并标注一组独立、已获授权的 v8 样本后创建。 |

`legacy-footer-v0.7-beta` 是关联模型当前参考指标对应的训练数据范围；它**不**表示模型已对
其他 PHPWind 发行版、分支、主题或验证码生成器完成兼容性验证。

## 仓库结构

```text
datasets/
├── index.json                         # 已发布数据集目录
└── legacy-footer-v0.7-beta/
    ├── metadata.json                  # 来源、版本边界与数据集属性
    ├── labels.json                    # 文件名到标签的映射
    └── images/                        # 验证码 PNG 图片
```

未来每一个版本数据集都应使用相同的隔离结构，例如：

```text
datasets/phpwind-v7/
├── metadata.json
├── labels.json
└── images/
```

不要将 v7、v8、自定义主题或分支的样本放进
`legacy-footer-v0.7-beta/images/`。每一种视觉上不同的生成器都应使用单独目录并登记到索引。

## 当前数据集详情

| 属性 | 值 |
|---|---|
| 数据集 ID | `legacy-footer-v0.7-beta` |
| 验证码格式 | 四位数字（`0`–`9`） |
| 图片数 | 997 张 PNG |
| 标签 | 每张图片在 `labels.json` 中有一条记录 |
| 图片路径 | `datasets/legacy-footer-v0.7-beta/images/` |
| 标签路径 | `datasets/legacy-footer-v0.7-beta/labels.json` |
| 来源边界 | 页脚显示为 `v0.7β` 的目标部署 |

`labels.json` 以文件名为 key；每条记录包含最终 `label`、标注投票 `votes`、投票数 `count`
与一致性标识 `agreed`。图片相对路径为 `images/<filename>`。

```json
{
  "b1_0000.png": {
    "label": "9125",
    "votes": ["9125"],
    "count": 1,
    "agreed": true
  }
}
```

## 增加新版数据集

1. 创建 `datasets/<dataset-id>/images/`。只有在有授权证据确认版本后，才使用
   `phpwind-v7`、`phpwind-v8` 这类版本 ID。
2. 只放入该生成器的图片，并建立独立的 `labels.json`；文件名只需在本数据集目录内唯一。
3. 写入 `metadata.json`：观测到的版本或部署标识、验证码格式、图片数、采集来源与已知的
   视觉定制信息。不要仅根据主题页脚推断官方版本。
4. 更新 `datasets/index.json` 与上方目录表，并记录标签是否经过独立复核。
5. 先按版本分别训练和评估。只有在明确记录多版本实验及各版本结果时，才合并数据集。

## 负责任使用与许可证

只应使用自有或已明确获授权测试的部署所产生的验证码图片。不得将该数据集用于自动化账户
登录或绕过访问控制。数据集采用 [GNU AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html) 许可。