🍎 Ultralytics iOS Pods

Welcome to Ultralytics iOS Podspecs! Whether you're an iOS developer looking to integrate advanced Machine Learning models into your application, or you're curious about how to get started with AI on mobile devices, you're in the right place. This README guides you through installing and using the Ultralytics library in your iOS project using CocoaPods. Let's enhance your application with the power of AI! 🚀

🚦 Getting Started

To begin, you'll need to have CocoaPods installed on your machine. CocoaPods is a dependency manager for Swift and Objective-C Cocoa projects. It hosts over 82 thousand libraries and is used in over 3 million apps. If you haven't installed CocoaPods yet, visit the official Getting Started guide and follow the instructions there.

Once CocoaPods is installed, you can proceed with adding Ultralytics to your project by following these steps:

🛠️ Installation Steps

1. Navigate to the root directory of your iOS project in your terminal.
2. Run the command pod init. This creates a new file named Podfile in your project directory.

pod init

3. Open your Podfile in a text editor, and add the following line to include the Ultralytics pod:

pod 'Ultralytics'

4. Save your Podfile and close the text editor.
5. Back in the terminal, execute the command pod install to install the Ultralytics pod into your project.

pod install

6. Troubleshooting: If you encounter an error stating that the pod can't be found, you might need to update your local copy of the CocoaPods Specs repository. Run the following command:

pod repo update

Then, try pod install again.

7. After a successful installation, CocoaPods generates a .xcworkspace file for your project. Open this workspace file in Xcode to continue development.

open YourProjectName.xcworkspace

✨ Using Ultralytics in Your Project

Integrating Ultralytics into your codebase is as simple as importing the library where you need it:

import Ultralytics

Now, you're ready to leverage the ML capabilities provided by Ultralytics in your iOS application!

🧠 Understanding the Pod

The Ultralytics pod vends the prebuilt Ultralytics.xcframework, a client for computer vision models hosted on the Ultralytics Platform (formerly Ultralytics HUB). It is not an on-device inference engine.

To run YOLO models directly on device with Core ML — object detection, segmentation, classification, pose, and OBB — use the UltralyticsYOLO pod from ultralytics/yolo-ios-app instead:

pod 'UltralyticsYOLO'

Consider exploring the Ultralytics documentation for comprehensive insights into the various models, their functionalities, and how best to apply them to your specific use cases.

💡 Contribute

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 to get started. Also, we'd love to hear about your experience with Ultralytics products. Please consider filling out our Survey. A huge 🙏 and thank you to all of our 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 open-source license promotes transparency and community involvement. See the 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.

Note that Ultralytics.podspec declares the distributed Ultralytics.xcframework binary as commercial software, so review Ultralytics Licensing before shipping an app that includes the pod.

📮 Contact

For bug reports, feature requests, and contributions, please visit GitHub Issues. For questions, discussions, and community support, join our Discord!