इस पेज का अनुवाद Cloud Translation API से किया गया है.

moduleInstallClient के साथ एपीआई की उपलब्धता पक्का करना

जैसा कि Google Play services की खास जानकारी में बताया गया है लेख में बताया गया है कि Google Play services की मदद से काम करने वाले SDK टूल, डिवाइस पर मौजूद सेवाओं की मदद से काम करते हैं Google से सर्टिफ़ाइड Android डिवाइसों के लिए उपलब्ध है. पूरे ऐप्लिकेशन में स्टोरेज और मेमोरी बचाने के लिए सभी डिवाइस शामिल हैं. इस दौरान, कुछ सेवाएं मांग पर इंस्टॉल की जाती हैं. हालांकि, ऐसा तब ही होता है, जब जो डिवाइस पर काम करने वाले फ़ंक्शन की ज़रूरत हो. उदाहरण के लिए, एमएल किट में यह विकल्प उपलब्ध है मॉडल का इस्तेमाल करते समय.

सबसे सामान्य स्थिति, किसी सेवा (या “मॉड्यूल”) को डाउनलोड करना है और को SDK टूल का AndroidManifest.xml. ज़्यादा कंट्रोल के लिए, मॉड्यूल इंस्टॉल एपीआई मॉड्यूल की उपलब्धता, अनुरोध मॉड्यूल की साफ़ तौर पर जांच करने की सुविधा देना इंस्टॉल करना, अनुरोध की स्थिति पर नज़र रखना, और गड़बड़ियों को हैंडल करना.

ModuleInstallClient के साथ एपीआई की उपलब्धता पक्का करने के लिए, नीचे दिया गया तरीका अपनाएं. ध्यान दें कि नीचे दिए गए कोड स्निपेट TensorFlow Lite SDK टूल (play-services-tflite-java) को उदाहरण लाइब्रेरी के रूप में पेश किया है, लेकिन ये चरण यह सुविधा, OptionalModuleApi के साथ इंटिग्रेट की गई किसी भी लाइब्रेरी के लिए लागू होती है. यह जैसे-जैसे ज़्यादा SDK टूल काम करने लगेंगे, गाइड में और जानकारी अपडेट हो जाएगी.

शुरू करने से पहले

अपने ऐप्लिकेशन को तैयार करने के लिए, नीचे दिए गए सेक्शन में दिए गए चरणों को पूरा करें.

ऐप्लिकेशन के लिए ज़रूरी शर्तें

पक्का करें कि आपके ऐप्लिकेशन की बिल्ड फ़ाइल में इन वैल्यू का इस्तेमाल किया गया हो:

19 या उससे ज़्यादा का minSdkVersion

अपना ऐप्लिकेशन कॉन्फ़िगर करें

अपनी टॉप-लेवल settings.gradle फ़ाइल में, इसे शामिल करें Google की Maven रिपॉज़िटरी और Maven सेंट्रल रिपॉज़िटरी dependencyResolutionManagement ब्लॉक:
```
dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
    }
}
```
अपने मॉड्यूल की ग्रेडल बिल्ड फ़ाइल (आम तौर पर app/build.gradle) में, play-services-base और इसके लिए Google Play services की डिपेंडेंसी play-services-tflite-java:
```
dependencies {
  implementation 'com.google.android.gms:play-services-base:18.5.0'
  implementation 'com.google.android.gms:play-services-tflite-java:16.2.0-beta02'
}
```

देखें कि मॉड्यूल उपलब्ध है या नहीं

ModuleInstallClient का इंस्टेंस पाएं:

Kotlin

val moduleInstallClient = ModuleInstall.getClient(context)

Java

ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

वैकल्पिक मॉड्यूल की उपलब्धता की जांच करने के लिए, OptionalModuleApi का इस्तेमाल करें:

Kotlin

