Repository navigation
docs: add licensing note, container run, response samples, CI checks - #1
Merged
Merged
Conversation
saugataroyarghya
commented
Oct 11, 2026
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.