Increased App Size #26

lks-nbg · 2021-05-23T08:52:16Z

After implementing google_ml_kit, the app size is increased by ~85 MB in debug mode and ~44 MB in release mode. I investigated this with the app size tool and found that all models/resources are always included, even if they are not used. So it would be great to be able to configure which resources are used and and which can be excluded.

The firebase_ml_vision plugin had the same issue (firebase/flutterfire#4767) and I was able to adapt the workaround of excluding unused resources to google_ml_kit and wanted to share it. In my case I am currently only using the language detection feature therefore I don't need pose detection, etc.

The workaround for Android looks like that and increases the app size by less than 3 MB:

android {

    // some other code 

    buildTypes {
        release {
            // some other code 

            aaptOptions {
                ignoreAssetsPattern '!mlkit_pose:!mlkit_label_default_model:'
            }
        }
        debug {
            // some other code 

            aaptOptions {
                ignoreAssetsPattern '!mlkit_pose:!mlkit_label_default_model:'
            }
        }
    }

    packagingOptions {
        exclude 'lib/**/libtranslate_jni.so'
        exclude 'lib/**/libdigitalink.so'
        exclude 'lib/**/libxeno_native.so'
        exclude 'lib/**/libmlkitcommonpipeline.so'
        exclude 'lib/**/libbarhopper_v2.so'
        exclude 'lib/**/libclassifier_jni.so'
        exclude 'lib/**/libface_detector_v2_jni.so'
        exclude 'lib/**/libtensorflowlite_jni.so'
        // exclude 'lib/**/liblanguage_id_jni.so' → required for language detection
    }

Since a workaround does exist, this is not a pressing issue, but I think many developers would appreciate some sort of configuration option :)

The text was updated successfully, but these errors were encountered:

bharat-biradar · 2021-05-23T17:36:51Z

@lks-nbg Thanks for pointing it out. I'll add this in the docs.

adriancsbna · 2021-05-24T23:12:07Z

Hi @lks-nbg
Which one should I comment to use image label?

bharat-biradar · 2021-05-25T03:38:12Z

@adriancsbna libclassifier_jni

adriancsbna · 2021-05-25T16:50:31Z

Hello @bharat-biradar.

I have applied it but the size of the App has not decreased.
What should I add in ignoreAssetsPattern?

MalayAgrawal · 2021-05-25T20:39:09Z

Yep, this did work it reduced my app-release.apk size from 323MB to 86MB but can I reduce it even more? because I only want to use OCR (image text reader).

bharat-biradar · 2021-05-26T06:20:09Z

@adriancsbna Could give me the android part of build.gradle that you used in your app. The same section mentioned by iks-ngb

bharat-biradar · 2021-05-26T06:27:44Z

@MalayAgrawal Maybe it can be reduced. I looked at the size of our example app using devtools and I found this.

You can exclude models by mentioning it in ignoreAssetsPattern but I'm not sure which among these models are used for OCR.

First try by excluding whole model folder and then individually for each older. Let me know if it works.

adriancsbna · 2021-05-26T19:34:25Z

Hi @bharat-biradar here you have it

I managed to reduce the size by adding ignoreAssetsPattern '!mlkit_pose:' but I'm sure I can add more to lower the size further. Do you know what options there are to add there?

buildTypes {
release {
signingConfig signingConfigs.debug
aaptOptions {
ignoreAssetsPattern '!mlkit_pose:'
}
}
debug {
signingConfig signingConfigs.debug
aaptOptions {
ignoreAssetsPattern '!mlkit_pose:'
}
}
}

packagingOptions {
    exclude 'lib/**/libtranslate_jni.so'
    exclude 'lib/**/libdigitalink.so'
    exclude 'lib/**/libxeno_native.so'
    //exclude 'lib/**/libmlkitcommonpipeline.so'
    exclude 'lib/**/libbarhopper_v2.so'
    //exclude 'lib/**/libclassifier_jni.so'
    exclude 'lib/**/libface_detector_v2_jni.so'
    exclude 'lib/**/libtensorflowlite_jni.so'
    exclude 'lib/**/liblanguage_id_jni.so'
}

MalayAgrawal · 2021-05-26T19:40:36Z

buildTypes {
       release {
           signingConfig signingConfigs.release
            aaptOptions {
                ignoreAssetsPattern "mlkit_pose"
            }
       }
   }
   packagingOptions {
        exclude 'lib/**/libtranslate_jni.so'
        exclude 'lib/**/libdigitalink.so'
        exclude 'lib/**/libxeno_native.so'
        exclude 'lib/**/libmlkitcommonpipeline.so'
        exclude 'lib/**/libbarhopper_v2.so'
        exclude 'lib/**/libclassifier_jni.so'
        exclude 'lib/**/libface_detector_v2_jni.so'
        exclude 'lib/**/libtensorflowlite_jni.so'
        exclude 'lib/**/liblanguage_id_jni.so'
    }

OCR is working great and app size reduced to 30MB approx

bharat-biradar · 2021-05-27T04:10:33Z

@adriancsbna Try adding models along with mlkit_pose

TusharPatel18 · 2021-05-27T04:12:18Z

since I'm using this package for scanning barcode to get results which unnecessary lib and models i need to excluded?
Thank you in advance : )

