MLFairy

MLFairy gives developers the tools needed to better understand their CoreML models. It gives them the ability to update and deploy their latest CoreML model. MLFairy also gives you the ability to collect predictions from your model, so you can improve your model based on real-world results from your app.

Installation

Cocoapods

For MLFairy, use the following entry in your Podfile:

pod 'MLFairy' '~> 0.0.2'

Then run pod install.

In any file you'd like to use MLFairy in, don't forget to import the framework with import MLFairy.

Carthage

Make the following entry in your Cartfile:

github "mlfairy/mlfairy" ~> 0.0.2

Then run carthage update.

If this is your first time using Carthage in the project, you'll need to go through some additional steps as explained over at Carthage.

Usage

Downloading the latest CoreML model

After installing MLFairy, you can access an API like this:

private let TOKEN = "<get your token from your account at www.mlfairy.com>"

let model = <Generated Class from .mlmodel file>()

MLFairy.getCoreMLModel(TOKEN) { response in
    switch (response.result) {
        case .success(let model):
            guard let model = model else {
                print("Failed to get CoreML model.")
                return
            }

            // Assign the returned model to your existing model
            // If you want to collect predictions, you can assign your model to response.mlFairyModel
            model.model = model
        case .failure(let error):
            print("Failed to get CoreML model \(String(describing: error)).")
    }
}

Automatically collect predictions

You can collect your model's predictions using MLFairy. You can do this with MLFairy.wrapCoreMLModel.

private let TOKEN = "<get your token from your account at www.mlfairy.com>"

let model = <Generated Class from .mlmodel file>()

model.model = MLFairy.wrapCoreMLModel(model.model, token: TOKEN)

Note: MLFairy.getCoreMLModel also returns an optional wrapped model if you are using MLFairy for model distribution.

License

MLFairy is released under an GPL-3 license. See License.txt for more information.