Özel modelleri dağıtma ve yönetme

Özel modelleri ve AutoML ile eğitilmiş modelleri Firebase konsolunu ya da Firebase Admin Python ve Node.js SDK'larını kullanarak dağıtıp yönetebilirsiniz. Yalnızca bir model dağıtmak ve zaman zaman güncellemek istiyorsanız genellikle Firebase konsolunu kullanmak en kolay seçenektir. Yönetici SDK'sı, oluşturma ardışık düzenleriyle entegrasyon yaparken, Colab veya Jupyter not defterleriyle ve diğer iş akışlarıyla çalışırken faydalı olabilir.

Firebase konsolunda model dağıtma ve yönetme

TensorFlow Lite modelleri

Firebase konsolunu kullanarak TensorFlow Lite modeli dağıtmak için:

1. Firebase konsolunda Firebase ML Özel model sayfasını açın.
2. Özel model ekle'yi (veya Başka bir model ekle'yi) tıklayın.
3. Firebase projenizde modelinizi tanımlamak için kullanılacak bir ad belirtin, ardından TensorFlow Lite model dosyasını (genellikle .tflite veya .lite ile biter) yükleyin.

Modelinizi dağıttıktan sonra Özel sayfasında bulabilirsiniz. Buradan modeli yeni bir dosyayla güncelleme, indirme ve projenizden silme gibi işlemleri yapabilirsiniz.

Firebase Admin SDK ile model dağıtma ve yönetme

Bu bölümde, Admin SDK ile yaygın model dağıtım ve yönetim görevlerini nasıl tamamlayabileceğiniz gösterilmektedir. Daha fazla yardım için Python veya Node.js SDK referansına bakın.

Kullanımdaki SDK örnekleri için Python hızlı başlangıç örneğine ve Node.js hızlı başlangıç örneğine bakın.

Başlamadan önce

1. Firebase projeniz yoksa Firebase konsolunda yeni bir proje oluşturun. Ardından projenizi açıp aşağıdakileri yapın:

   1. Ayarlar sayfasında bir hizmet hesabı oluşturun ve hizmet hesabı anahtarı dosyasını indirin. Projenize yönetici erişimi verdiği için bu dosyayı güvenli bir yerde saklayın.

   2. Depolama alanı sayfasında Cloud Storage seçeneğini etkinleştirin. Paketinizin adını not edin.

      Model dosyalarını Firebase projenize eklerken geçici olarak depolamak için bir Cloud Storage paketine ihtiyacınız vardır. Blaze planını kullanıyorsanız bu amaç için varsayılandan farklı bir paket oluşturabilir ve kullanabilirsiniz.

   3. Firebase ML sayfasında, Firebase ML'ü henüz etkinleştirmediyseniz Başlayın'ı tıklayın.

2. Google API'ler Konsolu'nda Firebase projenizi açın ve Firebase ML API'yi etkinleştirin.

3. Admin SDK'yı yükleyip başlatın.

   SDK'yı başlatırken hizmet hesabı kimlik bilgilerinizi ve modellerinizi depolamak için kullanmak istediğiniz Cloud Storage paketini belirtin:

   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();
   

   Not: Cloud Functions for Firebase dahil Google Cloud ortamlarında Yönetici SDK'sı, hizmet hesabı kimlik bilgilerinizle otomatik olarak başlatılabilir. Kurulum kılavuzuna bakın.

Modelleri dağıtma

TensorFlow Lite dosyaları

Bir model dosyasından TensorFlow Lite modeli dağıtmak için modeli projenize yükleyin ve ardından yayınlayın:

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 ve Keras modelleri

Python SDK'sı ile bir modeli TensorFlow kayıtlı model biçiminden TensorFlow Lite'e dönüştürebilir ve tek adımda Cloud Storage paketinize yükleyebilirsiniz. Ardından, TensorFlow Lite dosyasını dağıttığınız şekilde dağıtın.

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)

Keras modeliniz varsa bunu TensorFlow Lite'a dönüştürüp tek adımda yükleyebilirsiniz. HDF5 dosyasına kaydedilmiş bir Keras modelini kullanabilirsiniz:

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.)
# ...

Dilerseniz Keras modelini doğrudan eğitim komut dosyanızdan dönüştürüp yükleyebilirsiniz:

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 modelleri

AutoML Cloud API veya Google Cloud konsol kullanıcı arayüzü ile bir Edge modeli eğittiyseniz modeli Admin SDK'yı kullanarak Firebase'e dağıtabilirsiniz.

Firebase ML'nin AutoML Vision Edge özellikleri kullanımdan kaldırıldı. ML modellerini otomatik olarak eğitmek için Vertex AI'ı kullanabilirsiniz. Bu modelleri cihaz üzerinde kullanmak için TensorFlow Lite modelleri olarak dışa aktarabilir veya bulut tabanlı çıkarım için dağıtabilirsiniz.

Modelin kaynak tanımlayıcısını belirtmeniz gerekir. Bu tanımlayıcı, aşağıdaki örneğe benzeyen bir dizedir:

projects/PROJECT_NUMBER/locations/STORAGE_LOCATION/models/MODEL_ID

PROJECT_NUMBER	Modeli içeren Cloud Storage paketinin proje numarası. Bu, Firebase projeniz veya başka bir Google Cloud proje olabilir. Bu değeri Firebase konsolunun Ayarlar sayfasında veya Google Cloud konsol kontrol panelinde bulabilirsiniz.
STORAGE_LOCATION	Modeli içeren Cloud Storage paketinin kaynak konumu. Bu değer her zaman us-central1 olur.
MODEL_ID	AutoML Cloud API'den aldığınız model kimliği.

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);

Projenizin modellerini listeleme

İsteğe bağlı olarak sonuçları filtreleyerek projenizin modellerini listeleyebilirsiniz:

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);

Aşağıdaki alanlara göre filtre uygulayabilirsiniz:

Alan	Örnekler
display_name	display_name = example_model display_name != example_model experimental_ ön ekiyle başlayan tüm görünen adlar: display_name : experimental_* Yalnızca ön ek eşleştirmenin desteklendiğini unutmayın.
tags	tags: face_detector tags: face_detector AND tags: experimental
state.published	state.published = true state.published = false

Filtreleri AND, OR ve NOT operatörleriyle ve parantezlerle ((, )) birleştirin.

Modelleri güncelleme

Projenize bir model ekledikten sonra modelin görünen adını, etiketlerini ve tflite model dosyasını güncelleyebilirsiniz:

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);

Modelleri yayından kaldırma veya silme

Bir modelin yayınını kaldırmak veya modeli silmek için model kimliğini yayından kaldırma veya silme yöntemlerine iletin. Yayından kaldırdığınız modeller projenizde kalır ancak uygulamalarınızın indiremeyeceği bir konuma taşınır. Sildiğiniz modeller projenizden tamamen kaldırılır. (Standart iş akışında bir modelin yayından kaldırılması beklenmez ancak yanlışlıkla yayınladığınız ve henüz hiçbir yerde kullanılmayan yeni bir modelin yayınını hemen kaldırmak için veya kullanıcıların "bozuk" bir model indirmesinin, model bulunamadı hatalarından daha kötü olduğu durumlarda bu seçeneği kullanabilirsiniz.)

Model nesnesine dair referansınız yoksa projenizin modellerini filtreyle listeleyerek model kimliğini almanız gerekir. Örneğin, "face_detector" etiketine sahip tüm modelleri silmek için:

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);