モデルバージョンの詳細を更新する - Amazon SageMaker

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

モデルバージョンの詳細を更新する

AWS SDK for Python (Boto3) または Amazon SageMaker Studio コンソールを使用して、特定のモデルバージョンの詳細を表示および更新できます。

重要

Amazon SageMaker はモデルカードをモデルレジストリに統合します。Model Registry に登録されたモデルパッケージには、モデルパッケージのコンポーネントとして簡略化されたモデルカードが含まれています。詳細については、「モデルパッケージモデルカードスキーマ (Studio)」を参照してください。

モデルバージョンの詳細の表示と更新 (Boto3)

Boto3 を使用してモデルバージョンの詳細を表示するには、次のステップを実行します。

  1. list_model_packages API オペレーションを呼び出して、モデルグループのモデルバージョンを表示します。

    sm_client.list_model_packages(ModelPackageGroupName="ModelGroup1")

    レスポンスはモデルパッケージの概要のリストです。このリストからモデルバージョンの Amazon リソースネーム (ARN) を取得できます。

    {'ModelPackageSummaryList': [{'ModelPackageGroupName': 'AbaloneMPG-16039329888329896', 'ModelPackageVersion': 1, 'ModelPackageArn': 'arn:aws:sagemaker:us-east-2:123456789012:model-package/ModelGroup1/1', 'ModelPackageDescription': 'TestMe', 'CreationTime': datetime.datetime(2020, 10, 29, 1, 27, 46, 46000, tzinfo=tzlocal()), 'ModelPackageStatus': 'Completed', 'ModelApprovalStatus': 'Approved'}], 'ResponseMetadata': {'RequestId': '12345678-abcd-1234-abcd-aabbccddeeff', 'HTTPStatusCode': 200, 'HTTPHeaders': {'x-amzn-requestid': '12345678-abcd-1234-abcd-aabbccddeeff', 'content-type': 'application/x-amz-json-1.1', 'content-length': '349', 'date': 'Mon, 23 Nov 2020 04:56:50 GMT'}, 'RetryAttempts': 0}}
  2. describe_model_package を呼び出してモデルバージョンの詳細を表示します。への呼び出しARNの出力で取得したモデルバージョンの を渡しますlist_model_packages

    sm_client.describe_model_package(ModelPackageName="arn:aws:sagemaker:us-east-2:123456789012:model-package/ModelGroup1/1")

    この呼び出しの出力は、モデルバージョンの詳細を含むJSONオブジェクトです。

    {'ModelPackageGroupName': 'ModelGroup1', 'ModelPackageVersion': 1, 'ModelPackageArn': 'arn:aws:sagemaker:us-east-2:123456789012:model-package/ModelGroup/1', 'ModelPackageDescription': 'Test Model', 'CreationTime': datetime.datetime(2020, 10, 29, 1, 27, 46, 46000, tzinfo=tzlocal()), 'InferenceSpecification': {'Containers': [{'Image': '257758044811.dkr.ecr.us-east-2.amazonaws.com/sagemaker-xgboost:1.0-1-cpu-py3', 'ImageDigest': 'sha256:99fa602cff19aee33297a5926f8497ca7bcd2a391b7d600300204eef803bca66', 'ModelDataUrl': 's3://sagemaker-us-east-2-123456789012/ModelGroup1/pipelines-0gdonccek7o9-AbaloneTrain-stmiylhtIR/output/model.tar.gz'}], 'SupportedTransformInstanceTypes': ['ml.m5.xlarge'], 'SupportedRealtimeInferenceInstanceTypes': ['ml.t2.medium', 'ml.m5.xlarge'], 'SupportedContentTypes': ['text/csv'], 'SupportedResponseMIMETypes': ['text/csv']}, 'ModelPackageStatus': 'Completed', 'ModelPackageStatusDetails': {'ValidationStatuses': [], 'ImageScanStatuses': []}, 'CertifyForMarketplace': False, 'ModelApprovalStatus': 'PendingManualApproval', 'LastModifiedTime': datetime.datetime(2020, 10, 29, 1, 28, 0, 438000, tzinfo=tzlocal()), 'ResponseMetadata': {'RequestId': '12345678-abcd-1234-abcd-aabbccddeeff', 'HTTPStatusCode': 200, 'HTTPHeaders': {'x-amzn-requestid': '212345678-abcd-1234-abcd-aabbccddeeff', 'content-type': 'application/x-amz-json-1.1', 'content-length': '1038', 'date': 'Mon, 23 Nov 2020 04:59:38 GMT'}, 'RetryAttempts': 0}}

モデルパッケージモデルカードスキーマ (Studio)

