rajatsainju2025/code-explainer

Add CodeT5 preset docs and README section on model presets

Open

#3 opened on Aug 8, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (0 forks)auto 404
good first issuehelp wanted

Repository metrics

Stars
 (1 star)
PR merge metrics
 (No merged PRs in 30d)

Description

Document new presets: configs/codet5-small.yaml, configs/codet5-base.yaml, configs/starcoderbase-1b.yaml, and CodeGPT-small (as CodeBERT generation stand-in). Add a README section with a table showing arch, model name, and recommended usage. Include guidance to switch defaults via configs/default.yaml.

Contributor guide

Research direction
Create YAML files for each preset and add a table to README.md with columns for architecture, model name, and recommended usage. Show how to change defaults via configs/default.yaml.
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85