val optionalModuleApi = TfLite.getClient(context)
moduleInstallClient
  .areModulesAvailable(optionalModuleApi)
  .addOnSuccessListener {
    if (it.areModulesAvailable()) {
      // Modules are present on the device...
    } else {
      // Modules are not present on the device...
    }
  }
  .addOnFailureListener {
    // Handle failure...
  }

Java

OptionalModuleApi optionalModuleApi = TfLite.getClient(context);
moduleInstallClient
    .areModulesAvailable(optionalModuleApi)
    .addOnSuccessListener(
        response -> {
          if (response.areModulesAvailable()) {
            // Modules are present on the device...
          } else {
            // Modules are not present on the device...
          }
        })
    .addOnFailureListener(
        e -> {
          // Handle failure…
        });

स्थगित इंस्टॉल का अनुरोध भेजें

ModuleInstallClient का इंस्टेंस पाएं:

Kotlin

val moduleInstallClient = ModuleInstall.getClient(context)

Java

ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

रुका हुआ अनुरोध भेजें:

Kotlin

val optionalModuleApi = TfLite.getClient(context)
moduleInstallClient.deferredInstall(optionalModuleApi)

Java

OptionalModuleApi optionalModuleApi = TfLite.getClient(context);
moduleInstallClient.deferredInstall(optionalModuleApi);

मॉड्यूल इंस्टॉल करने का ज़रूरी अनुरोध भेजें

ModuleInstallClient का इंस्टेंस पाएं:

Kotlin

val moduleInstallClient = ModuleInstall.getClient(context)

Java

ModuleInstallClient moduleInstallClient = ModuleInstall.getClient(context);

(ज़रूरी नहीं) इंस्टॉल की स्थिति को मैनेज करने के लिए, InstallStatusListener बनाएं अपडेट.

अगर आपको डाउनलोड की प्रोग्रेस को पसंद के मुताबिक बनाए गए यूज़र इंटरफ़ेस (यूआई) में मॉनिटर करना है, तो उदाहरण के लिए, प्रोग्रेस बार), तो आपके पास InstallStatusListener बनाने का विकल्प होता है, ताकि आपको इंस्टॉल की स्थिति के बारे में अपडेट मिलते रहेंगे.

Kotlin

inner class ModuleInstallProgressListener : InstallStatusListener {
  override fun onInstallStatusUpdated(update: ModuleInstallStatusUpdate) {
    // Progress info is only set when modules are in the progress of downloading.
    update.progressInfo?.let {
      val progress = (it.bytesDownloaded * 100 / it.totalBytesToDownload).toInt()
      // Set the progress for the progress bar.
      progressBar.setProgress(progress)
    }

    if (isTerminateState(update.installState)) {
      moduleInstallClient.unregisterListener(this)
    }
  }

  fun isTerminateState(@InstallState state: Int): Boolean {
    return state == STATE_CANCELED || state == STATE_COMPLETED || state == STATE_FAILED
  }
}

val listener = ModuleInstallProgressListener()

Java

static final class ModuleInstallProgressListener implements InstallStatusListener {
    @Override
    public void onInstallStatusUpdated(ModuleInstallStatusUpdate update) {
      ProgressInfo progressInfo = update.getProgressInfo();
      // Progress info is only set when modules are in the progress of downloading.
      if (progressInfo != null) {
        int progress =
            (int)
                (progressInfo.getBytesDownloaded() * 100 / progressInfo.getTotalBytesToDownload());
        // Set the progress for the progress bar.
        progressBar.setProgress(progress);
      }
      // Handle failure status maybe…

      // Unregister listener when there are no more install status updates.
      if (isTerminateState(update.getInstallState())) {

        moduleInstallClient.unregisterListener(this);
      }
    }

    public boolean isTerminateState(@InstallState int state) {
      return state == STATE_CANCELED || state == STATE_COMPLETED || state == STATE_FAILED;
    }
  }

InstallStatusListener listener = new ModuleInstallProgressListener();