モデルバージョンに関連するすべての詳細は、モデルパッケージのモデルカードにカプセル化されます。モデルパッケージのモデルカードは Amazon SageMaker モデルカードの特別な用途であり、スキーマは簡素化されています。モデルパッケージモデルカードスキーマは、次の拡張可能なドロップダウンに表示されます。

{ "title": "SageMakerModelCardSchema", "description": "Schema of a model package’s model card.", "version": "0.1.0", "type": "object", "additionalProperties": false, "properties": { "model_overview": { "description": "Overview about the model.", "type": "object", "additionalProperties": false, "properties": { "model_creator": { "description": "Creator of model.", "type": "string", "maxLength": 1024 }, "model_artifact": { "description": "Location of the model artifact.", "type": "array", "maxContains": 15, "items": { "type": "string", "maxLength": 1024 } } } }, "intended_uses": { "description": "Intended usage of model.", "type": "object", "additionalProperties": false, "properties": { "purpose_of_model": { "description": "Reason the model was developed.", "type": "string", "maxLength": 2048 }, "intended_uses": { "description": "Intended use cases.", "type": "string", "maxLength": 2048 }, "factors_affecting_model_efficiency": { "type": "string", "maxLength": 2048 }, "risk_rating": { "description": "Risk rating for model card.", "$ref": "#/definitions/risk_rating" }, "explanations_for_risk_rating": { "type": "string", "maxLength": 2048 } } }, "business_details": { "description": "Business details of model.", "type": "object", "additionalProperties": false, "properties": { "business_problem": { "description": "Business problem solved by the model.", "type": "string", "maxLength": 2048 }, "business_stakeholders": { "description": "Business stakeholders.", "type": "string", "maxLength": 2048 }, "line_of_business": { "type": "string", "maxLength": 2048 } } }, "training_details": { "description": "Overview about the training.", "type": "object", "additionalProperties": false, "properties": { "objective_function": { "description": "The objective function for which the model is optimized.", "function": { "$ref": "#/definitions/objective_function" }, "notes": { "type": "string", "maxLength": 1024 } }, "training_observations": { "type": "string", "maxLength": 1024 }, "training_job_details": { "type": "object", "additionalProperties": false, "properties": { "training_arn": { "description": "SageMaker Training job ARN.", "type": "string", "maxLength": 1024 }, "training_datasets": { "description": "Location of the model datasets.", "type": "array", "maxContains": 15, "items": { "type": "string", "maxLength": 1024 } }, "training_environment": { "type": "object", "additionalProperties": false, "properties": { "container_image": { "description": "SageMaker training image URI.", "type": "array", "maxContains": 15, "items": { "type": "string", "maxLength": 1024 } } } }, "training_metrics": { "type": "array", "items": { "maxItems": 50, "$ref": "#/definitions/training_metric" } }, "user_provided_training_metrics": { "type": "array", "items": { "maxItems": 50, "$ref": "#/definitions/training_metric" } }, "hyper_parameters": { "type": "array", "items": { "maxItems": 100, "$ref": "#/definitions/training_hyper_parameter" } }, "user_provided_hyper_parameters": { "type": "array", "items": { "maxItems": 100, "$ref": "#/definitions/training_hyper_parameter" } } } } } }, "evaluation_details": { "type": "array", "default": [], "items": { "type": "object", "required": [ "name" ], "additionalProperties": false, "properties": { "name": { "type": "string", "pattern": ".{1,63}" }, "evaluation_observation": { "type": "string", "maxLength": 2096 }, "evaluation_job_arn": { "type": "string", "maxLength": 256 }, "datasets": { "type": "array", "items": { "type": "string", "maxLength": 1024 }, "maxItems": 10 }, "metadata": { "description": "Additional attributes associated with the evaluation results.", "type": "object", "additionalProperties": { "type": "string", "maxLength": 1024 } }, "metric_groups": { "type": "array", "default": [], "items": { "type": "object", "required": [ "name", "metric_data" ], "properties": { "name": { "type": "string", "pattern": ".{1,63}" }, "metric_data": { "type": "array", "items": { "anyOf": [ { "$ref": "#/definitions/simple_metric" }, { "$ref": "#/definitions/linear_graph_metric" }, { "$ref": "#/definitions/bar_chart_metric" }, { "$ref": "#/definitions/matrix_metric" } ] } } } } } } } }, "additional_information": { "additionalProperties": false, "type": "object", "properties": { "ethical_considerations": { "description": "Ethical considerations for model users.", "type": "string", "maxLength": 2048 }, "caveats_and_recommendations": { "description": "Caveats and recommendations for model users.", "type": "string", "maxLength": 2048 }, "custom_details": { "type": "object", "additionalProperties": { "$ref": "#/definitions/custom_property" } } } } }, "definitions": { "source_algorithms": { "type": "array", "minContains": 1, "maxContains": 1, "items": { "type": "object", "additionalProperties": false, "required": [ "algorithm_name" ], "properties": { "algorithm_name": { "description": "The name of the algorithm used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.", "type": "string", "maxLength": 170 }, "model_data_url": { "description": "Amazon S3 path where the model artifacts, which result from model training, are stored.", "type": "string", "maxLength": 1024 } } } }, "inference_specification": { "type": "object", "additionalProperties": false, "required": [ "containers" ], "properties": { "containers": { "description": "Contains inference related information used to create model package.", "type": "array", "minContains": 1, "maxContains": 15, "items": { "type": "object", "additionalProperties": false, "required": [ "image" ], "properties": { "model_data_url": { "description": "Amazon S3 path where the model artifacts, which result from model training, are stored.", "type": "string", "maxLength": 1024 }, "image": { "description": "Inference environment path. The Amazon Elastic Container Registry (Amazon ECR) path where inference code is stored.", "type": "string", "maxLength": 255 }, "nearest_model_name": { "description": "The name of a pre-trained machine learning benchmarked by an Amazon SageMaker Inference Recommender model that matches your model.", "type": "string" } } } } } }, "risk_rating": { "description": "Risk rating of model.", "type": "string", "enum": [ "High", "Medium", "Low", "Unknown" ] }, "custom_property": { "description": "Additional property.", "type": "string", "maxLength": 1024 }, "objective_function": { "description": "Objective function for which the training job is optimized.", "additionalProperties": false, "properties": { "function": { "type": "string", "enum": [ "Maximize", "Minimize" ] }, "facet": { "type": "string", "maxLength": 63 }, "condition": { "type": "string", "maxLength": 63 } } }, "training_metric": { "description": "Training metric data.", "type": "object", "required": [ "name", "value" ], "additionalProperties": false, "properties": { "name": { "type": "string", "pattern": ".{1,255}" }, "notes": { "type": "string", "maxLength": 1024 }, "value": { "type": "number" } } }, "training_hyper_parameter": { "description": "Training hyperparameter.", "type": "object", "required": [ "name", "value" ], "additionalProperties": false, "properties": { "name": { "type": "string", "pattern": ".{1,255}" }, "value": { "type": "string", "pattern": ".{1,255}" } } }, "linear_graph_metric": { "type": "object", "required": [ "name", "type", "value" ], "additionalProperties": false, "properties": { "name": { "type": "string", "pattern": ".{1,255}" }, "notes": { "type": "string", "maxLength": 1024 }, "type": { "type": "string", "enum": [ "linear_graph" ] }, "value": { "anyOf": [ { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2 }, "minItems": 1 } ] }, "x_axis_name": { "$ref": "#/definitions/axis_name_string" }, "y_axis_name": { "$ref": "#/definitions/axis_name_string" } } }, "bar_chart_metric": { "type": "object", "required": [ "name", "type", "value" ], "additionalProperties": false, "properties": { "name": { "type": "string", "pattern": ".{1,255}" }, "notes": { "type": "string", "maxLength": 1024 }, "type": { "type": "string", "enum": [ "bar_chart" ] }, "value": { "anyOf": [ { "type": "array", "items": { "type": "number" }, "minItems": 1 } ] }, "x_axis_name": { "$ref": "#/definitions/axis_name_array" }, "y_axis_name": { "$ref": "#/definitions/axis_name_string" } } }, "matrix_metric": { "type": "object", "required": [ "name", "type", "value" ], "additionalProperties": false, "properties": { "name": { "type": "string", "pattern": ".{1,255}" }, "notes": { "type": "string", "maxLength": 1024 }, "type": { "type": "string", "enum": [ "matrix" ] }, "value": { "anyOf": [ { "type": "array", "items": { "type": "array", "items": { "type": "number" }, "minItems": 1, "maxItems": 20 }, "minItems": 1, "maxItems": 20 } ] }, "x_axis_name": { "$ref": "#/definitions/axis_name_array" }, "y_axis_name": { "$ref": "#/definitions/axis_name_array" } } }, "simple_metric": { "description": "Metric data.", "type": "object", "required": [ "name", "type", "value" ], "additionalProperties": false, "properties": { "name": { "type": "string", "pattern": ".{1,255}" }, "notes": { "type": "string", "maxLength": 1024 }, "type": { "type": "string", "enum": [ "number", "string", "boolean" ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "string", "maxLength": 63 }, { "type": "boolean" } ] }, "x_axis_name": { "$ref": "#/definitions/axis_name_string" }, "y_axis_name": { "$ref": "#/definitions/axis_name_string" } } }, "axis_name_array": { "type": "array", "items": { "type": "string", "maxLength": 63 } }, "axis_name_string": { "type": "string", "maxLength": 63 } } }

