rajatsainju2025/code-explainer

examples: Add Google Colab quickstart notebook

Aperta

#5 aperta il 8 ago 2025

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Python (0 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (1 stella)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Configurare il progetto in Google Colab, seguire la guida introduttiva e creare un notebook che mostri l'installazione con pip, l'addestramento, la valutazione e l'optional serving. Aggiornare il README con un badge che punta al notebook.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85