diff --git a/docs/how_to/detect_and_annotate.md b/docs/how_to/detect_and_annotate.md new file mode 100644 index 00000000..02a2f55b --- /dev/null +++ b/docs/how_to/detect_and_annotate.md @@ -0,0 +1 @@ +🚧 Page under construction. \ No newline at end of file diff --git a/docs/how_to/evaluate_model.md b/docs/how_to/evaluate_model.md new file mode 100644 index 00000000..02a2f55b --- /dev/null +++ b/docs/how_to/evaluate_model.md @@ -0,0 +1 @@ +🚧 Page under construction. \ No newline at end of file diff --git a/docs/quickstart/detections.md b/docs/how_to/filter_detections.md similarity index 99% rename from docs/quickstart/detections.md rename to docs/how_to/filter_detections.md index 2114ac5e..1b829d81 100644 --- a/docs/quickstart/detections.md +++ b/docs/how_to/filter_detections.md @@ -1,6 +1,3 @@ -## advanced filtering - - The advanced filtering capabilities of the `Detections` class offer users a versatile and efficient way to narrow down and refine object detections. This section outlines various filtering methods, including filtering by specific class or a set of classes, confidence, object area, bounding box area, relative area, box dimensions, and designated zones. diff --git a/docs/how_to/process_video.md b/docs/how_to/process_video.md new file mode 100644 index 00000000..02a2f55b --- /dev/null +++ b/docs/how_to/process_video.md @@ -0,0 +1 @@ +🚧 Page under construction. \ No newline at end of file diff --git a/docs/how_to/track_objects.md b/docs/how_to/track_objects.md new file mode 100644 index 00000000..02a2f55b --- /dev/null +++ b/docs/how_to/track_objects.md @@ -0,0 +1 @@ +🚧 Page under construction. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 41054db0..6528b238 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -26,29 +26,33 @@ extra_css: nav: - Home: index.md - - Quickstart: - - Detections: quickstart/detections.md - - Classifications: - - Core: classification/core.md - - Detections: - - Core: detection/core.md - - Annotate: detection/annotate.md - - Utils: detection/utils.md - - Tools: - - Polygon Zone: detection/tools/polygon_zone.md - - Inference Slicer: detection/tools/inference_slicer.md - - Annotators: annotators.md - - Trackers: trackers.md - - Datasets: datasets.md - - Metrics: - - Object Detection: metrics/detection.md - - Draw: - - Utils: draw/utils.md - - Utils: - - Video: utils/video.md - - Image: utils/image.md - - Notebook: utils/notebook.md - - File: utils/file.md + - How to: + - Detect and Annotate: how_to/detect_and_annotate.md + - Process Video: how_to/process_video.md + - Track Objects: how_to/track_objects.md + - Filter Detections: how_to/filter_detections.md + - Evaluate Model: how_to/evaluate_model.md + - API: + - Classifications: + - Core: classification/core.md + - Detections: + - Core: detection/core.md + - Utils: detection/utils.md + - Tools: + - Polygon Zone: detection/tools/polygon_zone.md + - Inference Slicer: detection/tools/inference_slicer.md + - Annotators: annotators.md + - Trackers: trackers.md + - Datasets: datasets.md + - Metrics: + - Object Detection: metrics/detection.md + - Draw: + - Utils: draw/utils.md + - Utils: + - Video: utils/video.md + - Image: utils/image.md + - Notebook: utils/notebook.md + - File: utils/file.md - Changelog: changelog.md theme: diff --git a/supervision/classification/core.py b/supervision/classification/core.py index 3ea1a497..157275dd 100644 --- a/supervision/classification/core.py +++ b/supervision/classification/core.py @@ -47,7 +47,7 @@ class Classifications: Args: ultralytics_results (ultralytics.engine.results.Results): - The output Results instance from ultralytics model + The output Results instance from ultralytics model Returns: Classifications: A new Classifications object. diff --git a/supervision/dataset/core.py b/supervision/dataset/core.py index eeff8501..48043dbb 100644 --- a/supervision/dataset/core.py +++ b/supervision/dataset/core.py @@ -165,9 +165,8 @@ class DetectionDataset(BaseDataset): where the images should be saved. If not provided, images will not be saved. annotations_directory_path (Optional[str]): The path to - the directory where the annotations in - PASCAL VOC format should be saved. If not provided, - annotations will not be saved. + the directory where the annotations in PASCAL VOC format should be + saved. If not provided, annotations will not be saved. min_image_area_percentage (float): The minimum percentage of detection area relative to the image area for a detection to be included. @@ -178,7 +177,7 @@ class DetectionDataset(BaseDataset): Argument is used only for segmentation datasets. approximation_percentage (float): The percentage of polygon points to be removed from the input polygon, - in the range [0, 1). Argument is used only for segmentation datasets. + in the range [0, 1). Argument is used only for segmentation datasets. """ if images_directory_path: save_dataset_images( @@ -563,8 +562,7 @@ class ClassificationDataset(BaseDataset): split_ratio (float, optional): The ratio of the training set to the entire dataset. random_state (int, optional): The seed for the - random number generator. - This is used for reproducibility. + random number generator. This is used for reproducibility. shuffle (bool, optional): Whether to shuffle the data before splitting. Returns: diff --git a/supervision/utils/video.py b/supervision/utils/video.py index 2aeaa778..7e242690 100644 --- a/supervision/utils/video.py +++ b/supervision/utils/video.py @@ -213,7 +213,7 @@ class FPSMonitor: """ Args: sample_size (int): The maximum number of observations for latency - benchmarking. + benchmarking. Examples: ```python