モデルバージョンの詳細の表示と更新 (Studio または Studio Classic)

モデルバージョンの詳細を表示および更新するには、Studio と Studio Classic のどちらを使用するかに基づいて、次の手順を実行します。Studio Classic では、モデルバージョンの承認ステータスを更新できます。詳細については、「モデルの承認ステータスを更新する」を参照してください。一方、Studio では、 はモデルパッケージのモデルカード SageMaker を作成し、モデルバージョン UI はモデルカードの詳細を更新するオプションを提供します。

Studio
  1. Amazon SageMaker Studio を起動 の手順に従って SageMaker Studio コンソールを開きます。

  2. 左側のナビゲーションペインで、メニューからモデルを選択します。

  3. まだ選択されていない場合は、登録済みモデルタブを選択します。

  4. 登録済みモデルタブラベルのすぐ下にある、まだ選択されていない場合はモデルグループ を選択します。

  5. 表示するモデルバージョンを含むモデルグループの名前を選択します。

  6. モデルバージョンのリストで、表示するモデルバージョンを選択します。

  7. 次のいずれかのテーブルを選択します。

    • トレーニング : パフォーマンスメトリクス、アーティファクト、IAMロールと暗号化、コンテナなど、トレーニングジョブに関連する詳細を表示または編集します。詳細については、「トレーニングジョブを追加する (Studio)」を参照してください。

    • 評価: パフォーマンスメトリクス、評価データセット、セキュリティなど、トレーニングジョブに関連する詳細を表示または編集します。詳細については、「評価ジョブを追加する (Studio)」を参照してください。

    • 監査: モデルのビジネス目的、使用状況、リスク、アルゴリズムやパフォーマンスの制限などの技術的詳細に関連する高レベルの詳細を表示または編集します。詳細については、「監査 (ガバナンス) 情報の更新 (Studio)」を参照してください。

    • デプロイ: エンドポイントを構成する推論イメージコンテナとインスタンスの場所を表示または編集します。詳細については、「デプロイ情報の更新 (Studio)」を参照してください。

