OutputPortDef クラス

出力ポートの定義。

出力ポートを作成します。

継承

builtins.object

OutputPortDef

コンストラクター

OutputPortDef(name, default_datastore_name=None, default_datastore_mode=None, default_path_on_compute=None, is_directory=False, data_type=None, default_overwrite=None, training_output=None, label=None)

パラメーター

name

str

必須

出力ポートの名前。

default_datastore_name

str

既定値: None

この出力を書き込む既定のデータ ストア。

default_datastore_mode

str

既定値: None

出力を生成するための既定のモード ("mount" または "upload")。

default_path_on_compute

str

既定値: None

"upload" モードの場合、モジュールが実行中に書き込むパス。

is_directory

bool

既定値: False

出力がファイルのディレクトリの場合は True、単一のファイルの場合は False (既定値: False)。

data_type

str

既定値: None

この出力に適用するデータ型。 指定しない場合は、is_directory に基づく既定値を使用します。

default_overwrite

bool

既定値: None

"upload" モードの場合は、既存のデータを上書きするかどうかを示します。

training_output

TrainingOutput

既定値: None

トレーニング結果の出力を定義します。 これは、メトリックやモデルなどの異なる種類の出力を生成する、特定のトレーニングに対してのみ必要です。 たとえば、AutoMLStep はメトリックとモデルを生成します。 また、最適なモデルを取得するために使用される、特定のトレーニング イテレーションまたはメトリックを定義することもできます。 HyperDriveStep では、出力に含める特定のモデル ファイルを定義することもできます。

label

str

既定値: None

出力ポートのオプションのラベルであり、ポートの簡単な説明として機能します。

name

str

必須

出力ポートの名前。

default_datastore_name

str

必須

この出力を書き込む既定のデータ ストア。

default_datastore_mode

str

必須

出力を生成するための既定のモード ("mount" または "upload")。

default_path_on_compute

str

必須

"upload" モードの場合、モジュールが実行中に書き込むパス。

is_directory

bool

必須

出力がファイルのディレクトリの場合は True、単一のファイルの場合は False (既定値: False)。

data_type

str

必須

この出力に適用するデータ型。 指定しない場合は、is_directory に基づく既定値を使用します。

default_overwrite

bool

必須

"upload" モードの場合は、既存のデータを上書きするかどうかを示します。

training_output

TrainingOutput

必須

トレーニング結果の出力を定義します。 これは、メトリックやモデルなどの異なる種類の出力を生成する、特定のトレーニングに対してのみ必要です。 たとえば、AutoMLStep はメトリックとモデルを生成します。 また、最適なモデルを取得するために使用される、特定のトレーニング イテレーションまたはメトリックを定義することもできます。 HyperDriveStep では、出力に含める特定のモデル ファイルを定義することもできます。

label

必須

出力ポートのオプションのラベルであり、ポートの簡単な説明として機能します。

属性

data_type

この出力に適用するデータ型。 指定しない場合は、is_directory に基づいて既定値を使用します。

戻り値

データ型です。

の戻り値の型 :

str

default_datastore_mode

"mount" または "upload"(アップロードされたローカル ファイル) のいずれかの出力を生成するための既定のモードを取得します。

戻り値

既定のデータストア モード。

の戻り値の型 :

str

default_datastore_name

この出力を書き込む既定のデータ ストアを取得します。

戻り値

既定のデータストア名。

の戻り値の型 :

str

default_overwrite

"upload" モードの場合は、既存のデータを上書きするかどうかを示します。

戻り値

OutputPortDef の default_overwrite プロパティ。

の戻り値の型 :

bool

default_path_on_compute

"upload" モードの場合、モジュールが実行中にこの出力を書き込むパス。

戻り値

コンピューティングの既定のパス。

の戻り値の型 :

str

is_directory

出力がファイルのディレクトリであるかどうかを示すブール値を返します。

戻り値

OutputPortDef の is_directory プロパティ。 出力がファイルのディレクトリの場合は True。それ以外の場合、単一のファイルの場合は False。

の戻り値の型 :

bool

label

ポートのラベルを取得します。

戻り値

ポートのラベル。

の戻り値の型 :

str

name

出力ポートの名前を取得します。

戻り値

出力ポートの名前。

の戻り値の型 :

str

training_output

トレーニングの出力を取得します。

戻り値

トレーニングの出力。

の戻り値の型 :

TrainingOutput