rajatsainju2025/code-explainer

examples: Add Google Colab quickstart notebook

Ouverte

#5 ouverte le 8 août 2025

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Python (0 fork)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (1 étoile)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Configurez le projet dans Google Colab, suivez le guide de démarrage rapide et créez un notebook montrant l'installation via pip, l'entraînement, l'évaluation et le service optionnel. Mettez à jour le README avec un badge pointant vers le notebook.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85