Upload README.md with huggingface_hub

README.md

@@ -1,52 +1,68 @@
-# humaneval-leetcode
+---
+language:
+  - en
+  - zh
+license: mit
+size_categories:
+  - 1K<n<10K
+pretty_name: HumanEval-LeetCode Input-Only
+configs:
+  - config_name: default
+    data_files:
+      - split: train
+        path: "train.jsonl"
+      - split: test
+        path: "test.jsonl"
+---
 
-本项目用于生成并上传 HumanEval 风格的 LeetCode 数据集。
+# HumanEval-LeetCode Input-Only
 
-## 上传到 Hugging Face
+本数据集由 LeetCode 题目自动转换而来，目标是生成 HumanEval 风格的 **Input-Only** 提示（prompt）。每条样本包含题目描述与函数签名，描述中的 Input/Output 被转换成 `>>> func(...)` / `>>> output` 的交互式示例，便于直接用于代码生成评测或训练。
 
-### 1) 安装依赖
+## 数据格式
 
-需要 `huggingface_hub`：
+每行是一个 JSON 对象（JSONL）：
 
-```bash
-pip install huggingface_hub
-```
+- `task_id`：题目唯一标识
+- `prompt`：包含函数签名与 docstring 的完整提示
 
-### 2) 登录（任选其一）
+示例字段：
 
-- 环境变量：
+- `task_id`: string
+- `prompt`: string
 
-```bash
-export HF_TOKEN=your_hf_token
-```
+## 生成流程（概述）
 
-- 或使用 CLI 登录：
+1. 读取 LeetCode 题目（题目描述 + starter code）。
+2. 提取函数名。
+3. 将题目描述中的 Input/Output 转为：
+   - `>>> func(inputs...)`
+   - `>>> output`
+4. 输出为 JSONL。
 
-```bash
-huggingface-cli login
-```
+## 数据划分
 
-### 3) 运行上传脚本
+- `train.jsonl`
+- `test.jsonl`
 
-假设你的数据在根目录，并且文件命名为 `train.jsonl` / `test.jsonl`：
+## 使用方式
 
-```bash
-python scripts/upload_to_hf_dataset.py \
-  --repo-id your-username/your-dataset \
-  --data-dir .
-```
+Python 读取示例：
 
-如果你的文件名不同，可以用 `--patterns` 指定：
+```python
+import json
 
-```bash
-python scripts/upload_to_hf_dataset.py \
-  --repo-id your-username/your-dataset \
-  --data-dir . \
-  --patterns train.jsonl test.jsonl
+with open("train.jsonl", "r", encoding="utf-8") as f:
+    for line in f:
+        item = json.loads(line)
+        print(item["task_id"], item["prompt"][:80])
+        break
 ```
 
-### 自动识别说明
+## 许可协议
+
+MIT
 
-Hugging Face 会自动识别 JSONL/CSV/Parquet 等常见格式，并根据文件名（如 `train.jsonl`、`test.jsonl`）自动划分 splits。
+## 引用
 
-如需更复杂的加载逻辑，需提供自定义 dataset script。
+如果使用该数据集，请注明来源或引用本项目。