docs(models): remove misleading Index column from output tables (#1009)#1358
Open
mvanhorn wants to merge 1 commit intogoogle:mainfrom
Open
docs(models): remove misleading Index column from output tables (#1009)#1358mvanhorn wants to merge 1 commit intogoogle:mainfrom
mvanhorn wants to merge 1 commit intogoogle:mainfrom
Conversation
…le#1009) The Index column in the 'List of possible outputs' table implied these numbers were the model's softmax indexes, but they are not. The real source of truth is the model's config target labels. Removes the Index column from the first table in each model README (standard_v2_0, v2_1, v3_0, v3_1, v3_2, v3_3 and the mirrored copy under python/src/magika/models/). The second table ('List of possible model's outputs') intentionally uses real model indices and is unchanged. Per maintainer consensus in google#1009: @reyammer: 'we should likely just remove them' @ia0: '+1 to remove them' Fixes google#1009
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
1 participant
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.
Summary
Removes the misleading
Indexcolumn from the "List of possible outputs" table in every model README. Keeps the second table ("List of possible model's outputs") untouched because those indices are real softmax positions.Why this matters
From #1009 (opened by @reyammer):
@ia0 in thread: "+1 to remove them, they seem to have to significance"
The first table documents the tool-level outputs (
MagikaResult.prediction.output.label). Its row numbers were purely positional and were consistently being misread as model-internal IDs. Removing the column makes the contract match reality.Changes
Removes the
Indexcolumn from the first table in:assets/models/standard_v2_0/README.mdassets/models/standard_v2_1/README.mdassets/models/standard_v3_0/README.mdassets/models/standard_v3_1/README.mdassets/models/standard_v3_2/README.mdassets/models/standard_v3_3/README.mdpython/src/magika/models/standard_v3_3/README.md(mirrored copy)The second table in each v3_x README ("List of possible model's outputs") is left as-is because those indices legitimately correspond to model outputs per the existing prose.
standard_v1has no such table and is unchanged.Testing
Diff is a pure column drop. No generator script produces these files (grepped
python/scripts/sync.py,assets/, and scripts directories for any "List of possible outputs" producer, none found) so no generator update is needed.Fixes #1009
This contribution was developed with AI assistance (Codex + Claude Code).