ModelDataCollector クラス

継承

builtins.object

ModelDataCollector

コンストラクター

ModelDataCollector(model_name, designation='default', feature_names=None, workspace='default/default/default', webservice_name='default', model_version='default', collection_name='default')

パラメーター

注釈

現時点では、ModelDataCollector は Azure Machine Learning の AKS のデプロイでのみ機能します。 デプロイ内でモデル データを収集するには、次の手順を実行する必要があります。

• ModelDataCollector オブジェクトと collect ステートメントを追加するために、イメージ entry_script を更新します。 スクリプト内に複数の ModelDataCollector オブジェクトを定義できます。たとえば、同じモデルの入力用に 1 つ、予測用に 1 つなどです。 entry_script を定義および使用する方法の詳細については、次のクラスを参照してください: InferenceConfig

• AKS モデル デプロイ手順で enable_data_collection フラグを設定します。 モデルがデプロイされたら、このフラグを使用して、entry_script を変更せずにモデル データの収集をオンまたはオフにすることができます。 モデル デプロイを構成する方法の詳細については、次のクラスを参照してください: AksWebservice

次のコード スニペットは、entry_script が ModelDataCollection でどのように表示されるかを示しています。

   from azureml.monitoring import ModelDataCollector

   def init():
       global inputs_dc

       # Define your models and other scoring related objects
       # ...

       # Define input data collector to model "bestmodel". You need to define one object per model and
       # designation. For the sake of simplicity, we are only defining one object here.
       inputs_dc = ModelDataCollector(model_name="bestmodel", designation="inputs", feature_names=["f1", "f2"])

   def run(raw_data):
       global inputs_dc

       # Convert raw_data to proper format and run prediction
       # ...

       # Use inputs_dc to collect data. For any data that you want to collect, you need to call collect method
       # on respective ModelDataCollector objects. For the sake of simplicity, we are only working on a single
       # object.
       inputs_dc.collect(input_data)

上の例では、ModelDataCollector に関するいくつかの項目を示しています。 最初に、オブジェクトはモデルごと、および指定ごとに定義されます。この場合は、"bestmodel" と "inputs" です。 次に、ModelDataCollector は表形式データを入力として想定し、データを csv ファイルとして保持します。 オプションの特徴名を指定して、これらの csv ファイルのヘッダーを設定できます。

次のコード スニペットは、モデル デプロイ中に ModelDataCollector を有効にする方法を示しています。

   webservice_config = AksWebservice.deploy_configuration(collect_model_data=True)
   Model.deploy(ws, "myservice", [model], inference_config, webservice_config, aks_cluster)

Azure Machine Learning の AKS WebService がデプロイされ、サービスでスコアリングが実行されると、収集されたデータがワークスペースのストレージ アカウントに表示されます。 ModelDataCollector は、アクセスおよび使用しやすくためにデータをパーティション分割します。 すべてのデータは、"modeldata" ストレージ コンテナー下に収集されます。 パーティションの形式は次のとおりです。

/modeldata/{workspace_name}/{webservice_name}/{model_name}/{model_version}/{designation}/{year}/{month}/{day}/{collection_name}.csv

ファイル名の collection_name は、"signals" と "general" の指定でのみ考慮されます。 "inputs"、"predictions"、"labels" の場合、ファイル名は {designation}.csv と設定されます。

メソッド

add_correlations

add_correlations(input_data, correlations)

   # Define inputs_dc and predictions_dc for the same model and "inputs" and "predictions" designations
   # respectively
   # ...

   correlations = inputs_dc.collect(input_data)
   predictions_data = predictions_dc.add_correlations(predictions_data, correlations)
   predictions_dc.collect(predictions_data)

collect

collect(input_data, user_correlation_id='')

属性

AML_DC_BOUNDARY_HEADER

AML_DC_BOUNDARY_HEADER = '$aml_dc_boundary'

AML_DC_CORRELATION_HEADER

AML_DC_CORRELATION_HEADER = '$aml_dc_correlation_id'

AML_DC_SCORING_TIMESTAMP_HEADER

AML_DC_SCORING_TIMESTAMP_HEADER = '$aml_dc_scoring_timestamp'

AML_MODEL_NAME_HEADER

AML_MODEL_NAME_HEADER = '$aml_model_name'

AML_MODEL_VERSION_HEADER

AML_MODEL_VERSION_HEADER = '$aml_model_version'

AML_REQUEST_ID_HEADER

AML_REQUEST_ID_HEADER = '$aml_request_id'

AML_SERVICE_NAME_HEADER

AML_SERVICE_NAME_HEADER = '$aml_service_name'

AML_WORKSPACE_HEADER

AML_WORKSPACE_HEADER = '$aml_workspace'

dllpath

dllpath = 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azureml\\monitoring\\tools\\modeldatacollector\\lib\\native\\Windows'