joshbax / clarifai-ios

Clarifai API client for iOS.

Clarifai Objective-C Client

A client for iOS apps using the Clarifai V2 API.

• Sign up for a free developer account at: https://developer.clarifai.com/signup/
• Read the developer guide at: https://developer.clarifai.com/guide-v2/
• Read the full Objective-C docs at: http://cocoadocs.org/docsets/Clarifai/

Installation

CocoaPods

The Clarifai API client can be easily installed with CocoaPods. For more details on setting up CocoaPods, go here. To integrate Clarifai into your project, simply add the following to your Podfile:

pod 'Clarifai'

Getting Started

1. Create a new XCode project, or use a current one.

2. Add Clarifai to your Podfile and generate workspace.

   pod 'Clarifai'
   

   pod install
   

3. Import ClarifaiApp.h and any other classes you need.

   #import ClarifaiApp.h
   

4. Go to developer.clarifai.com/applications, click on your application, then copy the "Client ID" and "Client Secret" values (if you don't already have an account or application, you'll need to sign up first).

5. Create your Clarifai application in your project.

   ClarifaiApp *app = [[ClarifaiApp alloc] initWithAppID:@"" appSecret:@""];
   

6. That's it! Explore the API docs and guide.

NOTE- to use Clarifai in Swift, make sure to add use_frameworks! to your podfile and import into any swift file using: import Clarifai

Documentation

The most recent docs can be found here on Cocoadocs.

Example Project

There is a simple demo included in the repo to help you get started. To build this project, you need Xcode 8 and CocoaPods. To build and run:

1. Install dependencies and generate workspace from inside the Example folder.

   pod install
   

2. Open the workspace in Xcode

   open Clarifai.xcworkspace
   

3. Go to developer.clarifai.com/applications, click on your application, then copy the "Client ID" and "Client Secret" values (if you don't already have an account or application, you'll need to sign up first).

   Add the values of your Client ID and Client Secret to the recognizeImage method in RecognitionViewController.m.

4. Press the "Play" button in the toolbar to build, install, and run the app.