Benutzerdefinierte Modelle bereitstellen und verwalten

Sie können benutzerdefinierte Modelle und von AutoML trainierte Modelle entweder über die Firebase-Konsole oder über die Firebase Admin Python- und Node.js-SDKs bereitstellen und verwalten. Wenn Sie nur ein Modell bereitstellen und es gelegentlich aktualisieren möchten, ist es in der Regel am einfachsten, die Firebase-Konsole zu verwenden. Das Admin SDK kann bei der Integration in Build-Pipelines, bei der Arbeit mit Colab- oder Jupyter-Notebooks und bei anderen Workflows hilfreich sein.

Modelle in der Firebase-Konsole bereitstellen und verwalten

TensorFlow Lite-Modelle

So stellen Sie ein TensorFlow Lite-Modell mit der Firebase-Konsole bereit:

1. Öffnen Sie in der Firebase-Konsole die Seite Firebase ML Benutzerdefiniertes Modell.
2. Klicken Sie auf Benutzerdefiniertes Modell hinzufügen (oder Weiteres Modell hinzufügen).
3. Geben Sie einen Namen an, der zur Identifizierung Ihres Modells in Ihrem Firebase-Projekt verwendet wird, und laden Sie dann die TensorFlow Lite-Modelldatei hoch (normalerweise mit der Endung .tflite oder .lite).

Nachdem Sie Ihr Modell bereitgestellt haben, finden Sie es auf der Seite „Benutzerdefiniert“. Dort können Sie Aufgaben wie das Aktualisieren des Modells mit einer neuen Datei, das Herunterladen des Modells und das Löschen des Modells aus Ihrem Projekt ausführen.

Modelle mit dem Firebase Admin SDK bereitstellen und verwalten

In diesem Abschnitt erfahren Sie, wie Sie mit dem Admin SDK häufige Aufgaben für die Bereitstellung und Verwaltung von Modellen ausführen können. Weitere Informationen finden Sie in der SDK-Referenz für Python oder Node.js.

Beispiele für die Verwendung des SDK finden Sie im Python-Kurzanleitungsbeispiel und im Node.js-Kurzanleitungsbeispiel.

Hinweis

1. Wenn Sie noch kein Firebase-Projekt haben, erstellen Sie ein neues Projekt in der Firebase-Konsole. Öffnen Sie dann Ihr Projekt und gehen Sie so vor:

   1. Erstellen Sie auf der Seite Einstellungen ein Dienstkonto und laden Sie die Dienstkonto-Schlüsseldatei herunter. Bewahren Sie diese Datei sicher auf, da sie Administratorzugriff auf Ihr Projekt gewährt.

   2. Aktivieren Sie auf der Seite „Speicher“ die Option Cloud Storage. Notieren Sie sich den Namen Ihres Buckets.

      Sie benötigen einen Cloud Storage-Bucket, um Modelldateien vorübergehend zu speichern, während Sie sie Ihrem Firebase-Projekt hinzufügen. Wenn Sie den Blaze-Tarif nutzen, können Sie für diesen Zweck einen anderen Bucket als den Standardbucket erstellen und verwenden.

   3. Klicken Sie auf der Seite Firebase ML auf Jetzt starten, falls Sie Firebase ML noch nicht aktiviert haben.

2. Öffnen Sie in der Google APIs Console Ihr Firebase-Projekt und aktivieren Sie die Firebase ML API.

3. Installieren und initialisieren Sie das Admin SDK.

   Geben Sie beim Initialisieren des SDK die Anmeldedaten Ihres Dienstkontos und den Cloud Storage-Bucket an, in dem Sie Ihre Modelle speichern möchten:

   Python

   import firebase_admin
   from firebase_admin import ml
   from firebase_admin import credentials
   
   firebase_admin.initialize_app(
     credentials.Certificate('/path/to/your/service_account_key.json'),
     options={
         'storageBucket': 'your-storage-bucket',
     })
   

   Node.js

   const admin = require('firebase-admin');
   const serviceAccount = require('/path/to/your/service_account_key.json');
   admin.initializeApp({
     credential: admin.credential.cert(serviceAccount),
     storageBucket: 'your-storage-bucket',
   });
   const ml = admin.machineLearning();
   

   Hinweis :In Google Cloud-Umgebungen, einschließlich Cloud Functions for Firebase, kann das Admin SDK automatisch mit den Anmeldedaten Ihres Dienstkontos initialisiert werden. Einrichtungsanleitung

