feat(examples): make canonical SIE examples classroom-ready#213
Open
svonava wants to merge 4 commits into
Open
feat(examples): make canonical SIE examples classroom-ready#213svonava wants to merge 4 commits into
svonava wants to merge 4 commits into
Conversation
Contributor
Author
|
@coderabbitai review |
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.
Supports sie-internal#1963 by improving canonical SIE examples instead of creating course-specific forks.
Summary
The same examples now support a short classroom path while remaining useful to every SIE user. Connection changes are configuration only: local SIE, a self-deployed gateway, and managed SIE all use the public SDK.
Changes
Quickstart
examples/quickstart/quickstart.py: oneSIEClientand oneencodecall, with no custom HTTP or JSON plumbing.QuickStartTestand concise local/self-deployed/managed setup.SIE_CLUSTER_URLand optionalSIE_API_KEY, starting a local server only when no remote endpoint is configured.Retrieval ablation
benchmark_ablation.py --sample, reusing the canonical NDCG@10, MRR@10, and Recall@10 evaluator.Vision document RAG
data/sample/without changing the primary page manifest.--pages-manifestso the canonical ingest pipeline can consume either corpus.Contract review
There is no ABI/course-only package, manifest, schema, model-budget placeholder, or duplicated example implementation.
Validation
uv sync --frozen,uv run make-sample, anduv run review --listpassed.git diff --checkpassed.Live managed execution remains a release/acceptance step once the managed endpoint, active account, API key, and selected catalog models are available; this PR does not claim that validation has happened.