google_ml_kit_flutter
google_ml_kit_flutter copied to clipboard
A flutter plugin that implements Google's standalone ML Kit
Google's ML Kit for Flutter
Google's ML Kit for Flutter is a set of Flutter plugins that enable Flutter apps to use Google's standalone ML Kit.
Features
Vision APIs
Natural Language APIs
Feature | Plugin | Source Code | Android | iOS |
---|---|---|---|---|
Language Identification | google_mlkit_language_id |
✅ | ✅ | |
On-Device Translation | google_mlkit_translation |
✅ | ✅ | |
Smart Reply | google_mlkit_smart_reply |
✅ | ✅ | |
Entity Extraction | google_mlkit_entity_extraction |
✅ | ✅ |
Requirements
iOS
- Minimum iOS Deployment Target: 10.0
- Xcode 13 or newer
- Swift 5
- ML Kit only supports 64-bit architectures (x86_64 and arm64). Check this list to see if your device has the required device capabilities.
Since ML Kit does not support 32-bit architectures (i386 and armv7), you need to exclude armv7 architectures in Xcode in order to run flutter build ios
or flutter build ipa
. More info here.
Go to Project > Runner > Building Settings > Excluded Architectures > Any SDK > armv7
Then your Podfile should look like this:
# add this line:
$iOSVersion = '10.0'
post_install do |installer|
# add these lines:
installer.pods_project.build_configurations.each do |config|
config.build_settings["EXCLUDED_ARCHS[sdk=*]"] = "armv7"
config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = $iOSVersion
end
installer.pods_project.targets.each do |target|
flutter_additional_ios_build_settings(target)
# add these lines:
target.build_configurations.each do |config|
if Gem::Version.new($iOSVersion) > Gem::Version.new(config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'])
config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = $iOSVersion
end
end
end
end
Notice that the minimum IPHONEOS_DEPLOYMENT_TARGET
is 10.0, you can set it to something newer but not older.
Android
- minSdkVersion: 21
- targetSdkVersion: 31
- compileSdkVersion: 31
Migrating from ML Kit for Firebase
When Migrating from ML Kit for Firebase read this guide.
For Android details read this.
For iOS details read this.
Firebase dependency: Custom Models
Google's standalone ML Kit library does have any direct dependency with Firebase. As designed by Google, you do not need to include Firebase in your project in order to use ML Kit. However, some ML Kit APIs have the possibility to be used with Custom Models, that means that the default models can be replaced with custom TensorFlow Lite models.
The plugins that allow Custom Models are:
iOS Additional Setup
To use custom models hosted in firebase in iOS, you have to update your app's Podfile.
First, include GoogleMLKit/LinkFirebase
and Firebase
in your Podfile:
platform :ios, '10.0'
...
# Enable firebase-hosted models #
pod 'GoogleMLKit/LinkFirebase'
pod 'Firebase'
Next, add the preprocessor flag to enable the firebase remote models at compile time. To do that, update your existing build_configurations
loop in the post_install
step with the following:
post_install do |installer|
installer.pods_project.targets.each do |target|
... # Here are some configurations automatically generated by flutter
target.build_configurations.each do |config|
# Enable firebase-hosted ML models
config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= [
'$(inherited)',
'MLKIT_FIREBASE_MODELS=1',
]
end
end
end
To setup Firebase for your project check this links:
Also please note that in latest versions, google_ml_kit has become an umbrella plugin including all the plugin listed in Features. For that reason you will need to configure Firebase in your project if using google_ml_kit. We recommend you start using the plugins listed in Features rather than using google_ml_kit, otherwise you will be including unnecessary dependencies in your project.
Example app
Find the example app here.
Contributing
Contributions are welcome. In case of any problems look at existing issues, if you cannot find anything related to your problem then open an issue. Create an issue before opening a pull request for non trivial fixes. In case of trivial fixes open a pull request directly.