Modelle bereitstellen

TensorFlow Lite-Dateien

Wenn Sie ein TensorFlow Lite-Modell aus einer Modelldatei bereitstellen möchten, laden Sie es in Ihr Projekt hoch und veröffentlichen Sie es dann:

Python

# First, import and initialize the SDK as shown above.

# Load a tflite file and upload it to Cloud Storage
source = ml.TFLiteGCSModelSource.from_tflite_model_file('example.tflite')

# Create the model object
tflite_format = ml.TFLiteFormat(model_source=source)
model = ml.Model(
    display_name="example_model",  # This is the name you use from your app to load the model.
    tags=["examples"],             # Optional tags for easier management.
    model_format=tflite_format)

# Add the model to your Firebase project and publish it
new_model = ml.create_model(model)
ml.publish_model(new_model.model_id)

Node.js

// First, import and initialize the SDK as shown above.

(async () => {
  // Upload the tflite file to Cloud Storage
  const storageBucket = admin.storage().bucket('your-storage-bucket');
  const files = await storageBucket.upload('./example.tflite');

  // Create the model object and add the model to your Firebase project.
  const bucket = files[0].metadata.bucket;
  const name = files[0].metadata.name;
  const gcsUri = `gs:/⁠/${bucket}/${name}`;
  const model = await ml.createModel({
    displayName: 'example_model',  // This is the name you use from your app to load the model.
    tags: ['examples'],  // Optional tags for easier management.
    tfliteModel: { gcsTfliteUri: gcsUri },
  });

  // Publish the model.
  await ml.publishModel(model.modelId);

  process.exit();
})().catch(console.error);

TensorFlow- und Keras-Modelle

Mit dem Python SDK können Sie ein Modell aus dem TensorFlow-Format „SavedModel“ in TensorFlow Lite konvertieren und in einem einzigen Schritt in Ihren Cloud Storage-Bucket hochladen. Stellen Sie es dann auf dieselbe Weise bereit wie eine TensorFlow Lite-Datei.

Python

# First, import and initialize the SDK as shown above.

# Convert the model to TensorFlow Lite and upload it to Cloud Storage
source = ml.TFLiteGCSModelSource.from_saved_model('./model_directory')

# Create the model object
tflite_format = ml.TFLiteFormat(model_source=source)
model = ml.Model(
    display_name="example_model",  # This is the name you use from your app to load the model.
    tags=["examples"],             # Optional tags for easier management.
    model_format=tflite_format)

# Add the model to your Firebase project and publish it
new_model = ml.create_model(model)
ml.publish_model(new_model.model_id)

Wenn Sie ein Keras-Modell haben, können Sie es auch in einem einzigen Schritt in TensorFlow Lite konvertieren und hochladen. Sie können ein Keras-Modell verwenden, das in einer HDF5-Datei gespeichert ist:

Python

import tensorflow as tf

# Load a Keras model, convert it to TensorFlow Lite, and upload it to Cloud Storage
model = tf.keras.models.load_model('your_model.h5')
source = ml.TFLiteGCSModelSource.from_keras_model(model)

# Create the model object, add the model to your project, and publish it. (See
# above.)
# ...

Alternativ können Sie ein Keras-Modell direkt aus Ihrem Trainingsskript konvertieren und hochladen:

Python

import tensorflow as tf

# Create a simple Keras model.
x = [-1, 0, 1, 2, 3, 4]
y = [-3, -1, 1, 3, 5, 7]

model = tf.keras.models.Sequential(
    [tf.keras.layers.Dense(units=1, input_shape=[1])])
model.compile(optimizer='sgd', loss='mean_squared_error')
model.fit(x, y, epochs=3)

