From bf8bfdafecbe7bc9d73090d13099913d70b137b8 Mon Sep 17 00:00:00 2001 From: Paula Derrenger <107626595+pderrenger@users.noreply.github.com> Date: Tue, 5 Dec 2023 22:46:14 +0100 Subject: [PATCH 1/4] Improve README --- README.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 8f7011a..3ef9244 100644 --- a/README.md +++ b/README.md @@ -22,55 +22,55 @@ -# 🌟 Ultralytics Assets Repository +# 🌟 Welcome to the Ultralytics Assets Repository ## πŸ“‹ Overview -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/). +Welcome! You've arrived at the [Ultralytics](https://ultralytics.com) Assets repository, your one-stop hub for visual assets, powerful pre-trained models, and carefully curated datasets. These tools are meticulously crafted to complement the Ultralytics YOLO ecosystem, providing capabilities that span object detection, instance segmentation, image classification, pose estimation, and tracking. -## πŸ›  Features +## πŸ›  Features at a Glance -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. +- **πŸ–Ό Visual Assets**: Dive into our collection of banners and logos that you can incorporate into your applications or as part of your collaboration with Ultralytics tools. +- **πŸ€– Models at Your Fingertips**: Tap into the power of pre-trained models, fine-tuned and ready to deploy. These models are optimized to tackle a wide range of computer vision tasks with ease and precision. +- **πŸ“¦ Datasets Ready for Action**: Enhance your machine learning projects with our repositories of annotated data, primed for model training, validation, and beyond. -## πŸ’‘ Usage +## πŸ’‘ Getting Started with Usage -### πŸ“₯ Autodownload of Pretrained Models +### πŸ“₯ Download Pretrained Models Seamlessly -When using Ultralytics YOLO APIs, if a pre-trained model is not found locally, it will be automatically downloaded from this repository. +Ultralytics YOLO frameworks are engineered for convenienceβ€”missing a pre-trained model? It will be automatically fetched from this very repository. -Here's a simple example using Python: +_For example:_ ```python from ultralytics import YOLO -# Load a pretrained YOLOv8n model +# Instantiating a pre-trained YOLOv8n model model = YOLO('yolov8n.pt') -# Define path to the image file +# Path to your image source = 'path/to/image.jpg' -# Run inference on the source -results = model(source) # Returns a list of Results objects +# Perform inference with just one line +results = model(source) # This command completes the inference cycle and returns detection results ``` -### 🌐 Accessing Visual Assets +### 🌐 Embrace the Visuals -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. +All our visual assets are at your fingertips, downloadable straight from the main branch for your projects, presentations, or documentation. -### πŸ“š Accessing Datasets +### πŸ“š Explore Our Datasets -Datasets can be downloaded from the repository releases. Please refer to the individual dataset READMEs for usage instructions and licenses. +Our datasets are accessible via repository releases and come with comprehensive READMEs to guide you through the process. Make sure to review the licenses and specific guidance for each dataset to align with your project needs. -## 🀝 Contributing +## 🀝 Your Contributions Count -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. +Got models, datasets, or graphics to share? We welcome your contributions! Create a pull request or start a discussion to kick things off. -## πŸ†˜ Support +## πŸ†˜ Support and Community -For any questions, feature requests, or debugging queries, feel free to reach out to the Ultralytics support team or raise an issue on GitHub. +Encounter a challenge or curious about a feature? Reach out to our support team, or post an issue on GitHub. Our community thrives on collaboration and open communication. -## πŸ“ License +## πŸ“ Licensing Clarified -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. +All materials within this repository are protected under the GNU Affero General Public License v3.0 (AGPL-3.0). For more information and clarification on usage terms, please see the [LICENSE](./LICENSE) document. From 592360b0bfe9575ba0f35428614543d39c413c75 Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Tue, 5 Dec 2023 22:49:06 +0100 Subject: [PATCH 2/4] Update README.md --- README.md | 36 ++++++++++++++++++++++++++++++------ 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3ef9244..6168b3c 100644 --- a/README.md +++ b/README.md @@ -63,14 +63,38 @@ All our visual assets are at your fingertips, downloadable straight from the mai Our datasets are accessible via repository releases and come with comprehensive READMEs to guide you through the process. Make sure to review the licenses and specific guidance for each dataset to align with your project needs. -## 🀝 Your Contributions Count +## 🀝 Contribute -Got models, datasets, or graphics to share? We welcome your contributions! Create a pull request or start a discussion to kick things off. +We welcome contributions from the community! Whether you're fixing bugs, adding new features, or improving documentation, your input is invaluable. Take a look at our [Contributing Guide](https://docs.ultralytics.com/help/contributing) to get started. Also, we'd love to hear about your experience with Ultralytics products. Please consider filling out our [Survey](https://ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A huge πŸ™ and thank you to all of our contributors! -## πŸ†˜ Support and Community + + +Ultralytics open-source contributors -Encounter a challenge or curious about a feature? Reach out to our support team, or post an issue on GitHub. Our community thrives on collaboration and open communication. +## ©️ License -## πŸ“ Licensing Clarified +Ultralytics is excited to offer two different licensing options to meet your needs: -All materials within this repository are protected under the GNU Affero General Public License v3.0 (AGPL-3.0). For more information and clarification on usage terms, please see the [LICENSE](./LICENSE) document. +- **AGPL-3.0 License**: Perfect for students and hobbyists, this [OSI-approved](https://opensource.org/licenses/) open-source license encourages collaborative learning and knowledge sharing. Please refer to the [LICENSE](https://github.com/ultralytics/ultralytics/blob/main/LICENSE) file for detailed terms. +- **Enterprise License**: Ideal for commercial use, this license allows for the integration of Ultralytics software and AI models into commercial products without the open-source requirements of AGPL-3.0. For use cases that involve commercial applications, please contact us via [Ultralytics Licensing](https://ultralytics.com/license). + +## πŸ“¬ Contact Us + +For bug reports, feature requests, and contributions, head to [GitHub Issues](https://github.com/ultralytics/assets/issues). For questions and discussions about this project and other Ultralytics endeavors, join us on [Discord](https://ultralytics.com/discord)! + +
+
+ Ultralytics GitHub + space + Ultralytics LinkedIn + space + Ultralytics Twitter + space + Ultralytics YouTube + space + Ultralytics TikTok + space + Ultralytics Instagram + space + Ultralytics Discord +
From 71c72f64ac1e6bb8ba4136ea45ef30383878e3ef Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Tue, 5 Dec 2023 22:49:20 +0100 Subject: [PATCH 3/4] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 6168b3c..4604511 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,6 @@ # 🌟 Welcome to the Ultralytics Assets Repository -## πŸ“‹ Overview - Welcome! You've arrived at the [Ultralytics](https://ultralytics.com) Assets repository, your one-stop hub for visual assets, powerful pre-trained models, and carefully curated datasets. These tools are meticulously crafted to complement the Ultralytics YOLO ecosystem, providing capabilities that span object detection, instance segmentation, image classification, pose estimation, and tracking. ## πŸ›  Features at a Glance From acae290d2114af4cbad8c6c523988c13db24d649 Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Tue, 5 Dec 2023 22:49:37 +0100 Subject: [PATCH 4/4] Update README.md --- README.md | 23 +---------------------- 1 file changed, 1 insertion(+), 22 deletions(-) diff --git a/README.md b/README.md index 4604511..b647bf2 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,5 @@ -
-

- - -


- -
- Ultralytics GitHub - - Ultralytics LinkedIn - - Ultralytics Twitter - - Ultralytics YouTube - - Ultralytics TikTok - - Ultralytics Instagram - - Ultralytics Discord -
-
+ # 🌟 Welcome to the Ultralytics Assets Repository