bharat-biradar · 2021-05-27T09:40:10Z

@TusharPatel18 I think you should comment out common pipeline and libbarh... I'm not sure I'm guessing as it looks similar to barcode, in in ignore assets add mlkit_pse and image label. Scroll up to see this implementation

AlexHartford · 2021-05-27T15:20:43Z

since I'm using this package for scanning barcode to get results which unnecessary lib and models i need to excluded?
Thank you in advance : )

One of my apps only uses it for barcode scanning, the following is how I have it configured:

Click to expand

packagingOptions {
    exclude 'lib/**/libtranslate_jni.so'
    exclude 'lib/**/libdigitalink.so'
    exclude 'lib/**/libxeno_native.so'
    exclude 'lib/**/libmlkitcommonpipeline.so'
    // exclude 'lib/**/libbarhopper_v2.so' → required for barcode detection
    exclude 'lib/**/libclassifier_jni.so'
    exclude 'lib/**/libface_detector_v2_jni.so'
    exclude 'lib/**/libtensorflowlite_jni.so'
    exclude 'lib/**/liblanguage_id_jni.so'
}

AlexHartford · 2021-05-27T15:23:37Z

I'm not super familiar with the iOS side of things, is there an equivalent solution for iOS? Or is it necessary at all?

fbernaly · 2021-05-27T16:05:33Z

not for now, 3rd party dependencies are managed in Xcode using Cocoapods or Swift Package Manager, ours uses Cocoapods. Eventually I will work on a way to only add the scanners you need, but for now in iOS the bundle comes with all.

ashwinkey04 · 2021-05-29T16:46:34Z

I am working on an app to use face detection only. Is there any more stuff I can add to the ignoreAssetsPattern under aaptOptions to use only face recognition?

My current release app size is 58MB. The app is basically the example app from this repo with everything removed except the face recognition parts.

This is my current aaptOptions

aaptOptions {
                ignoreAssetsPattern '!mlkit_pose:!mlkit_label_default_model:'
            }

bharat-biradar · 2021-05-29T17:05:32Z

@ashwinkey04 Analyze the app size through dev tools and look at the instances under assets section. Try removing those which seem unnecessary. An example screenshot can be obtained above.

ashwinkey04 · 2021-05-30T04:52:45Z

Thanks a lot @bharat-biradar. I removed a few models without breaking the app and managed to bring the size down to 35 MB for the bulk release apk and 23 MB for v8a. Yet to try and remove more assets as I am expected to make something less than 10 MB. Thanks for the time :)

bhanuka96 · 2021-06-01T12:15:40Z

@adriancsbna Thanks. how to reduce app size in IOS?

tokyokamera · 2021-06-07T04:23:40Z

I want to use Japanese Text recognition only. What should I do?

wazini-john · 2021-07-01T08:55:33Z

@ashwinkey04 What did you exclude for only facedetection ?

wazini-john · 2021-07-01T09:03:00Z

I'm only using facedetector
My gradle file looks like this

