Repository navigation
docs(cli): clarify benchmark command availability - #3931
Draft
anomalibbot wants to merge 2 commits into
Draft
anomalibbot wants to merge 2 commits into
anomalibbot wants to merge 2 commits into
Conversation
Signed-off-by: anomalibbot <354490964+anomalibbot@users.noreply.github.com>
Signed-off-by: anomalibbot <354490964+anomalibbot@users.noreply.github.com>
This branch has not been deployed
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.
📝 Description
Documentation discrepancies
docs/source/markdown/guides/reference/cli/index.md: The CLI reference presentsanomalib benchmarkas universally available, but the implementation registers the benchmark pipeline only whenanomalib.pipelinesis available. Qualifying the entry prevents users of installations without pipeline support from assuming the subcommand exists.anomalib/src/anomalib/cli/pipelines.py
Line 19 in 437669f
Scope
Documentation only, checked against
437669f437b0d552c7d8382316e49cbaff574ce8onmain. No application, test, API behavior or workflow changes.Checks performed
git diff --no-index --check --no-ext-diff --no-textconvon the proposed text: passed.Not run: full Sphinx build or application/example tests; repository code and dependencies were not executed by this workflow.
✨ Changes
Select what type of change your PR is:
✅ Checklist
Before you submit your pull request, please make sure you have completed the following steps:
For more information about code review checklists, see the Code Review Checklist.