rajatsainju2025/code-explainer

examples: Add Google Colab quickstart notebook

開放

#5 建立於 2025年8月8日

在 GitHub 查看貢獻者指南
 (0 則留言) (0 個反應) (0 位負責人)Python (0 個分叉)auto 404
documentationgood first issue

倉庫指標

星標
 (1 顆星)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

Create a Colab notebook under examples/ that demonstrates:

  • pip install -e . or pip install from GitHub
  • Training with configs/default.yaml on tiny data
  • Evaluation with code-explainer eval
  • Serving via cx-serve (optional)
  • Link back to examples/README.md

Deliverables: examples/colab_quickstart.ipynb and a badge in README.md pointing to it.

Labels: good first issue, documentation

貢獻者指南

研究方向
在 Google Colab 中設置專案，按照快速入門指南建立筆記本，示範 pip 安裝、訓練、評估以及可選的推理服務。更新 README，添加指向筆記本的徽章連結。
技術棧
python
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
新近可參與
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
PythonGit
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85