ModuleInstallRequest को कॉन्फ़िगर करें और OptionalModuleApi को अनुरोध:

Kotlin

val optionalModuleApi = TfLite.getClient(context)
val moduleInstallRequest =
  ModuleInstallRequest.newBuilder()
    .addApi(optionalModuleApi)
    // Add more APIs if you would like to request multiple optional modules.
    // .addApi(...)
    // Set the listener if you need to monitor the download progress.
    // .setListener(listener)
    .build()

Java

OptionalModuleApi optionalModuleApi = TfLite.getClient(context);
ModuleInstallRequest moduleInstallRequest =
    ModuleInstallRequest.newBuilder()
        .addApi(optionalModuleApi)
        // Add more API if you would like to request multiple optional modules
        //.addApi(...)
        // Set the listener if you need to monitor the download progress
        //.setListener(listener)
        .build();

इंस्टॉल करने का अनुरोध भेजें:

Kotlin

moduleInstallClient
  .installModules(moduleInstallRequest)
  .addOnSuccessListener {
    if (it.areModulesAlreadyInstalled()) {
      // Modules are already installed when the request is sent.
    }
  }
  .addOnFailureListener {
    // Handle failure…
  }

Java

moduleInstallClient.installModules(moduleInstallRequest)
    .addOnSuccessListener(
        response -> {
          if (response.areModulesAlreadyInstalled()) {
            // Modules are already installed when the request is sent.
          }
        })
    .addOnFailureListener(
        e -> {
          // Handle failure...
        });

`FakeModuleInstallClient` की मदद से लोकल टेस्टिंग

Google Play services के SDK टूल में FakeModuleInstallClient उपलब्ध है, ताकि आप ये काम कर सकें डिपेंडेंसी का इस्तेमाल करके, टेस्ट में मॉड्यूल इंस्टॉल एपीआई के नतीजों को सिम्युलेट करता है इंजेक्शन.

ऐप्लिकेशन के लिए ज़रूरी शर्तें

इस्तेमाल करने के लिए अपने ऐप्लिकेशन को कॉन्फ़िगर करें हिट डिपेंडेंसी इंजेक्शन फ़्रेमवर्क.

जांच के लिए, `ModuleInstallClient` को `FakeModuleInstallClient` से बदलें

डिपेंडेंसी जोड़ें:

अपने मॉड्यूल की ग्रेडल बिल्ड फ़ाइल (आम तौर पर app/build.gradle) में, play-services-base-testing के लिए Google Play services की डिपेंडेंसी परीक्षण.
```
  dependencies {
    // other dependencies...

    testImplementation 'com.google.android.gms:play-services-base-testing:16.1.0'
  }
```

ModuleInstallClient देने के लिए एक Hilt मॉड्यूल बनाएं:

Kotlin

@Module
@InstallIn(ActivityComponent::class)
object ModuleInstallModule {

  @Provides
  fun provideModuleInstallClient(
    @ActivityContext context: Context
  ): ModuleInstallClient = ModuleInstall.getClient(context)
}

Java

@Module
@InstallIn(ActivityComponent.class)
public class ModuleInstallModule {
  @Provides
  public static ModuleInstallClient provideModuleInstallClient(
    @ActivityContext Context context) {
    return ModuleInstall.getClient(context);
  }
}

गतिविधि में ModuleInstallClient को इंजेक्ट करें:

Kotlin

@AndroidEntryPoint
class MyActivity: AppCompatActivity() {
  @Inject lateinit var moduleInstallClient: ModuleInstallClient

  ...
}

Java

@AndroidEntryPoint
public class MyActivity extends AppCompatActivity {
  @Inject ModuleInstallClient moduleInstallClient;

  ...
}

