Clarifai Apple SDK

Hello and welcome! This is the public repository of the Clarifai SDK for Apple platforms. We currently support iOS, but plans are in the works to expand.

Our vision at Clarifai is to answer every question. And with this SDK we can help you to bring power A.I. to mobile applications. Check our developer's site at https://developer.clarifai.com or contact us at [email protected] to learn more.

Getting started

Git LFS

Before we proceed with the installation, please make sure you have Git-LFS installed on your system. The binary contained in the framework is managed by GitHub using git-lfs.

If you don't have it installed yet, you can find details at: https://git-lfs.github.com. IF YOU DON'T HAVE GIT-LFS INSTALLED, THE SDK WILL NOT WORK.

Getting a developer account

Sign up for a free developer account at: https://developer.clarifai.com/signup/

The Clarifai-Apple-SDK is available via CocoaPods or can be installed manually. Follow the instructions below based on your preference.

CocoaPods

To integrate the SDK using CocoaPods, specify it in your Podfile:

target '<Your Target>' do
    platform :ios, '9.0'
    use_frameworks!

    pod 'Clarifai-Apple-SDK', '~> 3.0.0'
end

Install with:

# Use this option the first time you want to install the SDK in your project, but also every time you edit your Podfile to add, update or remove a pod.
pod install

or

# Use this option to find an updated version of the SDK. It will update the pod to the latest version possible, as long as it complies with restrictions in your Podfile
pod update

In the event an update is available, but not reflected in your project, you may try:

pod install --repo-update

iOS 9.0 is the minimum version supported by the Clarifai SDK.

Manual installation

The best way to stay up-to-date with the latest version of the SDK with a manual installation is to clone our GitHub repo.

git clone https://github.com/Clarifai/clarifai-apple-sdk.git

1. In your project's root directory, $(PROJECT_DIR) [the same directory as the .xcodeproj file], create a directory named Clarifai and move the Clarifai-Apple-SDK.framework to that directory

   cd <project root directory>
   mkdir Clarifai
   cp -r <directory the SDK was cloned to>/Clarifai_Apple_SDK.framework <project root directory>/Clarifai
   

2. Also, copy to the same Clarifai directory, the setup_framework.sh script.

   cp -r <directory the SDK was cloned to>/scripts/setup_framework.sh <project root directory>/Clarifai
   

3. Add the Clarifai-Apple-SDK.framework to your project's Embedded Binaries.

   • From your Xcode project/workspace go to the project configurations, General tab, and click the + button under the Embedded Binaries section. Navigate to the directory where you cloned the repository and select the Clarifai-Apple-SDK.framework

4. Include the following required dependencies to Linked Frameworks and Libraries:

   • Accelerate.framework
   • CoreGraphics.framework
   • Foundation.framework
   • libc++
   • libsqlite3
   • libz
   • UIKit.framework

5. Create a new Run Script Build Phase (Xcode > Editor > Add Build Phase > Add Run Script Build Phase). In the execution line enter:

   "$PROJECT_DIR/Clarifai/setup_framework.sh"
   

6. Make sure the position of the new Run Script is after Compile Sources and before Link Binary With Libraries. If needed drag and drop it to the right position.

You should be able to build your project and start using the SDK in your project.

Start the SDK

The Clarifai SDK is initialized by calling the startWithApiKey method. We recommend to start it when your app finishes launching, but that is not absolutely required. And don't worry about hogging the launching of your app. We offload the work to background threads; there should be little to no impact.

• Swift

  import Clarifai_Apple_SDK
  
  func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
      Clarifai.sharedInstance().start(apiKey:"<Your API Key>")
  
      return true
  }
  

• Objective-C

  @import Clarifai_Apple_SDK;
  
  - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
      [[Clarifai sharedInstance] startWithApiKey:@"<Your API Key>"];
  
      return YES;
  }
  

General model availability notifications

Clarifai's general model becomes available to the SDK on demand. After you start the SDK for the first time, with a valid API Key, the model will be made available and cached locally for future faster use.

You can be notified on the progress of the availability of the SDK by registering to listen to the following notifications:

The first two notifications usually happen only once, when you first use the SDK. After becoming available a model remains cached locally. The last notification, on the other hand, is broadcast every time the SDK is started.

Each of the notifications above contain a payload (userInfo) with the id of the model. Retrieve it by using the CAIModelUniqueIdentifierKey key.

• Swift

  func handleModelDidBecomeAvailable(notification: NSNotification) {
      if let userInfo = notification.userInfo {
          let modelId = userInfo[CAIModelDidBecomeAvailable] as? String
      }
  }
  

• Objective-C

  - (void)handleModelDidBecomeAvailable:(NSNotification *)notification {
      NSDictionary *userInfo = [notification UserInfo];
      NSString *modelId = userInfo[CAIModelUniqueIdentifierKey];
  }
  

Learn and do more

Check out our documentation site to learn a lot more about how to bring A.I. to your app.

Support

Questions? Have an issue? Send us a message at [email protected].

License

The Clarifai-Apple-SDK is available under a commercial license. See the LICENSE file for more information.