Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve README #25

Merged
merged 4 commits into from
Dec 5, 2023
Merged

Improve README #25

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bf8bfda
Improve README
pderrenger Dec 5, 2023
592360b
Update README.md
glenn-jocher Dec 5, 2023
71c72f6
Update README.md
glenn-jocher Dec 5, 2023
acae290
Update README.md
glenn-jocher Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 49 additions & 48 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,76 +1,77 @@
<div align="center">
<p>
<a href="https://ultralytics.com/" target="_blank">
<img width="100%" src="https://github.com/raw/ultralytics/assets/main/im/banner-yolo-vision-2023.png"></a>
</p>
<br>
<img src="https://github.com/raw/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg" width="320">

<div align="center">
<a href="https://github.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png" width="3%" alt="Ultralytics GitHub"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%">
<a href="https://www.linkedin.com/company/ultralytics/"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-linkedin.png" width="3%" alt="Ultralytics LinkedIn"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%">
<a href="https://twitter.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-twitter.png" width="3%" alt="Ultralytics Twitter"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%">
<a href="https://youtube.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-youtube.png" width="3%" alt="Ultralytics YouTube"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%">
<a href="https://www.tiktok.com/@ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-tiktok.png" width="3%" alt="Ultralytics TikTok"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%">
<a href="https://www.instagram.com/ultralytics/"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-instagram.png" width="3%" alt="Ultralytics Instagram"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%">
<a href="https://ultralytics.com/discord"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-discord.png" width="3%" alt="Ultralytics Discord"></a>
</div>
</div>

# 🌟 Ultralytics Assets Repository

## 📋 Overview
# 🌟 Welcome to the Ultralytics Assets Repository

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
## 🤝 Contribute

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.
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
<!-- Ultralytics contributors -->
<a href="https://github.com/ultralytics/yolov5/graphs/contributors">
<img width="100%" src="https://github.com/ultralytics/assets/raw/main/im/image-contributors.png" alt="Ultralytics open-source contributors"></a>

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
Ultralytics is excited to offer two different licensing options to meet your needs:

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.
- **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)!

<br>
<div align="center">
<a href="https://github.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png" width="3%" alt="Ultralytics GitHub"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://www.linkedin.com/company/ultralytics/"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-linkedin.png" width="3%" alt="Ultralytics LinkedIn"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://twitter.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-twitter.png" width="3%" alt="Ultralytics Twitter"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://youtube.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-youtube.png" width="3%" alt="Ultralytics YouTube"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://www.tiktok.com/@ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-tiktok.png" width="3%" alt="Ultralytics TikTok"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://www.instagram.com/ultralytics/"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-instagram.png" width="3%" alt="Ultralytics Instagram"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://ultralytics.com/discord"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-discord.png" width="3%" alt="Ultralytics Discord"></a>
</div>