Repository navigation
[Docs] Index Ouro and Nanbeige validation evidence - #161
Open
dorodo0721 wants to merge 1 commit into
Open
dorodo0721 wants to merge 1 commit into
dorodo0721 wants to merge 1 commit into
Conversation
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.
Required human contributor answers
The existing human request and contributor claim define this documentation scope:
issue #124 and
the contributor's claim.
1. What outcome are you trying to achieve?
Issue #124 asks: “Please add a documentation section linking the available validation scripts, benchmark commands, execution logs and raw results for Ouro and Nanbeige, together with the corresponding code commits, model revisions and runtime configurations.” This PR adds that index for Ouro-1.4B and Nanbeige4.2-3B.
2. What is the highest-leverage variable for that outcome?
The requester identifies the evidence-discovery gap: “I found the performance summaries in #30/#31 and the integration tests in #77/#119, but could not locate a complete public validation package for these models.” The contributor's claim focuses on linking existing material and identifying missing or unpublished evidence.
3. How will this work move that variable rather than create busywork?
The contributor's stated approach is a “validation and reproducibility index,” linking reference/native checks, accuracy tools, benchmark commands and public artifacts, recording versions/configurations/scope, and “clearly identify[ing] missing or unpublished evidence.” The index provides those entry points and separates source code, historical reports, verified downloadable artifacts and unavailable raw files.
4. Who is the customer or user, and what do they actually need?
The requester of #124 needs the four evidence categories listed in the issue: HF/reference-vs-native scripts/results; accuracy scripts and per-example outputs; benchmarks, logs and raw results; and matching code/model/configuration identities. They also ask for “a minimal reproducible validation recipe.” The index addresses that stated need without treating missing artifacts as available evidence.
PR necessity and bugfix evidence
A PR is needed to add the documentation section requested in #124 to the maintained repository. The contributor's linked claim explicitly limits the work to documentation and an audit of existing material, with no new GPU experiments or accuracy/performance claims.
The existing accuracy example also omitted two required arguments. Running its original
prepare --model /path/to/ouro --output ...command locally exits 2 before any preparation or inference:The example now supplies both. This is a documentation correction; inference and evaluation code are unchanged.
Purpose
Closes #124.
docs/validation.md, linked from the documentation index, model-support table and accuracy guide.No runtime, model, measurement or test implementation changes. No weights were downloaded and no checkpoint inference or GPU/NPU experiments were run.
Test Plan
vllm-rlt Version / Commit: runtime/source audit at
989921ac1d3897c5c43e27ec8cddbc91fa953194; documentation commit6b03a295f8ec1ab5cf4b7c5a2f479d66f01aa4ec.pre-commit run --all-files --verbose: Ruff lint, Ruff format and the CPU regression suite.git diff --check.--plan-only; verify the two existing public profiling downloads without running inference.Test Result
lm_eval, and seven requiring official tokenizer/code/weight assets. These do not establish real-checkpoint or device qualification.