diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 84291639..3b1976e8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,7 +52,7 @@ git push -u origin main ### Pre-commit tool -This project utilizes the [pre-commit](https://pre-commit.com/) tool to maintain code quality and consistency. Before submitting a pull request or making any commits, it is important to run the pre-commit tool to ensure that your changes meet the project's guidelines. +This project uses the [pre-commit](https://pre-commit.com/) tool to maintain code quality and consistency. Before submitting a pull request or making any commits, it is important to run the pre-commit tool to ensure that your changes meet the project's guidelines. Furthermore, we have integrated a pre-commit GitHub Action into our workflow. This means that with every pull request opened, the pre-commit checks will be automatically enforced, streamlining the code review process and ensuring that all contributions adhere to our quality standards. diff --git a/docs/how_to/track_objects.md b/docs/how_to/track_objects.md index ea48b070..282470c0 100644 --- a/docs/how_to/track_objects.md +++ b/docs/how_to/track_objects.md @@ -1,4 +1,4 @@ -Utilize Supervision to elevate your video analysis capabilities by effortlessly +Use Supervision to elevate your video analysis capabilities by effortlessly [tracking](https://supervision.roboflow.com/trackers/) objects identified by various object detection and segmentation models. This guide will walk you through the process of running inference using the [Ultralytics](https://github.com/ultralytics/ultralytics) diff --git a/supervision/annotators/core.py b/supervision/annotators/core.py index fc3cf7f2..1503d80f 100644 --- a/supervision/annotators/core.py +++ b/supervision/annotators/core.py @@ -97,7 +97,7 @@ class MaskAnnotator(BaseAnnotator): !!! warning - This annotator utilizes the `sv.Detections.mask`. + This annotator uses `sv.Detections.mask`. """ def __init__( @@ -180,7 +180,7 @@ class PolygonAnnotator(BaseAnnotator): !!! warning - This annotator utilizes the `sv.Detections.mask`. + This annotator uses `sv.Detections.mask`. """ def __init__( @@ -348,7 +348,7 @@ class HaloAnnotator(BaseAnnotator): !!! warning - This annotator utilizes the `sv.Detections.mask`. + This annotator uses `sv.Detections.mask`. """ def __init__( @@ -1004,7 +1004,7 @@ class TraceAnnotator: !!! warning - This annotator utilizes the `sv.Detections.tracker_id`. Read + This annotator uses the `sv.Detections.tracker_id`. Read [here](https://supervision.roboflow.com/trackers/) to learn how to plug tracking into your inference pipeline. """ diff --git a/supervision/detection/line_counter.py b/supervision/detection/line_counter.py index 851d1d4a..d4bef678 100644 --- a/supervision/detection/line_counter.py +++ b/supervision/detection/line_counter.py @@ -15,7 +15,7 @@ class LineZone: !!! warning - LineZone utilizes the `tracker_id`. Read + LineZone uses the `tracker_id`. Read [here](https://supervision.roboflow.com/trackers/) to learn how to plug tracking into your inference pipeline. diff --git a/supervision/detection/tools/smoother.py b/supervision/detection/tools/smoother.py index 7fd8166a..65d653ff 100644 --- a/supervision/detection/tools/smoother.py +++ b/supervision/detection/tools/smoother.py @@ -7,9 +7,9 @@ from supervision.detection.core import Detections class Smoother: """ - A class for smoothing out noise in predictions over time by using a Tracker - to track objects over time and averaging out the predictions over the - `length` most recent frames. + Smooth out noise in predictions over time with the `Smoother` class. + This classes uses an existing `Tracker` to track objects over time. + Detections are averaged out over the `length` most recent frames.