QVAC-23970 feat[api]: describe NMT modelConfig union arms - #4066
Open
lauripiisang wants to merge 1 commit into
Open
QVAC-23970 feat[api]: describe NMT modelConfig union arms#4066lauripiisang wants to merge 1 commit into
lauripiisang wants to merge 1 commit into
Conversation
Contributor
Review StatusCurrent Status: ❌ PENDING Pending reviews: Needs 1 Management or Team Lead, and 1 more from Management, Team Lead, or Member. |
Contributor
License compliance — cleanNo new dependency license findings in this PR. Warn-only (shadow) mode — this check does not block merges yet. Updated automatically by the canonical license compliance workflow. NOTICE presence (advisory)Missing NOTICE (advisory, does not block):
|
- Add .describe() to the shared generation params (mode, beamsize, lengthpenalty, maxlength, repetitionpenalty, norepeatngramsize, temperature, topk, topp), both engine arms (engine/from/to, Bergamot srcVocabSrc/dstVocabSrc/normalize/pivotModel), and the pivot-model sub-fields - Semantics from @qvac/translation-nmtcpp README; describes state this schema's transform defaults (not the README example values) - Regenerate contract/schema.json and the Python generated models
lauripiisang
force-pushed
the
QVAC-23970-describe-nmt
branch
from
August 26, 2026 14:37
a6d01c1 to
676121f
Compare
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.
🎯 What problem does this PR solve?
nmtcpp-translation) load-timemodelConfig— a discriminated union of the Bergamot and IndicTrans arms plus shared generation params — shipped without descriptions, so the generated contract (consumed byqvac configureand the generated clients) couldn't say what any field means.📝 How does it solve it?
.describe()to the shared generation params (mode,beamsize,lengthpenalty,maxlength,repetitionpenalty,norepeatngramsize,temperature,topk,topp), both engine arms (engine,from,to; BergamotsrcVocabSrc/dstVocabSrc/normalize/pivotModel), and the pivot-model sub-fields.@qvac/translation-nmtcppREADME. Descriptions state this schema's transform defaults (temperature0.3,topk0,maxlength512, …), not the README's example values.modeis a JS-side selector currently fixed to'full'.contract/schema.jsonand the Python generated models.Part of QVAC-23933.
🧪 How was it tested?
bun run contract:exportregenerated;contract:check,typecheck,lint,format, and fulltest:unit(incl. contract-export freshness) pass.packages/inferencetypecheck+lintpass.packages/sdk-pythongenerate.py --checkpasses.🔌 API Changes
Additive only: