core パッケージ

構成可能な機械学習ワークフローである Azure Machine Learning パイプラインのコア機能が含まれています。

Azure Machine Learning パイプラインを使用すると、機械学習シナリオのテンプレートとして使用できる、再利用可能な機械学習ワークフローを作成できます。 このパッケージには、Azure ML パイプラインを操作するためのコア機能が含まれており、通常は steps パッケージ内のクラスと共に使用します。

機械学習パイプラインは、PipelineStep オブジェクトのコレクションで表されます。これらは、順序付けして並列化するか、ステップ間に明示的な依存関係を設定して作成することができます。 パイプライン ステップは、実行するワークフローを表す Pipeline オブジェクトを定義するために使用します。 Azure ML SDK がインストールされている Jupyter Notebook またはその他の IDE で、パイプラインを作成して操作できます。

Azure ML パイプラインを使用すると、インフラストラクチャではなく機械学習に専念できます。 パイプラインの構築を開始するには、https://aka.ms/pl-first-pipeline を参照してください。

Machine Learning パイプラインの利点と、Azure から提供される他のパイプラインとの関連性の詳細については、Azure Machine Learning service の ML パイプラインの概要に関する記事をご覧ください。

モジュール

builder

Azure Machine Learning パイプラインを構築するためのクラスを定義します。

パイプライン グラフは、パイプライン ステップ (PipelineStep)、各ステップで生成または使用されるオプションのパイプライン データ (PipelineData)、およびオプションのステップ実行シーケンス (StepSequence) で構成されます。

graph

Azure Machine Learning パイプライン グラフを構築するためのクラスを定義します。

PipelineStep (と派生クラス)、PipelineDataPipelineData オブジェクトを使用するとき、Azure ML パイプライン グラフが Pipeline オブジェクトに対して作成されます。 一般的なユース ケースでは、このモジュールのクラスを直接使用する必要はありません。

パイプライン実行グラフは、データソースやステップなど、基本単位を表すモジュール ノードで構成されます。 ノードには、入力ポート、出力ポート、関連パラメーターを与えることができます。 エッジによって、グラフの 2 つのノード ポート間の関係が定義されます。

module

Azure Machine Learning パイプラインの再利用可能計算単位を作成し、管理するためのクラスが含まれます。

モジュールを利用すると、Pipeline で計算単位を作成できます。これには入力と出力があり、また、パラメーターと運用する環境構成に依存します。 1 つのパイプラインで使用される PipelineStep (と派生クラス) とは異なり、モジュールはバージョンを付け、さまざまな Azure Machine Learning パイプラインで使用できます。

モジュールは複数のパイプラインで再利用できるように設計されており、特定の計算ロジックをさまざまなユース ケースに合わせて調整できるように進化させることができます。 パイプラインのステップは、高速のイテレーションで使用し、アルゴリズムを改善できます。目標が達成されたら、アルゴリズムは通常、再利用を有効にする目的でモジュールとして発行されます。

module_step_base

Module のバージョンを使用してパイプラインにステップを追加する機能が含まれています。

pipeline

再利用可能な Azure Machine Learning ワークフローを作成するためのクラスを定義します。

pipeline_draft

変更可能なパイプラインを管理するためのクラスを定義します。

pipeline_endpoint

バージョン管理やエンドポイントなど、パイプラインを管理するためのクラスを定義します。

pipeline_output_dataset

中間出力を Azure Machine Learning データセットに昇格する機能が含まれています。

パイプライン内の中間データ (出力) は、既定では Azure Machine Learning データセットになりません。 中間データを Azure Machine Learning データセットに昇格するには、PipelineData クラスの as_dataset メソッドを呼び出して PipelineOutputFileDataset オブジェクトを返します。 次に、PipelineOutputFileDataset オブジェクトから PipelineOutputTabularDataset オブジェクトを作成できます。

run

状態を確認し、実行の詳細を取得するためのクラスを含む、送信されたパイプラインのクラスを定義します。

schedule

Azure Machine Learning パイプラインの送信をスケジュールするためのクラスを定義します。

クラス

InputPortBinding

ソースからパイプライン ステップの入力へのバインドを定義します。

InputPortBinding は、ステップへの入力として使用できます。 ソースには、PipelineDataPortDataReferenceDataReferencePipelineDataset、または OutputPortBinding を指定できます。

InputPortBinding は、ステップ入力の名前をバインド オブジェクトの名前と異なるものにする必要がある場合 (入力および出力の名前の重複を避けるため、またはステップ スクリプトが特定の名前を持つ入力を必要とするために)、その名前を指定するために便利です。 また、PythonScriptStep 入力の bind_mode を指定するために使用できます。

InputPortBinding を初期化します。

Module

Azure Machine Learning パイプラインで使用される計算単位を表します。

モジュールは、コンピューティング先で実行されるファイルのコレクションであり、インターフェイスの記述です。 ファイルのコレクションには、スクリプト、バイナリ、またはコンピューティング先で実行するために必要なその他のファイルを指定できます。 モジュール インターフェイスは、入力、出力、およびパラメーターの定義を記述します。 特定の値やデータにはバインドしません。 モジュールにはスナップショットが関連付けられており、モジュールに対して定義されたファイルのコレクションがキャプチャされます。

モジュールを初期化します。

ModuleVersion

Module 内の実際の計算単位を表します。

このクラスは直接使用しないでください。 代わりに、Module クラスのいずれかの発行メソッドを使用します。

ModuleVersion を初期化します。

ModuleVersionDescriptor

ModuleVersion のバージョンと ID を定義します。

ModuleVersionDescriptor を初期化します。

OutputPortBinding

パイプライン ステップの名前付き出力を定義します。

OutputPortBinding を使用して、ステップによって生成されるデータの型と、データの生成方法を指定できます。 InputPortBinding と共に使用して、ステップの出力が別のステップの必須の入力であることを指定できます。

OutputPortBinding を初期化します。

Pipeline

再利用可能な Azure Machine Learning ワークフローとして実行できるステップのコレクションを表します。

パイプラインを使用して、機械学習のさまざまなフェーズを結び付けるワークフローを作成して管理します。 データの準備やモデルのトレーニングなどの各機械学習フェーズは、1 つのパイプライン内の 1 つ以上のステップから構成できます。

パイプラインを使用する理由と状況の概要については、https://aka.ms/pl-concept を参照してください。

パイプラインの構築に関する概要については、https://aka.ms/pl-first-pipeline を参照してください。

パイプラインを初期化します。

PipelineData

Azure Machine Learning パイプライン内の中間データを表します。

パイプラインで使用するデータは、あるステップで生成し、別のステップで使用することができます。そのためには、PipelineData オブジェクトをある 1 つのステップの出力および 1 つ以上の後続ステップの入力として指定します。

: パイプライン データを使用する場合は、使用するディレクトリが存在している必要があります。

ディレクトリが存在していることを確認する Python の例として、ある 1 つのパイプライン ステップに output_folder という名前の出力ポートが含まれていて、このフォルダー内の相対パスにデータを書き込む場合があります。


   import os
   os.makedirs(args.output_folder, exist_ok=True)
   f = open(args.output_folder + '/relative_path/file_name', 'w+')

PipelineData では基になる DataReference を使用します。これは、データのアクセスと配信のための推奨されるアプローチではなくなりました。代わりに OutputFileDatasetConfig を使用してください。サンプルについては、OutputFileDatasetConfig を使用したパイプラインに関するページを参照してください。

PipelineData を初期化します。

PipelineDataset

データセットとパイプラインのアダプターとして機能します。

Note

このクラスは非推奨とされます。 パイプラインでデータセットを使用する方法については、「 https://aka.ms/pipeline-with-dataset 」を参照してください。

これは内部クラスです。 このクラスを直接作成するのではなく、Dataset または OutputDatasetConfig クラスで as_* インスタンス メソッドを呼び出す必要があります。

データセットとパイプラインのアダプターとして機能します。

これは内部クラスです。 このクラスを直接作成するのではなく、Dataset または OutputDatasetConfig クラスで as_* インスタンス メソッドを呼び出す必要があります。

PipelineDraft

実行の送信と公開済みパイプラインの作成に使用できる変更可能なパイプラインを表します。

PipelineDrafts を使用して、パイプラインを反復処理します。 PipelineDrafts は、新規に作成するか、別の PipelineDraft、または既存のパイプライン (PipelinePublishedPipeline、または PipelineRun) から作成できます。

PipelineDraft を初期化します。

PipelineEndpoint

一意のエンドポイント URL からトリガーできる Pipeline ワークフローを表します。

PipelineEndpoint を使用すると、同じエンドポイントを維持しながら PublishedPipeline の新しいバージョンを作成できます。 PipelineEndpoint には、ワークスペース内で一意の名前が付けられます。

PipelineEndpoint オブジェクトの endpoint 属性を使用すると、外部アプリケーションから REST 呼び出しを使用して新しいパイプライン実行をトリガーできます。 REST エンドポイントを呼び出すときの認証方法については、https://aka.ms/pl-restep-auth を参照してください。

機械学習パイプラインの作成と実行の詳細については、https://aka.ms/pl-first-pipeline を参照してください。

PipelineEndpoint を初期化します。

PipelineParameter

パイプライン実行のパラメーターを定義します。

PipelineParameter を使用して、さまざまなパラメーター値により、後で再送信できる汎用的なパイプラインを構築します。

パイプライン パラメーターを初期化します。

PipelineRun

Pipelineの実行を表します。

このクラスは、パイプライン実行が送信された後の管理、状態の検査、実行の詳細の取得に使用できます。 get_stepsを使用して、パイプライン実行によって作成されるStepRunオブジェクトを取得します。 その他の用途には、パイプライン実行に関連付けられているGraphオブジェクトの取得、パイプライン実行の状態のフェッチ、実行完了の待機などがあります。

パイプラインの実行を初期化します。

PipelineStep

Azure Machine Learning パイプライン内の実行ステップを表します。

パイプラインは、パイプライン内の個別のコンピューティング単位である複数のパイプライン ステップから構成されます。 各ステップは個別に実行でき、分離されたコンピューティング リソースを使用できます。 各ステップには通常、独自の名前付き入力、出力、パラメーターがあります。

PipelineStep クラスは、一般的なシナリオ用に設計された他の組み込みのステップ クラス (PythonScriptStepDataTransferStepHyperDriveStep など) が継承する基底クラスです。

Pipelines と PipelineSteps の関係の概要については、ML パイプラインに関する記事をご覧ください。

PipelineStep を初期化します。

PortDataReference

完了した StepRun の出力に関連付けられたデータをモデル化します。

PortDataReference オブジェクトを使用して、StepRun によって生成された出力データをダウンロードできます。 これは、後のパイプラインでステップ入力として使用することもできます。

PortDataReference を初期化します。

PublishedPipeline

それを構築した Python コードを使用せずに送信されるパイプラインを表します。

さらに、PublishedPipeline を使用して、異なる PipelineParameter 値と入力を持つ Pipeline を再送信できます。

PublishedPipeline を初期化します。

:p aram エンドポイント このパイプラインの実行を送信する REST エンドポイント URL。 :type endpoint: str :p aram total_run_steps:type total_run_steps: int :p aram workspace: 発行されたパイプラインのワークスペース。 :type workspace: azureml.core.Workspace :p aram continue_on_step_failure: PipelineRun で他のステップの実行を続行するかどうか

ステップが失敗した場合、既定値は false です。

Schedule

パイプラインを送信するスケジュールを定義します。

パイプラインが発行されると、スケジュールを使用して、指定した間隔で、または BLOB ストレージの場所に対する変更が検出されたときにパイプラインを送信できます。

スケジュールを初期化します。

ScheduleRecurrence

パイプライン Schedule の頻度、間隔、開始時刻を定義します。

ScheduleRecurrence では、タイム ゾーンと、繰り返しの時間、分、または曜日を指定できます。

スケジュールの繰り返しを初期化します。

また、タイム ゾーンと、繰り返しの時間または分または週の日を指定することもできます。

StepRun

Pipeline 内のステップの実行。

親のパイプライン実行が送信され、パイプラインによってステップ実行が送信されると、このクラスを使用して実行の詳細を管理したり、状態確認したり、取得したりできます。

StepRun を初期化します。

StepRunOutput

パイプライン内の StepRun によって作成された出力を表します。

StepRunOutput を使用すると、ステップによって作成された PortDataReference にアクセスできます。

StepRunOutput を初期化します。

StepSequence

Pipeline 内のステップの一覧と、それらの実行順序を表します。

パイプラインの初期化時に StepSequence を使用して、特定の順序で実行するステップを含むワークフローを作成します。

StepSequence を初期化します。

TrainingOutput

パイプラインで使用するための特定の PipelineSteps の特殊な出力を定義します。

TrainingOutput を使用すると、自動化された機械学習メトリックまたはモデルを、Azure Machine Learning Pipeline の別のステップで使用されるステップ出力として使用できるようになります。 AutoMLStep または HyperDriveStep と同時に使用できます。

TrainingOutput を初期化します。

param model_file: 出力に含める特定のモデル ファイル。 HyperDriveStep の場合のみ。

列挙型

TimeZone

繰り返し Schedule の有効なタイム ゾーンを列挙します。