UPLOAD_CHECKLIST.md

Hugging Face 上传检查清单

✅ 清理完成

已删除的文件类型

• __pycache__/ 文件夹
• *.pyc, *.pyo, *.pyd 文件
• .DS_Store 文件（macOS）
• .vscode/, .idea/ 文件夹
• *.swp, *.swo 文件

需要手动检查的项目

1. 大文件检查

   • 检查是否有超过50MB的文件
   • 考虑使用 Git LFS 或排除这些文件

2. 敏感信息检查

   • 检查是否有API密钥、密码等敏感信息
   • 检查配置文件中的敏感数据

3. 数据文件

   • 检查 examples/data/ 目录
   • 如果数据文件很大，考虑排除或使用外部链接

4. 模型文件

   • 检查是否有预训练模型文件
   • 大模型文件应使用 Git LFS 或 Hugging Face Model Hub

5. 日志文件

   • 确保没有日志文件被包含
   • 检查 log/, logs/ 目录

📦 上传到 Hugging Face

方法1: 使用 Hugging Face CLI

# 安装 Hugging Face CLI
pip install huggingface_hub

# 登录
huggingface-cli login

# 创建仓库（如果还没有）
# 在 https://huggingface.co/new 创建新仓库

# 上传文件
cd /path/to/EasyTemporalPointProcess-main
huggingface-cli upload <your-username>/<repo-name> . --repo-type dataset

方法2: 使用 Git

# 初始化 Git 仓库（如果还没有）
git init
git add .
git commit -m "Initial commit"

# 添加 Hugging Face 远程仓库
git remote add origin https://huggingface.co/<your-username>/<repo-name>

# 推送
git push origin main

方法3: 使用 Web 界面

1. 访问 https://huggingface.co/new
2. 创建新的 Dataset 或 Space
3. 使用 Web 界面上传文件

📝 文件结构说明

EasyTemporalPointProcess-main/
├── easy_tpp/              # 核心库代码
├── examples/              # 示例代码
├── notebooks/            # Jupyter notebooks
├── tests/                # 测试代码
├── docs/                 # 文档
├── compute_cascade_metrics.py  # 新增：级联指标计算脚本
├── COMPUTE_METRICS_README.md   # 新增：指标计算说明
├── requirements.txt      # 基础依赖
├── requirements_compute_metrics.txt  # 新增：指标计算依赖
├── setup.py              # 安装脚本
└── README.md             # 项目说明

⚠️ 注意事项

1. 不要上传大文件到 Git 仓库

   • 使用 Git LFS 或 Hugging Face 的存储系统
   • 考虑使用外部链接引用大文件

2. 检查许可证

   • 确保所有代码都有适当的许可证
   • 检查第三方依赖的许可证兼容性

3. README 文件

   • 确保 README.md 清晰说明项目用途
   • 包含安装和使用说明

4. 依赖管理

   • 确保 requirements.txt 是最新的
   • 考虑使用 pip freeze 生成精确版本

🔍 验证上传

上传后，检查：

• 所有文件都已上传
• 文件大小合理
• 没有敏感信息泄露
• README 显示正确
• 代码可以正常下载和使用