From 49239f838c81f2a2fde9d9228c09881a7b96c5f5 Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Sun, 22 Oct 2023 19:05:57 +0200 Subject: [PATCH 1/4] Create README.md --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8cd2217 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# Ultralytics Assets Repository + +## Overview + +Welcome to the Ultralytics Assets repository! This repository serves as a storage for visual assets like banners, logos, and more importantly, pre-trained models and datasets. These assets are designed to work seamlessly with Ultralytics YOLO implementations, aiding in object detection, instance segmentation, image classification, pose estimation, and multi-object tracking. + +## Features + +1. **Visual Assets**: Banners and logos to use in your projects or for showcasing your use of Ultralytics resources. +2. **Models**: Pre-trained models that are ready for download and immediate use. These models are optimized for various computer vision tasks. +3. **Datasets**: Collections of annotated data that can be used for training or validating models. + +## Usage + +### Autodownload of Pretrained Models + +When using Ultralytics YOLO APIs, if a pre-trained model is not found locally, it will be automatically downloaded from this repository. + +Here's a simple example using Python: + +```python +from ultralytics import YOLO + +# Load a pretrained YOLOv8n model +model = YOLO('yolov8n.pt') + +# Define path to the image file +source = 'path/to/image.jpg' + +# Run inference on the source +results = model(source) # Returns a list of Results objects +``` + +### Accessing Visual Assets + +The visual assets can be downloaded directly from the main branch of this repository. They are free for use in your own projects or documentation. + +### Accessing Datasets + +Datasets can be downloaded from the repository releases. Please refer to the individual dataset READMEs for usage instructions and licenses. + +## Contributing + +If you'd like to contribute models, datasets, or visual assets to this repository, please submit a pull request or open an issue to discuss the contribution. + +## Support + +For any questions, feature requests, or debugging queries, feel free to reach out to the Ultralytics support team or raise an issue on GitHub. + +## License + +This repository and its assets are covered under the GNU Affero General Public License v3.0 (AGPL-3.0). Please refer to the [LICENSE](./LICENSE) file for more details. From 2d8f595f98969be7b4972aeb7b89ac208b31b91b Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Sun, 22 Oct 2023 19:09:31 +0200 Subject: [PATCH 2/4] Update README.md --- README.md | 59 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 45 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 8cd2217..a0de93c 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,49 @@ -# Ultralytics Assets Repository - -## Overview +
+

+ + +

+
+ +
+ + + + + + + + + + + + + + + + + + + + +
+
+ +# 🌟 Ultralytics Assets Repository + +## 📋 Overview Welcome to the Ultralytics Assets repository! This repository serves as a storage for visual assets like banners, logos, and more importantly, pre-trained models and datasets. These assets are designed to work seamlessly with Ultralytics YOLO implementations, aiding in object detection, instance segmentation, image classification, pose estimation, and multi-object tracking. -## Features +## 🛠 Features -1. **Visual Assets**: Banners and logos to use in your projects or for showcasing your use of Ultralytics resources. -2. **Models**: Pre-trained models that are ready for download and immediate use. These models are optimized for various computer vision tasks. -3. **Datasets**: Collections of annotated data that can be used for training or validating models. +1. **🖼 Visual Assets**: Banners and logos to use in your projects or for showcasing your use of Ultralytics resources. +2. **🤖 Models**: Pre-trained models that are ready for download and immediate use. These models are optimized for various computer vision tasks. +3. **📦 Datasets**: Collections of annotated data that can be used for training or validating models. -## Usage +## 💡 Usage -### Autodownload of Pretrained Models +### 📥 Autodownload of Pretrained Models When using Ultralytics YOLO APIs, if a pre-trained model is not found locally, it will be automatically downloaded from this repository. @@ -31,22 +62,22 @@ source = 'path/to/image.jpg' results = model(source) # Returns a list of Results objects ``` -### Accessing Visual Assets +### 🌐 Accessing Visual Assets The visual assets can be downloaded directly from the main branch of this repository. They are free for use in your own projects or documentation. -### Accessing Datasets +### 📚 Accessing Datasets Datasets can be downloaded from the repository releases. Please refer to the individual dataset READMEs for usage instructions and licenses. -## Contributing +## 🤝 Contributing If you'd like to contribute models, datasets, or visual assets to this repository, please submit a pull request or open an issue to discuss the contribution. -## Support +## 🆘 Support For any questions, feature requests, or debugging queries, feel free to reach out to the Ultralytics support team or raise an issue on GitHub. -## License +## 📝 License This repository and its assets are covered under the GNU Affero General Public License v3.0 (AGPL-3.0). Please refer to the [LICENSE](./LICENSE) file for more details. From 9fbbe660945947eba72b9e6e061fca6a153cdfb2 Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Sun, 22 Oct 2023 19:12:43 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a0de93c..9365bd5 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ ## 📋 Overview -Welcome to the Ultralytics Assets repository! This repository serves as a storage for visual assets like banners, logos, and more importantly, pre-trained models and datasets. These assets are designed to work seamlessly with Ultralytics YOLO implementations, aiding in object detection, instance segmentation, image classification, pose estimation, and multi-object tracking. +Welcome to the [Ultralytics](https://ultralytics.com) Assets repository! This repository serves as a storage for visual assets like banners, logos, and more importantly, pre-trained models and datasets. These assets are designed to work seamlessly with [Ultralytics YOLO](https://github.com/ultralytics/ultralytics) implementations, aiding in [object detection](https://docs.ultralytics.com/tasks/detect/), [instance segmentation](https://docs.ultralytics.com/tasks/segment/), [image classification](https://docs.ultralytics.com/tasks/classify/), [pose estimation](https://docs.ultralytics.com/tasks/pose/), and multi-object [tracking](https://docs.ultralytics.com/modes/track/). ## 🛠 Features From dd0cdf7ecbdb39dc12b8bcfb2a0ea4bd836d5f8e Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Sun, 22 Oct 2023 19:13:25 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9365bd5..2944ebd 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- +