rajatsainju2025/code-explainer

examples: Add Google Colab quickstart notebook

Open

#5 opened on Aug 8, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (0 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Set up the project in Google Colab, follow the quickstart guide, and create a notebook that demonstrates pip installation, training, evaluation, and optional serving. Update the README with a badge link to the notebook.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85