rajatsainju2025/code-explainer

examples: Add Google Colab quickstart notebook

オープン

#5 opened on 2025/08/08

 (0 件のコメント) (0 件のリアクション) (0 人の担当者)Python (0 件のフォーク)auto 404
documentationgood first issue

Repository metrics

Stars
 (1 個のスター)
PR merge metrics
 (30d に merged 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

コントリビューターガイド