メインコンテンツまでスキップ

カスタムタグ/メタデータの添付

キーと値のペアをトレースにアタッチして、整理、検索、フィルタリングを行います。

タグ は変更可能であり、トレースがログに記録された後に更新できます。ユーザーフィードバック、レビューステータス、データ品質評価など、変更される可能性のある動的な情報にはタグを使用します。

メタデータ は一度だけ書き込み可能で、ログ記録後も不変です。実行中に取得された固定情報 (モデルのバージョン、環境、システム構成など) のメタデータを使用します。

このガイドでは、メタデータとタグを設定および管理する方法について説明します。

API / メソッド

ユースケース

mlflow.update_current_trace API。

コードの実行中に アクティブ トレースにタグまたはメタデータを設定します。

MlflowClient.set_trace_tag API。

完成したトレースにタグを設定または更新します。

MLflow の UI

完成したトレースにタグを設定または更新します。

前提 条件​

  1. MLflow と必要なパッケージをインストールする

    Bash
    pip install --upgrade "mlflow[databricks]>=3.1.0" openai "databricks-connect>=16.1"

  2. MLflow エクスペリメントを作成するには、環境のセットアップに関するクイックスタートに従ってください。

アクティブ・トレースでのメタデータの設定​

自動トレースまたは fluent API を使用してトレースを作成し、実行中にトレースにメタデータを追加する場合は、 mlflow.update_current_trace 関数を使用できます。

たとえば、次のコード例では、my_func 関数用に作成されたトレースに "model_version": "v1.2.3" メタデータを追加します。

Python
import mlflow

@mlflow.trace
def my_func(x):
    mlflow.update_current_trace(metadata={"model_version": "v1.2.3", "environment": "production"})
    return x + 1

my_func(10)
注記

メタデータは一度設定すると不変です。既に存在するキーを使用してメタデータを更新しようとすると、操作は無視され、元の値は変更されません。

アクティブ・トレースへのタグの設定​

自動トレースまたは fluent APIを使用してトレースを作成し、実行中にトレースにタグを追加する場合は、 mlflow.update_current_trace 関数を使用できます。

たとえば、次のコード例では、my_func 関数用に作成されたトレースに "fruit": "apple" タグを追加します。

Python
@mlflow.trace
def my_func(x):
    mlflow.update_current_trace(tags={"fruit": "apple"})
    return x + 1

my_func(10)
注記

mlflow.update_current_trace 関数は、キーがまだ存在しない場合に、指定したタグを現在のトレースに追加します。キーがすでに存在する場合は、キーを新しい値で更新します。

完成したトレースへのタグの設定​

すでに完了してバックエンドストアに記録されているトレースにタグを設定するには、 mlflow.set_trace_tag メソッドを使用してトレースにタグを設定します。 トレースからタグを削除する mlflow.delete_trace_tag メソッド。

Python
import mlflow

# Create and execute a traced function
@mlflow.trace
def process_data(data):
    return data.upper()

# Execute the function to create a trace
result = process_data("hello world")

# Get the trace_id from the most recent trace
trace_id = mlflow.get_last_active_trace_id()

# Set a tag on the trace
mlflow.set_trace_tag(trace_id=trace_id, key="review_status", value="approved")

# Set another tag
mlflow.set_trace_tag(trace_id=trace_id, key="data_quality", value="high")

# Delete a tag from the trace
mlflow.delete_trace_tag(trace_id=trace_id, key="data_quality")

MLflow UI を使用したタグの設定​

または、MLflow UI からトレースのタグを更新または削除することもできます。これを行うには、[トレース]タブに移動し、更新するタグの横にある鉛筆アイコンをクリックします。

トレースタグの更新

次のステップ​

これらの推奨アクションとチュートリアルで旅を続けてください。

リファレンスガイド​

このガイドで説明されている概念と機能の詳細なドキュメントをご覧ください。

に最終更新