34 Commits
Author SHA1 Message Date
Jirka Borovec 2abdccbe1d docs: Wrap all placeholder paths in quotes and code expressions (#2128)
* Wrap all placeholder paths in quotes across documentation and code examples for consistency
* Update pre-commit config to exclude `docs/deprecated.md` from mdformat check
2026-02-03 14:00:40 +01:00
a5b51a11e5 Chore CI by adding checks for links and references (#2113)
* Chore CI by adding checks for links and references
* Potential fix for code scanning alert no. 6: Workflow does not contain permissions
* Fix markdown image formatting in metrics documentation
* Update all `docs` links to use absolute URLs and fix broken references in documentation and workflows.
* Fix broken `albumentations` links in dataset processing documentation
* lycheeVersion: v0.22.0
* Refactor CI link check workflow to use lychee config file for cleaner argument management
* add TODOs for future file type support
* Fix header formatting for example plots across metric files

---------

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-02 17:01:19 +01:00
Onuralp SEZER 78f17cba2e chore: 🧹 clean up documentation and improve formatting
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-09-27 14:18:26 +03:00
LinasKo 95add3679d Fix broken or outdated links
* Not exhaustive.
2024-09-18 19:06:41 +03:00
LinasKo 28f83b18f9 Deprecate BoundingBoxAnnotator, rename to BoxAnnotator 2024-07-12 18:18:50 +03:00
LinasKo 13b46dda67 Update "New" tags in docs, fix typo in one heading 2024-06-05 17:44:25 +02:00
SkalskiP 77793571b0 major docs refactor 2024-04-24 15:39:08 +02:00
SkalskiP 574c61b6b0 initial commit 2024-04-09 14:28:40 +02:00
SkalskiP e2f1d5812e docs improvements 2024-04-05 12:10:10 +02:00
pre-commit-ci[bot] dd7fddb4f5 fix(pre_commit): 🎨 auto format pre-commit hooks 2024-04-05 09:50:00 +00:00
SkalskiP ee38ba36c4 docs improvements 2024-04-05 11:49:43 +02:00
SkalskiP afc31e42a5 few more improvements 2024-03-28 16:34:05 +01:00
SkalskiP 4ad78becb6 initial comment 2024-03-28 16:08:05 +01:00
SkalskiP 5a040969d7 fix how-to links 2024-03-26 09:53:16 +01:00
SkalskiP 15e17adef1 Detect Small Objects documentation 2024-03-25 21:11:47 +01:00
pre-commit-ci[bot] 4660dfd0d3 fix(pre_commit): 🎨 auto format pre-commit hooks 2024-03-25 12:55:29 +00:00
SkalskiP e7b4d6ec41 more improvements 2024-03-25 13:55:13 +01:00
pre-commit-ci[bot] bc586562b5 fix(pre_commit): 🎨 auto format pre-commit hooks 2024-03-25 12:14:44 +00:00
SkalskiP 57c6182325 initial changes 2024-03-25 13:11:47 +01:00
Onuralp SEZER 6ffd159b77 docs: ✨ supervision cookbook initial page design landed
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-08 15:20:43 +03:00
Onuralp SEZER edf35f4c6e docs(link): add relative urls and fix readme urls
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 21:39:57 +03:00
Onuralp SEZER b81eb85616 docs(fix): 🐞📝 add missing h1 for how tos
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 15:19:51 +03:00
SkalskiP 99d1b6d130 ready for review 2024-01-17 12:11:31 +01:00
pre-commit-ci[bot] c963a2e85a fix(pre_commit): 🎨 auto format pre-commit hooks 2024-01-04 14:50:08 +00:00
SkalskiP bdaee3f1fc update Detect and annotate guide 2024-01-04 15:49:47 +01:00
Paul f942d89881 Added inference examples throughout the docs. 2023-12-22 11:09:39 -07:00
pre-commit-ci[bot] 54bb79c220 fix(pre_commit): 🎨 auto format pre-commit hooks 2023-10-18 18:51:33 +00:00
SkalskiP 809d8946e6 Update docs on object detection and annotation
This commit clarifies the process of object detection and annotation using Supervision and the Ultralytics YOLOv8 model. The changes also include updated instructions on how to load model predictions into Supervision and using them to annotate images, with links to the methods used in the process and the available options. An image showing the resulting annotated image has also been added for better understanding. The changes are shaped to make the documentation more informative, concise, and easy to follow.
2023-10-18 20:50:52 +02:00
James Gallagher 8dcfb42751 add data loader link 2023-10-18 13:13:09 +01:00
James Gallagher a5a853e141 resolve conflict 2023-10-18 13:11:29 +01:00
pre-commit-ci[bot] 1ddb78b662 fix(pre_commit): 🎨 auto format pre-commit hooks 2023-10-18 09:22:43 +00:00
James Gallagher db4afe9885 add how to detect and annotate guide 2023-10-18 10:20:42 +01:00
pre-commit-ci[bot] 9a7b4c34ba fix(pre_commit): 🎨 auto format pre-commit hooks 2023-10-09 14:17:52 +00:00
SkalskiP e5894df156 Reorganize documentation structure and reformat code
Moved advanced filtering documentation to `how_to` directory from `quickstart` to make way for more comprehensive starter guide. Reorganized MkDocs configuration accordingly. Formatted some code in `classification/core.py` and `dataset/core.py` for better readability. Added placeholder files in `how_to` for future guides on object detection, video processing, object tracking, model evaluation, and detections filtering.
2023-10-09 13:41:56 +02:00