Commit Graph

143 Commits

Author SHA1 Message Date
Linas Kondrackis f7bd7011fe OverlapFilter: Add and validate docs, rename 2024-05-30 13:45:12 +03:00
Linas Kondrackis c9c2dad316 Docs: shorter title for object tracking how-to 2024-05-22 23:47:45 +03:00
Linas Kondrackis 99854a5b66
minor docs change: rename How To - Track Objects 2024-05-22 23:14:17 +03:00
SkalskiP d21c98a4d2 docs updated; `rle_to_mask` and `mask_to_rle` added to `__init__.py` 2024-05-13 12:06:38 +02:00
SkalskiP 77793571b0 major docs refactor 2024-04-24 15:39:08 +02:00
SkalskiP 2745c70ae0 docs plugged into `mkdocs.yml` 2024-04-24 00:21:19 +02:00
SkalskiP 574c61b6b0 initial commit 2024-04-09 14:28:40 +02:00
Piotr Skalski 372e703a7a
Merge pull request #1028 from roboflow/feature/add_tiles_generator
Add util to create image tiles
2024-04-05 18:37:19 +02:00
SkalskiP 473f140133 `create_batches` and `fill` docs added 2024-04-05 18:01:17 +02:00
SkalskiP 15e17adef1 Detect Small Objects documentation 2024-03-25 21:11:47 +01:00
Onuralp SEZER 8514f086b7
docs(fix): 🐞📝 MKDOCS_GIT_COMMITTERS_APIKEY fix attempt v2
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-08 19:53:51 +03:00
Onuralp SEZER 08a204d872
docs(api): 📝 api/annotators position adjusted and small typo fix
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-08 19:20:15 +03:00
Onuralp SEZER 985624e35e
docs(assets): 🐞 missing js and css files added into mkdocs.yml
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-08 18:05:07 +03:00
Onuralp SEZER 6a091b58a8
ci(docs): 👷 GH_TOKEN added for git-committers
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-08 17:51:19 +03:00
pre-commit-ci[bot] 1ad26b5527 fix(pre_commit): 🎨 auto format pre-commit hooks 2024-02-08 14:13:38 +00:00
Onuralp SEZER d2ccc4f270
docs(nav): 🚀 nav-tab enabled and new order of pages for better understanding
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-08 17:13:03 +03:00
Onuralp SEZER 1fba192319
docs: folder rename to javascript to javascripts (plural)
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-08 15:26:03 +03: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 a6d9961b2b
docs: jupyter notebook support added
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-07 20:06:25 +03:00
Piotr Skalski 87a4927d03
Merge pull request #818 from AdonaiVera/allowing_serialise_detections_csv
New function [CSVSink] - allowing to serialise Detections to a CSV file
2024-02-02 18:11:10 +01:00
Onuralp SEZER 26135bd84d
docs(fix): 🐞📝 relative path fix for mike
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-02 15:15:18 +03:00
Adonai Vera 788bc317fa Improvements in thread #818: documentation, handle unit test, improvements pattern directory 2024-02-01 17:53:15 -05:00
Onuralp SEZER 732aa09059
docs: 📝 linkedin url adjustment
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-02 01:22:57 +03:00
Onuralp SEZER 671b48df4b
docs: 📝 add social discord into footer
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-02 01:21:44 +03:00
Onuralp SEZER df9616948b
docs(mkdocs): pythonic mkdocs features enabled
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-02-01 21:40:20 +03:00
Onuralp SEZER ff3df644c9
Merge branch 'develop' into doc/urls-fixes-and-others 2024-02-01 00:12:17 +03:00
SkalskiP 9817598c2c improved communication of deprecated features 2024-01-31 21:59:06 +01:00
Onuralp SEZER 163aa785f9
docs: contributing.md/code_of_conduct/license added into docs
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 22:10:28 +03:00
Onuralp SEZER d009f75c28
docs: 📝 pypi and docker url added to footer
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 21:47:07 +03:00
Adonai Vera 12568336ba Applied feedback from SkalskiP in PR #818 2024-01-31 11:39:05 -05:00
Onuralp SEZER 49a30f9830
docs: Twitter logo updated
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 16:19:23 +03:00
Onuralp SEZER c7501868d0
docs: Supervision 2024 docs (copyright fix)
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 16:15:43 +03:00
Onuralp SEZER 947f8d35c4
fix: 🐞 version provider typo fix
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 14:22:21 +03:00
Onuralp SEZER 4b75daaad6
ci: 👷 documentation build via mike for develop tag configuration
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-31 01:28:22 +03:00
Onuralp SEZER c7790fdf56
fix(docs): 🐞 emoji extension added for show emojis properly
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2024-01-24 17:53:56 +03:00
SkalskiP 7b0d5e729e ready for merge 2024-01-24 15:09:47 +01:00
SkalskiP 79560945f5 ready for merge 2024-01-24 15:07:32 +01:00
James 09d771c139
Merge branch 'develop' into prediction-smoothing 2024-01-23 12:59:28 +00:00
SkalskiP ace32eecb6 improve `Detections` docstrings 2024-01-04 13:56:51 +01:00
Brad Dwyer a36b426dff Merge branch 'develop' into prediction-smoothing 2023-12-28 11:50:15 -06:00
Brad Dwyer 1d4d7dd4ea Move into tools directory 2023-12-28 11:42:55 -06:00
Brad Dwyer ffdab06376 Update Docs 2023-12-27 15:02:02 -06:00
James Gallagher 1981de1c80 use new organization 2023-12-21 15:03:04 +00:00
James 0faf14229c
Update mkdocs.yml 2023-12-21 14:55:06 +00:00
James Gallagher e45e1e277b resubmit mkdocs pr 2023-12-04 17:02:44 +00:00
Piotr Skalski 4483970638
Revert "Add open graph images" 2023-12-04 16:22:38 +01:00
Piotr Skalski 144df44ccc
Merge pull request #636 from roboflow/add-open-graph-images
Add open graph images
2023-12-04 16:16:37 +01:00
James Gallagher b047e061e7 respond to feedback 2023-12-04 15:08:51 +00:00
James Gallagher ec8f10d6a8 add open graph images 2023-12-04 13:35:27 +00:00
capjamesg 242ac0cd06 add code snippet copy feature to docs 2023-12-04 13:20:13 +00:00
Piotr Skalski c100c8019a
Merge pull request #552 from roboflow/add-docs-bot
Add Kapa documentation bot to supervision docs
2023-10-31 17:23:49 +01:00
pre-commit-ci[bot] 9f265b4833 fix(pre_commit): 🎨 auto format pre-commit hooks 2023-10-30 15:15:15 +00:00
James Gallagher c036aa9bd6 add kapa bot 2023-10-30 15:13:33 +00:00
Piotr Skalski 8aee70872f
Merge branch 'develop' into asset-addon 2023-10-24 15:50:56 +02:00
SkalskiP 3f5f5fb070 Rename asset_list.py and update VideoAssets enumeration
The file asset_list.py has been renamed to list.py for better readability and simplicity. In the VideoAssets enumeration, additional information has been included. This includes specific details for each member of the enum, notably the filename of the related video and its URL.
2023-10-24 15:01:03 +02:00
SkalskiP a640e527d0 Remove custom 404 page and update documentation for new release
The custom 404.html was removed as it was no longer necessary with the updates to the Mkdocs.yml file. Upgraded the project version from 0.16.0rc2 to 0.16.0rc3 in the pyproject.toml file. Various updates were added to the changelog.md to reflect improvements and bug fixes in the new project release. This includes new annotations, utility improvements, and bug-fixes to improve project functionality.
2023-10-19 00:41:13 +02:00
SkalskiP 25a45aa423 Expand and update Color, ColorPalette, and DotAnnotator classes
Added detailed comments and examples to the Color and ColorPalette classes in supervision/draw/color.py, in addition to the DotAnnotator class in supervision/annotators/core.py. The changes clarify the usage and function of these classes. Also appended to the documentation by creating a new section for Color in docs/draw/color.md and including Color and DotAnnotator in docs/annotators.md. Incorporated the new documentation into the navigation structure in mkdocs.yml for user accessibility. The improvements enhance overall code-readability and understandability.
2023-10-18 18:53:39 +02:00
SkalskiP 00e209744f Add documentation and improvements to "LineZone" functionality
Descriptions for various attributes and functionalities have been added into LineZone class to aid developers in understanding their behaviour. Also, the trigger function was modified to return two separate boolean arrays - 'crossed_in' and 'crossed_out' to denote objects crossing the line in specific directions. Moreover, Line Zone documentation is added to the side navigation in mkdocs.yml.
2023-10-18 14:42:59 +02:00
James Gallagher eda6909c91 change domain to supervision.roboflow.com in mkdocs 2023-10-16 13:10:52 +01:00
James Gallagher 1ab50cdb3c add / to mkdocs site_url 2023-10-16 13:06:43 +01:00
James Gallagher 75db51aa90 add 404 page 2023-10-16 09:00:12 +01: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
SkalskiP c5e1211c74 Move FpsMonitor from utils to video module
This commit relocates the FpsMonitor class from the utils module to the video module.
2023-10-07 00:24:20 +02:00
Hardik Dava b482784403
Merge branch 'develop' into feature/fps 2023-10-03 17:57:53 +02:00
Hardik Dava 3b00e04101 Merge remote-tracking branch 'origin/develop' into feature/fps 2023-10-03 17:53:52 +02:00
SkalskiP 93a8110908 Refactor documentation structure and improve annotator details
Update the file and section structure of the project documentation for better readability. Removed 'annotate.md' and replaced it with an expanded 'annotators.md'. The new document provides examples of each annotator and includes preview images for better understanding. The API reference structure was flattened for simplicity and related documents 'core.py' and 'mkdocs.yml' were updated accordingly. The core tracker and dataset documents were renamed for consistency.
2023-10-03 11:38:28 +02:00
SkalskiP bddd32dbb5 refactor(inference_slicer): Update class and method docstrings 2023-08-30 15:56:15 +02:00
Hardik Dava c746a7f9e4 docs added 2023-08-11 14:08:52 +02:00
Onuralp SEZER 3d3b3e6436
Merge additonal features and changes from 'origin/develop'
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2023-08-07 23:23:23 +03:00
SkalskiP 62e097b559 🧹 more cleanup - dropping example scripts, plugging in ByteTrack docs, renaming variables 2023-08-07 14:11:51 +02:00
Onuralp SEZER 57e17c34a0
feat: 🚀 pre-commit and initial formatted files
Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
2023-07-25 13:02:26 +03:00
SkalskiP 3d074fa213 🧮 Confusion Matrix docs update 2023-07-21 19:51:19 +02:00
kirilllzaitsev abbc0e44b0 fixes patch 2023-07-19 23:01:50 +02:00
James Gallagher d22940ce30 add classifications to table of contents 2023-06-13 14:36:31 +01:00
SkalskiP 802347f4d8 🧹 cleanup before `supervision` `0.9.0` release 2023-06-07 11:47:34 +02:00
SkalskiP 14f62deacf 📚 `ImageSink` documentation updated 2023-06-06 20:13:33 +02:00
SkalskiP e16cca4349 🚀 - add quick start section to Supervision docs page with first topic - advanced detections filtering 2023-05-04 17:48:39 +02:00
SkalskiP c2833bc8ca 🤍 / 🖤 - light mode / datk mode switch added 2023-05-04 10:13:11 +02:00
SkalskiP 49d4441419 📄 docs update 2023-04-19 12:59:29 +02:00
SkalskiP c1ccff474f Documentation for PolygonZone and PolygonZoneAnnotator 2023-04-10 23:15:35 +02:00
SkalskiP 141809ae92 - 📓 Refactor of notebooks utilities
- Initial voc xml sing support
- Documentation improvements
2023-04-05 15:48:21 +02:00
SkalskiP 1fa4a1c72e 📜 Supervision docs changelog added 2023-03-29 15:59:02 +02:00
SkalskiP a88eff868e 📖 improve documentation 2023-03-23 14:41:03 +01:00
SkalskiP 8bf686e23b 🖤 make black happy 2023-03-23 14:18:46 +01:00
SkalskiP e6f250dbfb 🧹 docs refinement and clean up 2023-03-08 11:28:54 +01:00
SkalskiP b7c1791236 🕵️ update Detection API 2023-02-06 16:14:24 +01:00
SkalskiP 307ec8a042 📄 Documentation updates before 0.2.0 release 2023-02-06 14:49:09 +01:00
James Gallagher ed0fd7b768 move analytics to main extra section in yaml 2023-02-02 09:29:10 +00:00
Piotr Skalski ae84cdeb02
Merge pull request #8 from roboflow/documentation-improvements
Refactor documentation for Supervision
2023-02-01 16:07:37 +01:00
James Gallagher 5a3df85fc6 add ga script 2023-02-01 10:33:30 +00:00
James Gallagher 90a26747b6 create stub doc files, refactor docstrings, add placeholders for examples 2023-02-01 10:28:49 +00:00
SkalskiP 1561bd0027 🎬 poc of video utils documentation 2023-01-31 09:36:39 +01:00
SkalskiP 02c20e81a9 📚 initial documentation commit 2023-01-30 19:50:25 +01:00