# Convert the model to TensorFlow Lite and upload it to Cloud Storage
source = ml.TFLiteGCSModelSource.from_keras_model(model)

# Create the model object, add the model to your project, and publish it. (See
# above.)
# ...

AutoML TensorFlow Lite-Modelle

Wenn Sie ein Edge-Modell mit der AutoML Cloud API oder mit der Google Cloud-Konsolen-UI trainiert haben, können Sie das Modell mit dem Admin SDK in Firebase bereitstellen.

Die AutoML Vision Edge-Funktionen von Firebase ML sind eingestellt. Mit Vertex AI können Sie ML-Modelle automatisch trainieren. Diese können Sie entweder als TensorFlow Lite-Modelle für die Verwendung auf dem Gerät exportieren oder für die cloudbasierte Inferenz bereitstellen.

Sie müssen den Ressourcen-Identifier des Modells angeben. Das ist ein String, der so aussieht:

projects/PROJECT_NUMBER/locations/STORAGE_LOCATION/models/MODEL_ID

PROJECT_NUMBER	Die Projektnummer des Cloud Storage-Buckets, der das Modell enthält. Das kann Ihr Firebase-Projekt oder ein anderes Google Cloud-Projekt sein. Sie finden diesen Wert auf der Seite „Einstellungen“ der Firebase-Konsole oder des Google Cloud-Konsolen-Dashboards.
STORAGE_LOCATION	Der Ressourcenstandort des Cloud Storage-Buckets, der das Modell enthält. Dieser Wert ist immer us-central1.
MODEL_ID	Die ID des Modells, die Sie über die AutoML Cloud API erhalten haben.

Python

# First, import and initialize the SDK as shown above.

# Get a reference to the AutoML model
source = ml.TFLiteAutoMlSource('projects/{}/locations/{}/models/{}'.format(
    # See above for information on these values.
    project_number,
    storage_location,
    model_id
))

# Create the model object
tflite_format = ml.TFLiteFormat(model_source=source)
model = ml.Model(
    display_name="example_model",  # This is the name you will use from your app to load the model.
    tags=["examples"],             # Optional tags for easier management.
    model_format=tflite_format)

# Add the model to your Firebase project and publish it
new_model = ml.create_model(model)
new_model.wait_for_unlocked()
ml.publish_model(new_model.model_id)

Node.js

// First, import and initialize the SDK as shown above.

(async () => {
  // Get a reference to the AutoML model. See above for information on these
  // values.
  const automlModel = `projects/${projectNumber}/locations/${storageLocation}/models/${modelId}`;

  // Create the model object and add the model to your Firebase project.
  const model = await ml.createModel({
    displayName: 'example_model',  // This is the name you use from your app to load the model.
    tags: ['examples'],  // Optional tags for easier management.
    tfliteModel: { automlModel: automlModel },
  });

  // Wait for the model to be ready.
  await model.waitForUnlocked();

  // Publish the model.
  await ml.publishModel(model.modelId);

  process.exit();
})().catch(console.error);

Modelle Ihres Projekts auflisten

Sie können die Modelle Ihres Projekts auflisten und die Ergebnisse optional filtern:

Python

# First, import and initialize the SDK as shown above.

face_detectors = ml.list_models(list_filter="tags: face_detector").iterate_all()
print("Face detection models:")
for model in face_detectors:
  print('{} (ID: {})'.format(model.display_name, model.model_id))

Node.js

// First, import and initialize the SDK as shown above.

(async () => {
  let listOptions = {filter: 'tags: face_detector'}
  let models;
  let pageToken = null;
  do {
    if (pageToken) listOptions.pageToken = pageToken;
    ({models, pageToken} = await ml.listModels(listOptions));
    for (const model of models) {
      console.log(`${model.displayName} (ID: ${model.modelId})`);
    }
  } while (pageToken != null);

  process.exit();
})().catch(console.error);

Sie können nach den folgenden Feldern filtern:

