forked from ultralytics/ultralytics
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Setup template for community examples (ultralytics#718)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
- Loading branch information
1 parent
7a7c8dc
commit 09265b1
Showing
2 changed files
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
This is a dummy project |