diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..1f185da --- /dev/null +++ b/examples/README.md @@ -0,0 +1,20 @@ +This is a list of real-world applications and walkthroughs. These can be folders of either python files or notebooks . + +## Ultralytics YOLO example applications + +| Title | Format | Contributor | +| ------------------------------------------------------------------ | --------------- | ----------------------------------------- | +| \[Dummy\] [Inventory managenet using YOLO](./inventory-management) | python/notebook | [AyushExel](https://github.com/AyushExel) | + +## How can you contribute ? + +We're looking for examples, applications and guides from the community. Here's how you can contribute: + +- Make a PR with `[Example]` prefix in title after adding your project folder in the examples/ folder of the repository +- The project should satisfy these conditions: + - It should use ultralytics framework + - It have a README.md with instructions to run the project + - It should avoid adding large assets or dependencies unless absolutely needed + - The contributor is expected to help out in issues related to their examples + +If you're unsure about any of these requirements, make a PR and we'll happy to guide you diff --git a/examples/inventory-management/README.md b/examples/inventory-management/README.md new file mode 100644 index 0000000..8f56257 --- /dev/null +++ b/examples/inventory-management/README.md @@ -0,0 +1 @@ +This is a dummy project