supervision/examples
Piotr Skalski cdd88dafeb
Merge pull request #829 from roboflow/doc/urls-fixes-and-others
docs:  fix url and coc and contributing.md, pythonic features of docs enabled, relative urls added.
2024-02-02 12:53:45 +01:00
..
count_people_in_zone ready for review 2024-01-17 12:11:31 +01:00
heatmap_and_track fix(pre_commit): 🎨 auto format pre-commit hooks 2024-01-04 14:22:39 +00:00
speed_estimation fix inference and yolo nas speed estimation examples 2024-02-01 10:25:43 +01:00
tracking count people in zone example cleanup 2024-01-04 15:22:25 +01:00
traffic_analysis Update inference_example.py 2024-01-30 11:20:55 +00:00
README.md docs: contributing.md/code_of_conduct/license added into docs 2024-01-31 22:10:28 +03:00

README.md

Examples

This repository is packed with real-world use-cases, provided through Python scripts or interactive notebooks. Browse through to understand how the Supervision library interfaces with diverse applications.

Contributing

We welcome contributions from the community in the form of examples, applications, and guides. To contribute, please follow these steps:

  1. Create a pull request (PR) with the [Example] prefix in the title, adding your project folder to the examples/ directory in the repository.
  2. Confirm your project aligns with the following standards:
    • Incorporates the supervision package.
    • Provides a README.md file, detailing the instructions to execute the project.
    • Showcases visual results, demonstrating the app's functionality.
    • Avoids adding large assets or dependencies unless absolutely necessary.
    • The contributor is expected to provide support for issues related to their examples.
    • In case the presented model has licensing complications, kindly specify them to circumvent potential misunderstandings.

For inquiries or concerns about these prerequisites, feel free to raise a PR. We are committed to assist and guide you.