टेस्ट में बाइंडिंग बदलें:
Kotlin
```
@UninstallModules(ModuleInstallModule::class)
@HiltAndroidTest
class MyActivityTest {
  ...
  private val context:Context = ApplicationProvider.getApplicationContext()
  private val fakeModuleInstallClient = FakeModuleInstallClient(context)
  @BindValue @JvmField
  val moduleInstallClient: ModuleInstallClient = fakeModuleInstallClient

  ...
}
```
Java
```
@UninstallModules(ModuleInstallModule.class)
@HiltAndroidTest
class MyActivityTest {
  ...
  private static final Context context = ApplicationProvider.getApplicationContext();
  private final FakeModuleInstallClient fakeModuleInstallClient = new FakeModuleInstallClient(context);
  @BindValue ModuleInstallClient moduleInstallClient = fakeModuleInstallClient;

  ...
}
```
ध्यान दें: ऊपर दिया गया स्निपेट, @BindValue का इस्तेमाल करने का एक बुनियादी उदाहरण है. इसकी मदद से, अपने टेस्ट में ModuleInstallClient फ़ील्ड को FakeModuleInstallClient से बाइंड करें हिट डिपेंडेंसी ग्राफ़ में. आप हिलट टेस्टिंग गाइड इसकी मदद से, अपना टेस्ट मॉड्यूल बनाया जा सकता है और बाइंडिंग को बदला जा सकता है.

मॉड्यूल की उपलब्धता को सिम्युलेट करें

Kotlin

@Test
fun checkAvailability_available() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset()

  val availableModule = TfLite.getClient(context)
  fakeModuleInstallClient.setInstalledModules(api)

  // Verify the case where modules are already available...
}

@Test
fun checkAvailability_unavailable() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset()

  // Do not set any installed modules in the test.

  // Verify the case where modules unavailable on device...
}

@Test
fun checkAvailability_failed() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset()

  fakeModuleInstallClient.setModulesAvailabilityTask(Tasks.forException(RuntimeException()))

  // Verify the case where an RuntimeException happened when trying to get module's availability...
}

Java

@Test
public void checkAvailability_available() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset();

  OptionalModuleApi optionalModuleApi = TfLite.getClient(context);
  fakeModuleInstallClient.setInstalledModules(api);

  // Verify the case where modules are already available...
}

@Test
public void checkAvailability_unavailable() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset();

  // Do not set any installed modules in the test.

  // Verify the case where modules unavailable on device...
}

@Test
public void checkAvailability_failed() {
  fakeModuleInstallClient.setModulesAvailabilityTask(Tasks.forException(new RuntimeException()));

  // Verify the case where an RuntimeException happened when trying to get module's availability...
}

स्थगित इंस्टॉल के अनुरोध के नतीजे को सिम्युलेट करें

Kotlin

@Test
fun deferredInstall_success() {
  fakeModuleInstallClient.setDeferredInstallTask(Tasks.forResult(null))

  // Verify the case where the deferred install request has been sent successfully...
}

@Test
fun deferredInstall_failed() {
  fakeModuleInstallClient.setDeferredInstallTask(Tasks.forException(RuntimeException()))

  // Verify the case where an RuntimeException happened when trying to send the deferred install request...
}

Java

@Test
public void deferredInstall_success() {
  fakeModuleInstallClient.setDeferredInstallTask(Tasks.forResult(null));

  // Verify the case where the deferred install request has been sent successfully...
}

@Test
public void deferredInstall_failed() {
  fakeModuleInstallClient.setDeferredInstallTask(Tasks.forException(new RuntimeException()));

  // Verify the case where an RuntimeException happened when trying to send the deferred install request...
}

तुरंत इंस्टॉल करने के अनुरोध के नतीजे को सिम्युलेट करें

Kotlin

@Test
fun installModules_alreadyExist() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset();

  OptionalModuleApi optionalModuleApi = TfLite.getClient(context);
  fakeModuleInstallClient.setInstalledModules(api);

  // Verify the case where the modules already exist when sending the install request...
}

@Test
fun installModules_withoutListener() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset();

  // Verify the case where the urgent install request has been sent successfully...
}

