rajatsainju2025/code-explainer

examples: Add Google Colab quickstart notebook

Aberta

#5 aberto em 8 de ago. de 2025

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)Python (0 fork)auto 404
documentationgood first issue

Métricas do repositório

Stars
 (1 estrela)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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

Guia do colaborador

Direção de pesquisa
Configure o projeto no Google Colab, siga o guia de início rápido e crie um notebook que demonstre a instalação via pip, treinamento, avaliação e a option serving. Atualize o README com um badge apontando para o notebook.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85