QUICK_START_HF.md

# 快速开始：上传到 Hugging Face

## ✅ 整理完成

文件夹已整理完成，可以上传到 Hugging Face。

**文件夹大小**: 1.3MB（适合上传）

## 📋 整理内容

### 已完成的清理
- ✅ 更新了 `.gitignore` 文件
- ✅ 创建了清理脚本 `cleanup_for_hf.py`
- ✅ 检查了大文件（无大文件）
- ✅ 创建了上传指南

### 新增文件
- `compute_cascade_metrics.py` - 级联指标计算脚本
- `COMPUTE_METRICS_README.md` - 指标计算说明
- `HF_UPLOAD_GUIDE.md` - 上传指南
- `ADDITIONS_README.md` - 新增功能说明
- `cleanup_for_hf.py` - 清理脚本
- `requirements_compute_metrics.txt` - 额外依赖

## 🚀 三步上传

### 步骤1: 安装 Hugging Face CLI

```bash
pip install huggingface_hub
```

### 步骤2: 登录

```bash
huggingface-cli login
# 输入你的 token（在 https://huggingface.co/settings/tokens 获取）
```

### 步骤3: 创建仓库并上传

```bash
# 1. 在网页上创建仓库
# 访问 https://huggingface.co/new
# 选择 "Dataset"，命名为例如：easytpp-cascade-metrics

# 2. 上传文件
cd /Users/chenshuyi/Downloads/EasyTemporalPointProcess-main
huggingface-cli upload <your-username>/easytpp-cascade-metrics . --repo-type dataset
```

## 📥 在云电脑上下载

```bash
# 方法1: 使用 CLI
huggingface-cli download <your-username>/easytpp-cascade-metrics --local-dir ./EasyTPP

# 方法2: 使用 Git
git clone https://huggingface.co/datasets/<your-username>/easytpp-cascade-metrics
cd easytpp-cascade-metrics
```

### ⚠️ 重要：数据文件需要单独获取

代码仓库**不包含**数据文件（已通过 .gitignore 排除，因为文件太大）。

数据文件需要单独传输：

```bash
# 在云电脑上创建目录
mkdir -p data/cascades

# 方法1: 使用 scp 从本地传输（推荐）
scp user@local-machine:/path/to/information_cascade*.json ./data/cascades/

# 方法2: 如果已上传到 Hugging Face Dataset Hub
huggingface-cli download <username>/cascade-data --local-dir ./data/cascades
```

详细说明请参考 `DATA_FILES_NOTICE.md`

## 📚 相关文档

- **详细上传指南**: `HF_UPLOAD_GUIDE.md`
- **数据文件说明**: `DATA_FILES_NOTICE.md` ⚠️ **重要**
- **指标计算说明**: `COMPUTE_METRICS_README.md`
- **新增功能**: `ADDITIONS_README.md`
- **上传检查清单**: `UPLOAD_CHECKLIST.md`

## ⚠️ 注意事项

1. **文件大小**: 当前文件夹 1.3MB，无需 Git LFS
2. **敏感信息**: 已检查，无敏感信息
3. **依赖**: 确保 `requirements.txt` 和 `requirements_compute_metrics.txt` 已包含

## 🎯 下一步

1. 按照上述步骤上传到 Hugging Face
2. 在云电脑上下载并测试
3. 运行 `compute_cascade_metrics.py` 计算指标

---

**准备好了！可以开始上传了！** 🎉