An open API service indexing awesome lists of open source software.

https://github.com/ultralytics/replicate

Deploy YOLO models to Replicate with ready-to-use Cog configurations and automated CI/CD. Includes optimized deployments for YOLO11, and reference implementations for custom model deployment.
https://github.com/ultralytics/replicate

ai api ci classification-internal deployment detection ml pose-estimation segmentation ultralytics yolo yolo11 yolov5 yolov8

Last synced: about 1 month ago
JSON representation

Deploy YOLO models to Replicate with ready-to-use Cog configurations and automated CI/CD. Includes optimized deployments for YOLO11, and reference implementations for custom model deployment.

Awesome Lists containing this project

README

          

Ultralytics logo

# ๐Ÿš€ Ultralytics Replicate

Deploy YOLO11n to Replicate at https://replicate.com/ultralytics/yolo11n with ready-to-use Cog configuration and automated CI/CD workflow.

[![Push YOLO11n to Replicate](https://github.com/ultralytics/replicate/actions/workflows/push.yml/badge.svg)](https://github.com/ultralytics/replicate/actions/workflows/push.yml)
[![Ultralytics Actions](https://github.com/ultralytics/replicate/actions/workflows/format.yml/badge.svg)](https://github.com/ultralytics/replicate/actions/workflows/format.yml)

[![Ultralytics Discord](https://img.shields.io/discord/1089800235347353640?logo=discord&logoColor=white&label=Discord&color=blue)](https://discord.com/invite/ultralytics)
[![Ultralytics Forums](https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue)](https://community.ultralytics.com/)
[![Ultralytics Reddit](https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue)](https://reddit.com/r/ultralytics)

Replicate AI

## ๐Ÿ—‚๏ธ Repository Structure

This repository provides optimized Replicate deployment for the YOLO11n model with automated CI/CD workflow.

```plaintext
ultralytics/replicate/
โ”‚
โ”œโ”€โ”€ yolo11n/ # YOLO11n model deployment
โ”‚ โ”œโ”€โ”€ cog.yaml # Cog configuration
โ”‚ โ”œโ”€โ”€ predict.py # Prediction interface
โ”‚ โ””โ”€โ”€ README.md # Model documentation
โ”‚
โ”œโ”€โ”€ .github/workflows/ # Automated deployment
โ”‚ โ”œโ”€โ”€ push.yml # Model deployment workflow
โ”‚ โ”œโ”€โ”€ ci.yml # Code quality checks
โ”‚ โ””โ”€โ”€ format.yml # Code formatting
โ”‚
โ”œโ”€โ”€ test_prediction.py # Local testing utility
โ”œโ”€โ”€ requirements.txt # Dependencies
โ”œโ”€โ”€ LICENSE # AGPL-3.0 license
โ””โ”€โ”€ README.md # This file
```

## โšก Quick Start

### Deploy YOLO11n Model

Model will deploy to https://replicate.com/ultralytics/yolo11n:

```bash
# Clone repository
git clone https://github.com/ultralytics/replicate.git
cd replicate

# Deploy to Replicate
cd yolo11n
cog login
cog push r8.im/ultralytics/yolo11n
```

### Automated Deployment with GitHub Actions

1. **Setup secrets:**
- Go to repository Settings โ†’ Secrets โ†’ Actions
- Add `REPLICATE_API_TOKEN` with your [Replicate API token](https://replicate.com/auth/token)

2. **Deploy:**
- **Manual**: Actions tab โ†’ "Push YOLO11n to Replicate" โ†’ Run workflow
- **Automatic**: Push changes to `main` branch auto-deploys

## ๐Ÿ› ๏ธ Installation

Install Cog (Replicate's deployment tool):

```bash
sudo curl -o /usr/local/bin/cog -L https://github.com/replicate/cog/releases/latest/download/cog_$(uname -s)_$(uname -m)
sudo chmod +x /usr/local/bin/cog
```

For local development and testing:

```bash
pip install -r requirements.txt
```

## ๐ŸŽฏ YOLO11n Model

- **Purpose**: Official YOLO11n object detection
- **Parameters**: 2.6M parameters
- **Classes**: 80 COCO classes
- **Performance**: 39.5 mAP50-95 on COCO dataset
- **Speed**: Optimized for real-time inference

## ๐Ÿ”ง Model Setup

The model will be automatically downloaded by ultralytics when needed:

```python
from ultralytics import YOLO

model = YOLO("yolo11n.pt") # Downloads automatically if not present
```

## ๐Ÿงช Local Testing

Test the model locally before deploying:

```bash
# Test YOLO11n
python test_prediction.py --model yolo11n --image test.jpg
```

## ๐Ÿš€ Features

- **๐ŸŽ๏ธ Optimized**: PyTorch model for fast inference
- **๐Ÿค– Automated**: GitHub Actions for CI/CD
- **๐Ÿ“ฆ Ready-to-use**: Pre-configured YOLO11n deployment
- **๐Ÿ“Š Scalable**: Auto-scaling Replicate infrastructure
- **๐ŸŽฏ Simple**: Single model focus

## ๐Ÿ’ก Contribute

Ultralytics thrives on community collaboration, and we deeply value your contributions! Whether it's reporting bugs, suggesting features, or submitting code changes, your involvement is crucial.

- **Reporting Issues**: Encounter a bug? Please report it on [GitHub Issues](https://github.com/ultralytics/replicate/issues).
- **Feature Requests**: Have an idea for improvement? Share it via [GitHub Issues](https://github.com/ultralytics/replicate/issues).
- **Pull Requests**: Want to contribute code? Please read our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) first, then submit a Pull Request.
- **Feedback**: Share your thoughts and experiences by participating in our official [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey).

A heartfelt thank you ๐Ÿ™ goes out to all our contributors! Your efforts help make Ultralytics tools better for everyone.

[![Ultralytics open-source contributors](https://raw.githubusercontent.com/ultralytics/assets/main/im/image-contributors.png)](https://github.com/ultralytics/ultralytics/graphs/contributors)

## ๐Ÿ“„ License

Ultralytics offers two licensing options to accommodate diverse needs:

- **AGPL-3.0 License**: Ideal for students, researchers, and enthusiasts passionate about open collaboration and knowledge sharing. This [OSI-approved](https://opensource.org/license/agpl-v3) open-source license promotes transparency and community involvement. See the [LICENSE](LICENSE) file for details.
- **Enterprise License**: Designed for commercial applications, this license permits the seamless integration of Ultralytics software and AI models into commercial products and services, bypassing the copyleft requirements of AGPL-3.0. For commercial use cases, please inquire about an [Ultralytics Enterprise License](https://www.ultralytics.com/license).

## ๐Ÿ“ฎ Contact

For bug reports or feature suggestions related to this project or other Ultralytics projects, please use [GitHub Issues](https://github.com/ultralytics/replicate/issues). For general questions, discussions, and community support, join our [Discord](https://discord.com/invite/ultralytics) server!




Ultralytics GitHub
space
Ultralytics LinkedIn
space
Ultralytics Twitter
space
Ultralytics YouTube
space
Ultralytics TikTok
space
Ultralytics BiliBili
space
Ultralytics Discord