docs(readme): restructure for beginner clarity and expand API sections#136
Merged
DeepKnowledge1 merged 2 commits intomainfrom Mar 13, 2026
Merged
docs(readme): restructure for beginner clarity and expand API sections#136DeepKnowledge1 merged 2 commits intomainfrom
DeepKnowledge1 merged 2 commits intomainfrom
Conversation
Reorganised Quickstart into a linear 4-step flow (install → dataset → train → detect) so first-time users have a single path to follow with no decisions required. Moved Python API, REST API, and Tasks & Modes out of the Quickstart wall-of-text into their own named sections. - Replace parallel install options (A/B/C) with one linear path + GPU as one-liner - Add dataset folder structure and MVTec download command before any code runs - Add REST API context (start server first) — previously missing - Expand Python API into annotated single block with step headers and output shape comments - Wrap Python API and REST API in <details> collapsible blocks - Restore Tasks & Modes table and per-category MVTec breakdown that were dropped
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
Restructured README for beginner clarity — the previous version mixed install
options, Python API, CLI, and REST API under a single Quickstart heading with
no clear path for a first-time user.
<details>collapsible blocks🔄 Type of Change
🧪 Hardware & Matrix Testing
I have successfully built and tested this code using
uvon:anomavision[cpu](Standard/Edge)anomavision[cu121](CUDA 12.1)anomavision[cu124](CUDA 12.4)anomavision[cu118](CUDA 11.8)Host OS used for testing:
✅ Developer Checklist
uv run pytestand all unit tests pass locally.pyproject.toml, I have runuv lock --python 3.10and committed the updateduv.lockfile.📸 Screenshots / Visual Proof (Optional)