DataOperations クラス

リファレンス

DataOperations。

このクラスを直接インスタンス化しないでください。代わりに、それをインスタンス化して属性としてアタッチする MLClient インスタンスを作成する必要があります。

継承: azure.ai.ml._scope_dependent_operations._ScopeDependentOperations

DataOperations

コンストラクター

DataOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client: AzureMachineLearningWorkspaces | AzureMachineLearningWorkspaces, datastore_operations: DatastoreOperations, **kwargs: Dict)

パラメーター

operation_scope: <xref:azure.ai.ml._scope_dependent_operations.OperationScope>

必須

MLClient オブジェクトの操作クラスのスコープ変数。

operation_config: <xref:azure.ai.ml._scope_dependent_operations.OperationConfig>

必須

MLClient オブジェクトの操作クラスの一般的な構成。

service_client: Union[ <xref:azure.ai.ml._restclient.v2023_04_01_preview._azure_machine_learning_workspaces.AzureMachineLearningWorkspaces>, <xref:azure.ai.ml._restclient.v2021_10_01_dataplanepreview._azure_machine_learning_workspaces. AzureMachineLearningWorkspaces>]

必須

エンドユーザーが Azure Machine Learning ワークスペースリソース (ServiceClient042023Preview または ServiceClient102021Dataplane) を操作できるようにするサービスクライアント。

datastore_operations: DatastoreOperations

必須

データストアに対して操作を実行するためのクライアントを表します。

メソッド

archive	データ資産をアーカイブします。
create_or_update	作成または更新されたデータ資産を返します。ストレージにまだ存在しない場合、資産はワークスペースの BLOB ストレージにアップロードされます。
get	指定したデータ資産を取得します。
import_data	Note これは試験的なメソッドであり、いつでも変更される可能性があります。詳細については、https://aka.ms/azuremlexperimental を参照してください。データ資産を作成しているデータインポートジョブを返します。
list	ワークスペースのデータ資産を一覧表示します。
list_materialization_status	Note これは試験的なメソッドであり、いつでも変更される可能性があります。詳細については、https://aka.ms/azuremlexperimental を参照してください。資産の具体化ジョブを一覧表示します。
restore	アーカイブされたデータ資産を復元します。
share	Note これは試験的なメソッドであり、いつでも変更される可能性があります。詳細については、https://aka.ms/azuremlexperimental を参照してください。ワークスペースからレジストリにデータ資産を共有します。

create_or_update

作成または更新されたデータ資産を返します。

ストレージにまだ存在しない場合、資産はワークスペースの BLOB ストレージにアップロードされます。

create_or_update(data: Data) -> Data

パラメーター

data: Data

必須

データ資産オブジェクト。

戻り値

データ資産オブジェクト。

の戻り値の型 :

Data

例外

AssetPathException

データ成果物パスが既に別の資産にリンクされている場合に発生します

ValidationException

データを正常に検証できない場合に発生します。詳細はエラーメッセージに表示されます。

EmptyDirectoryError

指定されたローカルパスが空のディレクトリを指している場合に発生します。

例

データ資産の作成の例。


   from azure.ai.ml.entities import Data

   data_asset_example = Data(name=data_asset_name, version="2.0", path="./sdk/ml/azure-ai-ml/samples/src")
   ml_client.data.create_or_update(data_asset_example)

get

指定したデータ資産を取得します。

get(name: str, version: str | None = None, label: str | None = None) -> Data

パラメーター

name: str

必須

データ資産の名前。

version: str

必須

データ資産のバージョン。

label: str

必須

データ資産のラベル。 (バージョンと相互に排他的)

戻り値

データ資産オブジェクト。

の戻り値の型 :

Data

例外

ValidationException

データを正常に識別して取得できない場合に発生します。詳細はエラーメッセージに表示されます。

例

データ資産の取得の例。


   ml_client.data.get(name="data-asset-name", version="2.0")

import_data

Note

これは試験的なメソッドであり、いつでも変更される可能性があります。詳細については、https://aka.ms/azuremlexperimental を参照してください。

データ資産を作成しているデータインポートジョブを返します。

