Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ultralytics/yolo-ios-app
Ultralytics YOLO iOS App source code for running YOLOv8 in your own iOS apps 🌟
https://github.com/ultralytics/yolo-ios-app
ai app app-store coreml instance-segmentation ios ml object-detection real-time swift ultralytics xcode yolo yolov8
Last synced: 1 day ago
JSON representation
Ultralytics YOLO iOS App source code for running YOLOv8 in your own iOS apps 🌟
- Host: GitHub
- URL: https://github.com/ultralytics/yolo-ios-app
- Owner: ultralytics
- License: agpl-3.0
- Created: 2024-02-11T16:02:29.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-08-26T14:03:16.000Z (about 1 month ago)
- Last Synced: 2024-08-26T16:30:28.222Z (about 1 month ago)
- Topics: ai, app, app-store, coreml, instance-segmentation, ios, ml, object-detection, real-time, swift, ultralytics, xcode, yolo, yolov8
- Language: Swift
- Homepage: https://ultralytics.com/yolo
- Size: 110 KB
- Stars: 114
- Watchers: 2
- Forks: 20
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-yolo-object-detection - ultralytics/yolo-ios-app - ios-app?style=social"/> : Ultralytics YOLO iOS App source code for running YOLOv8 in your own iOS apps 🌟. [ultralytics.com/yolo](https://ultralytics.com/yolo) (Applications)
- awesome-yolo-object-detection - ultralytics/yolo-ios-app - ios-app?style=social"/> : Ultralytics YOLO iOS App source code for running YOLOv8 in your own iOS apps 🌟. [ultralytics.com/yolo](https://ultralytics.com/yolo) (Applications)
README
# 🚀 Ultralytics YOLO iOS App
[](https://github.com/ultralytics/yolo-ios-app/actions/workflows/format.yml) 
Welcome to the [Ultralytics YOLO iOS App](https://apps.apple.com/us/app/idetection/id1452689527) GitHub repository! 📖 Leveraging Ultralytics' advanced [YOLOv8 object detection models](https://github.com/ultralytics/ultralytics), this app transforms your iOS device into an intelligent detection tool. Explore our guide to get started with the Ultralytics YOLO iOS App and discover the world in a new and exciting way.
## 🛠 Quickstart: Setting Up the Ultralytics YOLO iOS App
Getting started with the Ultralytics YOLO iOS App is straightforward. Follow these steps to install the app on your iOS device.
### Prerequisites
Ensure you have the following before you start:
- **Xcode:** The Ultralytics YOLO iOS App requires Xcode installed on your macOS machine. Download it from the [Mac App Store](https://apps.apple.com/us/app/xcode/id497799835).
- **An iOS Device:** For testing the app, you'll need an iPhone or iPad running [iOS 14.0](https://www.apple.com/ios/ios-17/) or later.
- **An Apple Developer Account:** A free Apple Developer account will suffice for device testing. Sign up [here](https://developer.apple.com/) if you haven't already.
### Installation
1. **Clone the Repository:**
```sh
git clone https://github.com/ultralytics/yolo-ios-app.git
```
2. **Open the Project in Xcode:**
Navigate to the cloned directory and open the `YOLO.xcodeproj` file.
In Xcode, go to the project's target settings and choose your Apple Developer account under the "Signing & Capabilities" tab.
3. **Add YOLOv8 Models to the Project:**
Export CoreML INT8 models using the `ultralytics` Python package (with `pip install ultralytics`), or download them from our [GitHub release assets](https://github.com/ultralytics/yolo-ios-app/releases). You should have 5 YOLOv8 models in total. Place these in the `YOLO/Models` directory as seen in the Xcode screenshot below.
```python
from ultralytics import YOLO
# Loop through all YOLOv8 model sizes
for size in ("n", "s", "m", "l", "x"):
# Load a YOLOv8 PyTorch model
model = YOLO(f"yolov8{size}.pt")
# Export the PyTorch model to CoreML INT8 format with NMS layers
model.export(format="coreml", int8=True, nms=True, imgsz=[640, 384])
```
4. **Run the Ultralytics YOLO iOS App:**
Connect your iOS device and select it as the run target. Press the Run button to install the app on your device.
## 🚀 Usage
The Ultralytics YOLO iOS App is designed to be intuitive:
- **Real-Time Detection:** Launch the app and aim your camera at objects to detect them instantly.
- **Multiple AI Models:** Select from a range of Ultralytics YOLOv8 models, from YOLOv8n 'nano' to YOLOv8x 'x-large'.
## 💡 Contribute
We warmly welcome your contributions to Ultralytics' open-source projects! Your support and contributions significantly impact. Get involved by reviewing our [Contributing Guide](https://docs.ultralytics.com/help/contributing), and share your feedback through our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A massive thank you 🙏 to everyone who contributes!
## 📄 License
Ultralytics offers two licensing options:
- **AGPL-3.0 License**: An [OSI-approved](https://opensource.org/license) open-source license, perfect for academics, researchers, and enthusiasts. It encourages sharing knowledge and collaboration. See the [LICENSE](https://github.com/ultralytics/ultralytics/blob/main/LICENSE) file for details.
- **Enterprise License**: Designed for commercial use, this license permits integrating Ultralytics software into proprietary products and services. For commercial use, please contact us through [Ultralytics Licensing](https://www.ultralytics.com/license).
## 🤝 Contact
- Submit Ultralytics bug reports and feature requests via [GitHub Issues](https://github.com/ultralytics/yolo-ios-app/issues).
- Join our [Discord](https://discord.com/invite/ultralytics) for assistance, questions, and discussions with the community and team!