Feld	Beispiele
display_name	display_name = example_model display_name != example_model Alle Anzeigenamen mit dem Präfix experimental_: display_name : experimental_* Es wird nur der Abgleich von Präfixen unterstützt.
tags	tags: face_detector tags: face_detector AND tags: experimental
state.published	state.published = true state.published = false

Kombinieren Sie Filter mit den Operatoren AND, OR und NOT sowie mit Klammern ((, )).

Modelle aktualisieren

Nachdem Sie ein Modell zu Ihrem Projekt hinzugefügt haben, können Sie seinen Anzeigenamen, seine Tags und die tflite-Modelldatei aktualisieren:

Python

# First, import and initialize the SDK as shown above.

model = ...   # Model object from create_model(), get_model(), or list_models()

# Update the model with a new tflite model. (You could also update with a
# `TFLiteAutoMlSource`)
source = ml.TFLiteGCSModelSource.from_tflite_model_file('example_v2.tflite')
model.model_format = ml.TFLiteFormat(model_source=source)

# Update the model's display name.
model.display_name = "example_model"

# Update the model's tags.
model.tags = ["examples", "new_models"]

# Add a new tag.
model.tags += "experimental"

# After you change the fields you want to update, save the model changes to
# Firebase and publish it.
updated_model = ml.update_model(model)
ml.publish_model(updated_model.model_id)

Node.js

// First, import and initialize the SDK as shown above.

(async () => {
  const model = ... // Model object from createModel(), getModel(), or listModels()

  // Upload a new tflite file to Cloud Storage.
  const files = await storageBucket.upload('./example_v2.tflite');
  const bucket = files[0].metadata.bucket;
  const name = files[0].metadata.name;

  // Update the model. Any fields you omit will be unchanged.
  await ml.updateModel(model.modelId, {
    displayName: 'example_model',  // Update the model's display name.
    tags: model.tags.concat(['new']),  // Add a tag.
    tfliteModel: {gcsTfliteUri: `gs:/⁠/${bucket}/${name}`},
  });

  process.exit();
})().catch(console.error);

Modelle aus der Veröffentlichung entfernen oder löschen

Wenn Sie die Veröffentlichung eines Modells rückgängig machen oder ein Modell löschen möchten, übergeben Sie die Modell-ID an die Methoden „unpublish“ oder „delete“. Wenn Sie die Veröffentlichung eines Modells aufheben, bleibt es in Ihrem Projekt, kann aber nicht mehr von Ihren Apps heruntergeladen werden. Wenn Sie ein Modell löschen, wird es vollständig aus Ihrem Projekt entfernt. (Das Aufheben der Veröffentlichung eines Modells ist in einem Standard-Workflow nicht vorgesehen. Sie können es jedoch verwenden, um die Veröffentlichung eines neuen Modells, das Sie versehentlich veröffentlicht haben und das noch nirgends verwendet wird, sofort aufzuheben. Das ist auch in Fällen sinnvoll, in denen es für Nutzer schlimmer ist, ein „schlechtes“ Modell herunterzuladen, als Fehlermeldungen zu erhalten, dass das Modell nicht gefunden wurde.)

Wenn Sie keine Referenz zum Model-Objekt mehr haben, müssen Sie die Modell-ID wahrscheinlich abrufen, indem Sie die Modelle Ihres Projekts mit einem Filter auflisten. Wenn Sie beispielsweise alle Modelle löschen möchten, die mit „face_detector“ getaggt sind, gehen Sie so vor:

Python

# First, import and initialize the SDK as shown above.

face_detectors = ml.list_models(list_filter="tags: 'face_detector'").iterate_all()
for model in face_detectors:
  ml.delete_model(model.model_id)

Node.js

// First, import and initialize the SDK as shown above.

(async () => {
  let listOptions = {filter: 'tags: face_detector'}
  let models;
  let pageToken = null;
  do {
    if (pageToken) listOptions.pageToken = pageToken;
    ({models, pageToken} = await ml.listModels(listOptions));
    for (const model of models) {
      await ml.deleteModel(model.modelId);
    }
  } while (pageToken != null);

  process.exit();
})().catch(console.error);