@Test
fun installModules_withListener() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset();

  // Generates a ModuleInstallResponse and set it as the result for installModules().
  val moduleInstallResponse = FakeModuleInstallUtil.generateModuleInstallResponse()
  fakeModuleInstallClient.setInstallModulesTask(Tasks.forResult(moduleInstallResponse))

  // Verify the case where the urgent install request has been sent successfully...

  // Generates some fake ModuleInstallStatusUpdate and send it to listener.
  val update = FakeModuleInstallUtil.createModuleInstallStatusUpdate(
    moduleInstallResponse.sessionId, STATE_COMPLETED)
  fakeModuleInstallClient.sendInstallUpdates(listOf(update))

  // Verify the corresponding updates are handled correctly...
}

@Test
fun installModules_failed() {
  fakeModuleInstallClient.setInstallModulesTask(Tasks.forException(RuntimeException()))

  // Verify the case where an RuntimeException happened when trying to send the urgent install request...
}

Java

@Test
public void installModules_alreadyExist() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset();

  OptionalModuleApi optionalModuleApi = TfLite.getClient(context);
  fakeModuleInstallClient.setInstalledModules(api);

  // Verify the case where the modules already exist when sending the install request...
}

@Test
public void installModules_withoutListener() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset();

  // Verify the case where the urgent install request has been sent successfully...
}

@Test
public void installModules_withListener() {
  // Reset any previously installed modules.
  fakeModuleInstallClient.reset();

  // Generates a ModuleInstallResponse and set it as the result for installModules().
  ModuleInstallResponse moduleInstallResponse =
      FakeModuleInstallUtil.generateModuleInstallResponse();
  fakeModuleInstallClient.setInstallModulesTask(Tasks.forResult(moduleInstallResponse));

  // Verify the case where the urgent install request has been sent successfully...

  // Generates some fake ModuleInstallStatusUpdate and send it to listener.
  ModuleInstallStatusUpdate update = FakeModuleInstallUtil.createModuleInstallStatusUpdate(
      moduleInstallResponse.getSessionId(), STATE_COMPLETED);
  fakeModuleInstallClient.sendInstallUpdates(ImmutableList.of(update));

  // Verify the corresponding updates are handled correctly...
}

@Test
public void installModules_failed() {
  fakeModuleInstallClient.setInstallModulesTask(Tasks.forException(new RuntimeException()));

  // Verify the case where an RuntimeException happened when trying to send the urgent install request...
}

moduleInstallClient के साथ एपीआई की उपलब्धता पक्का करना

शुरू करने से पहले

ऐप्लिकेशन के लिए ज़रूरी शर्तें

अपना ऐप्लिकेशन कॉन्फ़िगर करें

देखें कि मॉड्यूल उपलब्ध है या नहीं

Kotlin

Java

Kotlin

Java

स्थगित इंस्टॉल का अनुरोध भेजें

Kotlin

Java

Kotlin

Java

मॉड्यूल इंस्टॉल करने का ज़रूरी अनुरोध भेजें

Kotlin

Java

Kotlin

Java

Kotlin

Java

Kotlin

Java

FakeModuleInstallClient की मदद से लोकल टेस्टिंग

ऐप्लिकेशन के लिए ज़रूरी शर्तें

जांच के लिए, ModuleInstallClient को FakeModuleInstallClient से बदलें

Kotlin

Java

Kotlin

Java

Kotlin

Java

मॉड्यूल की उपलब्धता को सिम्युलेट करें

Kotlin

Java

स्थगित इंस्टॉल के अनुरोध के नतीजे को सिम्युलेट करें

Kotlin

Java

तुरंत इंस्टॉल करने के अनुरोध के नतीजे को सिम्युलेट करें

Kotlin

Java

`FakeModuleInstallClient` की मदद से लोकल टेस्टिंग

जांच के लिए, `ModuleInstallClient` को `FakeModuleInstallClient` से बदलें