buildTypes {
		release {
			// TODO: Add your own signing config for the release build.
			// Signing with the debug keys for now, so `flutter run --release` works.
			signingConfig signingConfigs.debug
			aaptOptions {
				ignoreAssetsPattern 'mlkit_pose'
				ignoreAssetsPattern '!mlkit_pose:!mlkit_label_default_model:'
				ignoreAssetsPattern '!mlkit_pose:'
			}
		}
		debug {
			aaptOptions {
				ignoreAssetsPattern 'mlkit_pose'
				ignoreAssetsPattern '!mlkit_pose:!mlkit_label_default_model:'
				ignoreAssetsPattern '!mlkit_pose:'
			}
		}
	}
	packagingOptions {
		exclude 'lib/**/libtranslate_jni.so'
		exclude 'lib/**/libdigitalink.so'
		exclude 'lib/**/libxeno_native.so'
		exclude 'lib/**/libmlkitcommonpipeline.so'
		exclude 'lib/**/libbarhopper_v2.so'
		exclude 'lib/**/libclassifier_jni.so'
		exclude 'lib/**/libpredictor_jni.so'
		exclude 'lib/**/libtextclassifier3_jni_tclib.so'
		// exclude 'lib/**/libface_detector_v2_jni.so'
		exclude 'lib/**/libtensorflowlite_jni.so'
		exclude 'lib/**/liblanguage_id_jni.so'
	}

But the size is still huge.. especially the hobbes.tflite,

What else do I exclude ?

bharat-biradar · 2021-07-01T11:58:24Z

@wazini-john Try excluding hobbes.tflite it should not be related to face detection IG.

deepaklohmod6789 · 2021-07-01T11:59:34Z

How can i remove hobbes.tflite, I also need only for face detection

bharat-biradar · 2021-07-01T12:08:12Z

@deepaklohmod6789 Mention hobbes.tflite in ignoreAssetsPattern along with any other assets you want to ignore. Refer to the example above.

deepaklohmod6789 · 2021-07-01T12:09:10Z

aaptOptions {
                ignoreAssetsPattern 'mlkit_pose'
                ignoreAssetsPattern 'hobbes.tflite'
                ignoreAssetsPattern '!mlkit_pose:!mlkit_label_default_model:'
                ignoreAssetsPattern '!mlkit_pose:'
            }

I did this but still the size is 86.6 mb

cngeru · 2021-07-01T13:54:14Z

@deepaklohmod6789 run flutter clean then flutter pub get...
combine all options to one string ignoreAssetsPattern '!mlkit_pose:!mlkit_label_default_model:!hobbes.tflite:'

deepaklohmod6789 · 2021-07-01T15:03:59Z

@cngeru thanks a lot, it worked : )

fbernaly · 2021-07-06T16:15:30Z

@swissonid, @SatishKumarRaizada: collaboration is always welcome, feel free to send a PR with what you are proposing

bharat-biradar · 2021-07-06T16:43:50Z

@swissonid I am checking if we can work with unbundled models instead of model bundels. If it works I think size won't be an issue then.

swissonid · 2021-07-07T11:28:27Z

@fbernaly I spend yesterday on smaller lib (google_ml_vision )because that the one we use right now. Anyway, the problem is the same. And with a "simple" PR it isn't done. If the vision of this Plugin / Lib is to split it into smaller pieces, that will a fundamental change in the architecture. And gonna take its time.
This is a sketched possible solution. Not Yet finished.

fbernaly · 2021-07-07T16:50:51Z

Thanks @swissonid : I will look at it. Splitting this plugin into multiple packages will take some time. First we need to have parity between iOS and Android, because right now we have some features implemented in Android but not in iOS.

NighttCoder · 2021-08-19T20:36:53Z

Any ideas to reduce AppSize in iOS. I am only using OCR and app size after including this plugin increases by ~50MB.

Surajsahani28 · 2021-09-16T14:24:17Z

How we reduce app size in IOS ?

NighttCoder · 2021-09-16T16:47:21Z

@Surajsahani28 I couldn’t find a way to reduce the app size with this plugin..I ended using the cloud ocr ..

hesmnyn · 2021-09-22T08:15:40Z

not for now, 3rd party dependencies are managed in Xcode using Cocoapods or Swift Package Manager, ours uses Cocoapods. Eventually I will work on a way to only add the scanners you need, but for now in iOS the bundle comes with all.

any update?
@fbernaly

PabloLavin · 2021-09-30T21:58:52Z

If it's not too much to ask for, I would love if anybody can list what
ignoreAssetsPattern
and
packagingoptions

refer to each of the ML Kit assets, or share a link of any docs that talk about that.

itssidhere · 2021-10-08T15:31:06Z

For anybody looking to seriously reduce the size, I would suggest going to the plugin implementation.
Comment unnecessary files in the build.grade. Then comment all the files src>nlp / src>vision based on what you need. This is a hit and trial method and you will get few errors just keep commenting down things whose implementation you have commented and in the end, it will compile. In my case, I only needed the translator plugin. It is easier than going through apk size tool again and again.