import_data(data_import: DataImport, **kwargs) -> PipelineJob

パラメーター

data_import: DataImport

必須

DataImport オブジェクト。

戻り値

データインポートジョブオブジェクト。

の戻り値の型 :

PipelineJob

例

データ資産のインポートの例。


   from azure.ai.ml.entities._data_import.data_import import DataImport
   from azure.ai.ml.entities._inputs_outputs.external_data import Database

   database_example = Database(query="SELECT ID FROM DataTable", connection="azureml:my_azuresqldb_connection")
   data_import_example = DataImport(
       name="data-asset-name", path="azureml://datastores/workspaceblobstore/paths/", source=database_example
   )
   ml_client.data.import_data(data_import_example)

list

ワークスペースのデータ資産を一覧表示します。

list(name: str | None = None, *, list_view_type: ListViewType = ListViewType.ACTIVE_ONLY) -> ItemPaged[Data]

パラメーター

name: Optional[str]

必須

特定のデータ資産の名前 (省略可能)。

list_view_type

アーカイブされたデータ資産を含める/除外する (たとえば) 種類を表示します。既定値: ACTIVE_ONLY。

戻り値

Data オブジェクトのインスタンスのような反復子

の戻り値の型 :

ItemPaged[Data]

例

データ資産の一覧表示の例。


   ml_client.data.list(name="data-asset-name")

list_materialization_status

Note

これは試験的なメソッドであり、いつでも変更される可能性があります。詳細については、https://aka.ms/azuremlexperimental を参照してください。

資産の具体化ジョブを一覧表示します。

list_materialization_status(name: str, *, list_view_type: ListViewType = ListViewType.ACTIVE_ONLY, **kwargs) -> Iterable[PipelineJob]

パラメーター

name: str

必須

マテリアライズジョブによって作成される資産の名前。

list_view_type: Optional[<xref:ListViewType>]

アーカイブされたジョブを含める/除外する (たとえば) 種類を表示します。既定値: ACTIVE_ONLY。

戻り値

Job オブジェクトのインスタンスのような反復子。

の戻り値の型 :

ItemPaged[PipelineJob]

例

具体化ジョブの例を一覧表示します。


   ml_client.data.list_materialization_status("data-asset-name")

restore

アーカイブされたデータ資産を復元します。

restore(name: str, version: str | None = None, label: str | None = None, **kwargs) -> None

パラメーター

name: str

必須

データ資産の名前。

version: str

必須

データ資産のバージョン。

label: str

必須

データ資産のラベル。 (バージョンと相互に排他的)

戻り値

なし

例

データ資産の復元の例。


   ml_client.data.restore("data-asset-name")

Note

これは試験的なメソッドであり、いつでも変更される可能性があります。詳細については、https://aka.ms/azuremlexperimental を参照してください。

ワークスペースからレジストリにデータ資産を共有します。

share(name, version, *, share_with_name, share_with_version, registry_name, **kwargs) -> Data

パラメーター

name: str

必須

データ資産の名前。

version: str

必須

データ資産のバージョン。

share_with_name: str

共有するデータ資産の名前。

share_with_version: str

共有するデータ資産のバージョン。

registry_name: str

宛先レジストリの名前。

戻り値

データ資産オブジェクト。

の戻り値の型 :

Data

例

データ資産の共有の例。


       ml_client.data.share(
           name="data-asset-name",
           version="2.0",
           registry_name="my-registry",
           share_with_name="transformed-nyc-taxi-data-shared-from-ws",
           share_with_version="2.0",
       )

次の方法で共有

DataOperations クラス

コンストラクター

パラメーター

メソッド

archive

パラメーター

戻り値

例

create_or_update

パラメーター

戻り値

の戻り値の型 :

例外

例

get

パラメーター

戻り値

の戻り値の型 :

例外

例

import_data

パラメーター

戻り値

の戻り値の型 :

例

list

パラメーター

戻り値

の戻り値の型 :

例

list_materialization_status

パラメーター

戻り値

の戻り値の型 :

例

restore

パラメーター

戻り値

例

share

パラメーター

戻り値

の戻り値の型 :

例

その他のリソース