Skip to content

QVAC-17907 chore: adopt canonical model type names in SDK docs, examples, and tests#2623

Merged
arun-mani-j merged 1 commit into
tetherto:mainfrom
arun-mani-j:preferCanonical
Jun 18, 2026
Merged

QVAC-17907 chore: adopt canonical model type names in SDK docs, examples, and tests#2623
arun-mani-j merged 1 commit into
tetherto:mainfrom
arun-mani-j:preferCanonical

Conversation

@arun-mani-j

Copy link
Copy Markdown
Contributor

🎯 What problem does this PR solve?

  • The public SDK surface still taught legacy alias model-type names ("llm", "whisper", "diffusion", ...) in the README, the loadModel reference docs, an example, and assorted tests. These aliases are deprecated (they log a warning and normalize to canonical), so teaching them weakens API clarity.

📝 How does it solve it?

  • README quickstart now omits modelType entirely — it's inferred from the LLAMA_3_2_1B_INST_Q4_0 registry descriptor's engine — demonstrating the preferred descriptor-driven pattern.
  • client/api/load-model.ts TSDoc (param doc + all @example blocks) uses canonical names and notes modelType may be omitted for registry descriptors. This TSDoc generates the published API reference.
  • examples/diffusion-img2vid.ts: "diffusion""sdcpp-generation" (kept explicit since modelSrc can be a plain CLI path with no metadata).
  • schemas/model-types.ts docstring leads with the canonical accessor and labels the alias as deprecated.
  • Tests: migrated incidental alias usages to canonical across bci/vla/classification/sdcpp/profiler/inference-handler-migrations and the pr-body-bc-valid fixture. Left aliases only in the five tests that specifically verify the alias mechanism (accepts alias / resolves alias / rejects alias for plugins).
  • No change to the alias mechanism itself or the deprecation warning — aliases remain accepted for backward compatibility. The registry addon search facet (a separate taxonomy incl. vad/other) is untouched.

🧪 How was it tested?

  • bun run build — lint, typecheck, compile clean.
  • bun run test:unit — all files pass.
  • bun run test:bare — 43/43 tests, 207/207 asserts pass.

@arun-mani-j arun-mani-j requested review from a team as code owners June 16, 2026 11:23
@arun-mani-j arun-mani-j added test-e2e-smoke Triggers smoke e2e test suite [Currently SDK-only] verified Authorize secrets / label-gate in PR workflows labels Jun 16, 2026
@arun-mani-j arun-mani-j added test-e2e-smoke Triggers smoke e2e test suite [Currently SDK-only] and removed test-e2e-smoke Triggers smoke e2e test suite [Currently SDK-only] labels Jun 18, 2026
@github-actions

github-actions Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

QVAC E2E — android — ✅ all tests passed (86/98, 2896s)

Config: suite=smoke · filter=(none) · exclude=(none)
View run · Artifacts: reports · Device Farm logs

@github-actions

github-actions Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

QVAC E2E — windows — ✅ all tests passed (98/98, 428s)

Config: suite=smoke · filter=(none) · exclude=(none)
View run · Artifacts: reports

@github-actions

github-actions Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

QVAC E2E — linux — ✅ all tests passed (98/98, 256s)

Config: suite=smoke · filter=(none) · exclude=(none)
View run · Artifacts: reports

@github-actions

github-actions Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

QVAC E2E — macos — ✅ all tests passed (98/98, 273s)

Config: suite=smoke · filter=(none) · exclude=(none)
View run · Artifacts: reports

@github-actions

github-actions Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

QVAC E2E — ios — ✅ all tests passed (84/98, 955s)

Config: suite=smoke · filter=(none) · exclude=(none)
View run · Artifacts: reports · Device Farm logs

@github-actions github-actions Bot added the e2e-tested Test suite has run on this PR. Does not indicate tests pass/fail - see results in comments. label Jun 18, 2026
Comment thread packages/sdk/client/api/load-model.ts
Signed-off-by: Arun Mani J <j.arunmani@proton.me>
@arun-mani-j

Copy link
Copy Markdown
Contributor Author

review

@github-actions

Copy link
Copy Markdown
Contributor

Tier-based Approval Status

**PR Tier:** TIER1

**Current Status:** ✅ APPROVED

**Requirements:**
- 1 Team Member approval ✅ (1/1)
- 1 Team Lead OR Management approval ✅ (1/1)



---
*This comment is automatically updated when reviews change.*

@arun-mani-j arun-mani-j merged commit 8823b69 into tetherto:main Jun 18, 2026
12 checks passed
@arun-mani-j arun-mani-j deleted the preferCanonical branch June 23, 2026 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

e2e-tested Test suite has run on this PR. Does not indicate tests pass/fail - see results in comments. test-e2e-smoke Triggers smoke e2e test suite [Currently SDK-only] verified Authorize secrets / label-gate in PR workflows

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants