[Docs] Fix CLI examples and README inaccuracies#404
Open
huguesva wants to merge 2 commits intogalilai-group:mainfrom
Open
[Docs] Fix CLI examples and README inaccuracies#404huguesva wants to merge 2 commits intogalilai-group:mainfrom
huguesva wants to merge 2 commits intogalilai-group:mainfrom
Conversation
The README showed 'spt config.yaml' but the CLI requires 'spt run config.yaml' since 'run' is a Typer subcommand.
- OnlineProbe: rename `loss_fn` to `loss` to match actual API - OnlineKNN: add required `metrics` param to quick example - Installation: remove references to nonexistent optional dependency groups (vision, tracking, cluster, etc.) — only `dev` exists
huguesva
changed the title
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
sptCLI examples to usespt runsubcommand (required by Typer)OnlineProbeparameter name:loss_fn→lossto match actual APIOnlineKNNquick example: add requiredmetricsparametervision,tracking,cluster, etc.) — onlydevexists in pyproject.tomlTest plan
spt --helpshowsrunas required subcommandOnlineProbe.__init__signature useslossparameterOnlineKNN.__init__requiresmetricsas non-optionaldevgroup exists in[project.optional-dependencies]