rajatsainju2025/code-explainer

docs: Add model presets table to README with commands

Open

#6 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

Enhance README with a quick presets table (DistilGPT-2, CodeT5 Small/Base, CodeGPT, StarCoderBase-1B) and example train/eval commands. Reference examples/README.md for details.

Labels: good first issue, documentation

Contributor guide

Research direction
Refer to examples/README.md to extract the training and evaluation commands for the listed models, then add a presets table to the main README.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85