dependencies {
    // implementation 'com.google.android.gms:play-services-mlkit-barcode-scanning:16.2.1'

    // implementation 'com.google.android.gms:play-services-mlkit-image-labeling:16.0.5'
    // implementation 'com.google.mlkit:image-labeling-custom:16.3.1'
    // implementation 'com.google.mlkit:image-labeling-automl:16.2.1'

    // implementation 'com.google.android.gms:play-services-mlkit-text-recognition:17.0.0'
    // implementation 'com.google.mlkit:language-id:17.0.0'
    // implementation 'com.google.mlkit:digital-ink-recognition:17.0.0'

    // implementation 'com.google.mlkit:pose-detection:17.0.1-beta5'
    // implementation 'com.google.mlkit:pose-detection-accurate:17.0.1-beta5'

     implementation 'com.google.mlkit:translate:16.1.2'
    // implementation 'com.google.mlkit:entity-extraction:16.0.0-beta2'
    // implementation 'com.google.mlkit:smart-reply:16.2.0'

    // implementation 'com.google.mlkit:object-detection:16.2.6'
    // implementation 'com.google.mlkit:object-detection-custom:16.3.3'
    // implementation 'com.google.mlkit:linkfirebase:16.1.1'

    // implementation 'com.google.android.gms:play-services-mlkit-face-detection:16.2.0'
}

ljmatan · 2021-10-24T14:01:12Z

If anyone is interested in barcode / QR scanning only, you can check out this fork.

Please note: it's not reflective of how you should do native programming properly, but it works with a previous barcode scanner implementation in Flutter.

panmari · 2021-10-26T20:36:29Z

Looks like the most fool-proof way to decrease size is to

Create a fork
Do what Increased App Size #26 (comment) suggests and remove all dependencies you don't need
Depend on your fork.

@bharat-biradar do you have a suggestion on how to get this behavior implemented upstream?

bharat-biradar · 2021-10-28T13:07:50Z

@panmari A way to use from your fork would be to

