Skip to content

Commit

Permalink
Create README.md (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
glenn-jocher committed Oct 22, 2023
1 parent 9e314fe commit 8dfcc2b
Showing 1 changed file with 83 additions and 0 deletions.
83 changes: 83 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
<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>

<div align="center">
<a href="https://github.com/ultralytics" style="text-decoration:none;">
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png" width="2%" alt="" /></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
<a href="https://www.linkedin.com/company/ultralytics/" style="text-decoration:none;">
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-linkedin.png" width="2%" alt="" /></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
<a href="https://twitter.com/ultralytics" style="text-decoration:none;">
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-twitter.png" width="2%" alt="" /></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
<a href="https://youtube.com/ultralytics" style="text-decoration:none;">
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-youtube.png" width="2%" alt="" /></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
<a href="https://www.tiktok.com/@ultralytics" style="text-decoration:none;">
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-tiktok.png" width="2%" alt="" /></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
<a href="https://www.instagram.com/ultralytics/" style="text-decoration:none;">
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-instagram.png" width="2%" alt="" /></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
<a href="https://ultralytics.com/discord" style="text-decoration:none;">
<img src="https://github.com/ultralytics/assets/blob/main/social/logo-social-discord.png" width="2%" alt="" /></a>
</div>
</div>

# 🌟 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/).

## πŸ›  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.

0 comments on commit 8dfcc2b

Please sign in to comment.