Studio Classic
  1. Amazon SageMaker Studio Classic にサインインします。詳細については、「Amazon SageMaker Studio Classic の起動」を参照してください。

  2. 左側のナビゲーションペインで [ホーム] アイコン( Black square icon representing a placeholder or empty image. ) を選択します。

  3. [モデル] を選択し、[モデルレジストリ] を選択します。

  4. モデルグループのリストから、表示する Model Group の名前を選択します。

  5. 新しいタブが開き、Model Group 内にあるモデルバージョンのリストが表示されます。

  6. モデルバージョンのリストで、詳細を表示するモデルバージョンの名前を選択します。

  7. 表示されるモデルバージョンのタブで次のいずれかを選択して、モデルバージョンの詳細を表示します。

    • Activity (アクティビティ): 承認ステータスの更新など、モデルバージョンのイベントを表示します。

    • モデル品質: Model Monitor のモデル品質チェックに関連するメトリクスをレポートし、モデル予測を Ground Truth と比較します。Model Monitor のモデル品質チェックの詳細については、「モデル品質」を参照してください。

    • 説明可能性: Model Monitor の機能属性チェックに関連するメトリクスをレポートし、トレーニングデータとライブデータに含まれる特徴量の相対的なランキングを比較します。Model Monitor の説明可能性チェックの詳細については、「本番環境のモデルの特徴量属性ドリフト」を参照してください。

    • バイアス: Model Monitor のバイアスドリフトチェックに関連するメトリクスをレポートし、ライブデータとトレーニングデータの分布を比較します。Model Monitor のバイアスドリフトチェックの詳細については、「本番環境のモデルのバイアスドリフト」を参照してください。

    • 推論レコメンダー: モデルとサンプルペイロードに基づいて、最適なパフォーマンスを実現するための初期インスタンスの推奨事項を提供します。

    • ロードテスト: レイテンシーやスループットの制約など、特定の本番要件指定した場合に、選択したインスタンスタイプ全体でロードテストを実行します。

    • 推論仕様 : リアルタイム推論ジョブと変換ジョブのインスタンスタイプ、および Amazon ECRコンテナに関する情報を表示します。

    • 情報: モデルバージョンが関連付けられているプロジェクト、モデルを生成したパイプライン、Model Group、Amazon S3 内のモデルの場所といった情報を表示します。