Fork the repo
Comment out the API's you don't want to use from the build.gradle (dependencies corresponding to particular API's can be easily identified from the name)
At this stage there should be errors showing in some classes delete them then comment out the their usage instance in MlKitMethodCallHandler.java over here
And this should be done by this point

I have made an example in the barcode_only branch. Hope this helps.

nachtmaar · 2021-10-29T09:35:37Z

@bharat-biradar Thank you for the idea.

I created a fork for

text identification
language identification

For the iOS side: wouldn't conditional compilation help ? That is the same as deleting the not needed files. But then we still need a solution for the CocoaPods podspec so that only the necessary dependencies are pulled by CocoaPods.

bharat-biradar · 2021-10-31T16:46:21Z

@nachtmaar Sorry but I don't know about Ios side of things but please try and if it works, please mention it here.

svprdga · 2021-11-12T17:29:12Z

Thanks @nachtmaar for the effort of creating the fork, that was exactly what I was looking for.

anounman · 2022-02-12T06:20:53Z

i only use pose detection and my aaptOptions is

`aaptOptions {
ignoreAssetsPattern '!mlkit_ocr:!mlkit_label_default_model:'
ignoreAssetsPattern 'hobbes.tflite'

}`

packagingOptions { exclude 'lib/**/libtranslate_jni.so' exclude 'lib/**/libdigitalink.so' exclude 'lib/**/libxeno_native.so' exclude 'lib/**/libmlkitcommonpipeline.so' exclude 'lib/**/libbarhopper_v2.so' exclude 'lib/**/libclassifier_jni.so' exclude 'lib/**/libface_detector_v2_jni.so' exclude 'lib/**/libtensorflowlite_jni.so' // exclude 'lib/**/liblanguage_id_jni.so' → required for language detection }

but it's size still 129 mb please help me to reduce the size.

fbernaly · 2022-04-21T17:16:51Z

We released a new version of google_ml_kit in which we have split all the plugins in multiple plugins to avoid removing the models for API you are not using, go to our readme and start using the new plugin you need.

More details here:

https://github.com/bharat-biradar/Google-Ml-Kit-plugin/tree/master/packages/google_ml_kit

Visio-Biswaroop · 2023-04-08T10:58:16Z

Hi, I am using:
dependencies {
...
...
implementation 'com.google.mlkit:translate:17.0.1'
...
}
I want to just use Language X (any one language) to English translation. Is there a way I can optimise MLKit further to reduce my apk size?

bharat-biradar mentioned this issue May 29, 2021

Why app size increase after add this plugin? #39

Closed

bharat-biradar mentioned this issue Jun 20, 2021

How To Exclude Asset for App Size? #65

Closed

bharat-biradar mentioned this issue Jul 12, 2021

Reduce app size by using unbundled models #76

Closed

CaoGiaHieu-dev mentioned this issue Jul 22, 2021

Can't run on android #98

Closed

Parthib mentioned this issue Aug 21, 2021

This lib contain all ML libs, it should be divided #116

Closed

bharat-biradar mentioned this issue Aug 31, 2021

Simple ML Text Recognition app on android is 110 mb #132

Closed

bharat-biradar mentioned this issue Oct 5, 2021

application size is increased with Google-ML-Kit #152

Closed

This was referenced Oct 29, 2021

Remove unnecessary mlkit modules #160

Closed

Remove unnecessary mlkit modules Glutyfree/Google-Ml-Kit-plugin#1

Merged

devtronic mentioned this issue Jan 8, 2022

Crashing app when running facedetection in Image stream function of camera plugin . #110

Closed

millerovv mentioned this issue Apr 12, 2022

Remove unnecessary ml-kit modules simpleclub-extended/Google-Ml-Kit-plugin#1

Merged

fbernaly closed this as completed Apr 21, 2022

melchorlapinigjr mentioned this issue Sep 15, 2023

App crash with google_mlkit_barcode_scanning: ^0.8.0 #493

Closed

Increased App Size #26

Increased App Size #26

Comments

lks-nbg commented May 23, 2021

bharat-biradar commented May 23, 2021 • edited Loading

adriancsbna commented May 24, 2021

bharat-biradar commented May 25, 2021

adriancsbna commented May 25, 2021

MalayAgrawal commented May 25, 2021 • edited Loading

bharat-biradar commented May 26, 2021

bharat-biradar commented May 26, 2021

adriancsbna commented May 26, 2021

MalayAgrawal commented May 26, 2021

bharat-biradar commented May 27, 2021

TusharPatel18 commented May 27, 2021 • edited Loading

bharat-biradar commented May 27, 2021

AlexHartford commented May 27, 2021

AlexHartford commented May 27, 2021

fbernaly commented May 27, 2021

ashwinkey04 commented May 29, 2021 • edited Loading

bharat-biradar commented May 29, 2021

ashwinkey04 commented May 30, 2021

bhanuka96 commented Jun 1, 2021 • edited Loading

tokyokamera commented Jun 7, 2021

wazini-john commented Jul 1, 2021

wazini-john commented Jul 1, 2021

bharat-biradar commented Jul 1, 2021

deepaklohmod6789 commented Jul 1, 2021

bharat-biradar commented Jul 1, 2021

deepaklohmod6789 commented Jul 1, 2021

cngeru commented Jul 1, 2021

deepaklohmod6789 commented Jul 1, 2021

fbernaly commented Jul 6, 2021

bharat-biradar commented Jul 6, 2021

swissonid commented Jul 7, 2021

fbernaly commented Jul 7, 2021 • edited Loading

NighttCoder commented Aug 19, 2021

Surajsahani28 commented Sep 16, 2021

NighttCoder commented Sep 16, 2021

hesmnyn commented Sep 22, 2021

PabloLavin commented Sep 30, 2021

itssidhere commented Oct 8, 2021

ljmatan commented Oct 24, 2021

panmari commented Oct 26, 2021

bharat-biradar commented Oct 28, 2021

nachtmaar commented Oct 29, 2021

bharat-biradar commented Oct 31, 2021

svprdga commented Nov 12, 2021

anounman commented Feb 12, 2022 • edited Loading

fbernaly commented Apr 21, 2022

Visio-Biswaroop commented Apr 8, 2023

bharat-biradar commented May 23, 2021 •

edited

Loading

MalayAgrawal commented May 25, 2021 •

edited

Loading

TusharPatel18 commented May 27, 2021 •

edited

Loading

ashwinkey04 commented May 29, 2021 •

edited

Loading

bhanuka96 commented Jun 1, 2021 •

edited

Loading

fbernaly commented Jul 7, 2021 •

edited

Loading

anounman commented Feb 12, 2022 •

edited

Loading