yotraco 0.2.3

A YOLO-based object tracking and counting system.

YOTRACO

Object tracking and counting system based on YOLO

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Installation
   • Usage
3. Contributing
4. License
5. Contact

About The Project

This project leverages YOLO (You Only Look Once) for real-time object detection and tracking in video streams, enhancing analytical capabilities through automated monitoring and statistical reporting.

• Object Detection & Tracking: Utilizes YOLO to detect and track objects in video footage with high accuracy.
• Crossing Detection: Automatically counts objects crossing a predefined line within the frame.
• Customizable Settings:
  • Configure the tracking line position (top, middle, bottom).
  • Define tracking direction (IN, OUT, or BOTH).
  • Select specific object classes for monitoring.
• Processed Video Output: Generates and saves processed video files with overlaid tracking data and object counts.
• Logging & Statistics: Maintains detailed records and statistical insights on tracked objects for further analysis.

(back to top)

Installation

Install the module with pip:

pip install yotraco

Update existing installation: pip install yotraco --upgrade
(update as often as possible because this library is under active development)

Usage

To test yotraco you can try this simple example with your video:

from YOTRACO import Yotraco

model = Yotraco("yolo11l.pt",                 # the path to the yolo.pt 
                "your_video_path.mp4",        # the path to your video
                "output",                     # the name of the output
                "middle",                     # the line postion (by default : middle)
                "BOTH",                       # the track direction (by default : Both )
                classes_to_track=[0,1,2,3,4], # the class id to track 
                display=True                  # display the counts in the output video
                )

model.process_video()

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

(back to top)

License

Distributed under the MIT license. See LICENSE for more information.

(back to top)

Contact

Yotraco Team - [e-mail]

(back to top)

Thanks

Special thanks to the following resources and contributors who helped make this project possible:

• Ultralytics YOLO for their amazing object detection framework.
• Mouad Hida for designing the project logo and enhancing the visual identity of this project.
• All contributors who provided invaluable feedback and improvements.
• The open-source community for continuous inspiration.

(back to top)