Skip to content

docs: add licensing note, container run, response samples, CI checks - #1

Merged
saugataroyarghya merged 1 commit into
mainfrom
docs/readme-licensing-container
Oct 11, 2026
Merged

saugataroyarghya merged 1 commit into
mainfrom
docs/readme-licensing-container

Conversation

@saugataroyarghya

Copy link
Copy Markdown
Owner
  • Surface the unresolved model licensing and the lack of a code license at the top of the README instead of only in the last line.
  • Document building and running the container: required IELTS_API_KEY, weights embedded at containerize time, CPU vs CUDA behaviour.
  • Add sample writing and speaking responses, validated against the pydantic schemas, with the TR/CC/LR/GRA key mapping and the meaning of scores vs raw_scores vs speaking_band.
  • Make the development commands mirror CI (ruff format, requirements check), explain that requirements.txt is generated from uv.lock, and list the missing root files in the code layout.

- Surface the unresolved model licensing and the lack of a code license
  at the top of the README instead of only in the last line.
- Document building and running the container: required IELTS_API_KEY,
  weights embedded at containerize time, CPU vs CUDA behaviour.
- Add sample writing and speaking responses, validated against the
  pydantic schemas, with the TR/CC/LR/GRA key mapping and the meaning
  of scores vs raw_scores vs speaking_band.
- Make the development commands mirror CI (ruff format, requirements
  check), explain that requirements.txt is generated from uv.lock, and
  list the missing root files in the code layout.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@saugataroyarghya
saugataroyarghya merged commit 6dc5fea into main Oct 11, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant