TextNerJob クラス

  • リファレンス

AutoML Text NER ジョブの構成。

新しい AutoML テキスト NER タスクを初期化します。

継承
azure.ai.ml.entities._job.automl.nlp.automl_nlp_job.AutoMLNLPJob
TextNerJob

コンストラクター

TextNerJob(*, training_data: Input | None = None, validation_data: Input | None = None, primary_metric: str | None = None, log_verbosity: str | None = None, **kwargs)

パラメーター

training_data
必須

トレーニングに使用するトレーニング データ

validation_data
必須

トレーニング済みモデルの評価に使用する検証データ

primary_metric
必須

表示される主要なメトリック。

log_verbosity
必須

ログの詳細レベル

kwargs
必須

ジョブ固有の引数

メソッド

dump

ジョブの内容を YAML 形式のファイルにダンプします。
extend_search_space

(a) この AutoML NLP ジョブの検索スペースを追加します。
set_data
set_featurization
set_limits
set_sweep

すべての AutoML NLP タスクのスイープ設定。
set_training_parameters

すべての受験者のトレーニング手順全体で特定のトレーニング パラメーターを修正します。

渡す。 これは正の整数である必要があります。 :キーワード (keyword) learning_rate: 初期学習率。 (0, 1) の float である必要があります。 :キーワード (keyword) learning_rate_scheduler: 学習率スケジューラの種類。 'linear'、'cosine'、'cosine_with_restarts'、'polynomial'、'constant'、および 'constant_with_warmup' から選択する必要があります。 :キーワード (keyword) model_name: トレーニング中に使用するモデル名。 'bert-base-cased'、'bert-base-uncased'、'bert-base-multilingual-cased'、'bert-base-german-cased'、'bert-large-cased' から選択する必要があります。 'bert-large-uncased'、'distilbert-base-cased'、'distilbert-base-uncased'、'roberta-large'、'distilroberta-base'、'xlm-roberta-base'、'xlm-roberta-large'、xlnet-base-cased'、および 'xlnet-large-cased' 。 :キーワード (keyword) number_of_epochs: トレーニングに使用するエポックの数。 正の整数にする必要があります。 :キーワード (keyword) training_batch_size: トレーニング中のバッチ サイズ。 正の整数にする必要があります。 :キーワード (keyword) validation_batch_size: 検証中のバッチ サイズ。 正の整数にする必要があります。 :キーワード (keyword) warmup_ratio: 0 からlearning_rateまでの線形ウォームアップに使用されるトレーニングステップの合計の比率。 [0, 1] の float である必要があります。 :キーワード (keyword) weight_decay: オプティマイザーが sgd、adam、または adamw の場合の重みの減衰の値。 これは、範囲 [0, 1] の float である必要があります。 :return: None。

dump

ジョブの内容を YAML 形式のファイルにダンプします。

dump(dest: str | PathLike | IO, **kwargs) -> None

パラメーター

dest
Union[<xref:PathLike>, str, IO[AnyStr]]
必須

YAML コンテンツを書き込むローカル パスまたはファイル ストリーム。 dest がファイル パスの場合は、新しいファイルが作成されます。 dest が開いているファイルの場合、ファイルは に直接書き込まれます。

kwargs
dict

YAML シリアライザーに渡す追加の引数。

例外

FileExistsError

dest がファイル パスであり、ファイルが既に存在する場合に発生します。

IOError

dest が開いているファイルで、ファイルが書き込み可能でない場合に発生します。

extend_search_space

(a) この AutoML NLP ジョブの検索スペースを追加します。

extend_search_space(value: SearchSpace | List[SearchSpace]) -> None

パラメーター

value
Union[SearchSpace, List[SearchSpace]]
必須

SearchSpace オブジェクト、または nlp 固有のパラメーターを持つ SearchSpace オブジェクトの一覧。

戻り値

[なし] :

例外

FileExistsError

dest がファイル パスであり、ファイルが既に存在する場合に発生します。

IOError

dest が開いているファイルで、ファイルが書き込み可能でない場合に発生します。

set_data 

set_data(*, training_data: Input, target_column_name: str, validation_data: Input) -> None

例外

FileExistsError

dest がファイル パスであり、ファイルが既に存在する場合に発生します。

IOError

dest が開いているファイルで、ファイルが書き込み可能でない場合に発生します。

set_featurization 

set_featurization(*, dataset_language: str | None = None) -> None

例外

FileExistsError

dest がファイル パスであり、ファイルが既に存在する場合に発生します。

IOError

dest が開いているファイルで、ファイルが書き込み可能でない場合に発生します。

set_limits 

set_limits(*, max_trials: int = 1, max_concurrent_trials: int = 1, max_nodes: int = 1, timeout_minutes: int | None = None, trial_timeout_minutes: int | None = None) -> None

例外

FileExistsError

dest がファイル パスであり、ファイルが既に存在する場合に発生します。

IOError

dest が開いているファイルで、ファイルが書き込み可能でない場合に発生します。

set_sweep

すべての AutoML NLP タスクのスイープ設定。

set_sweep(*, sampling_algorithm: str | SamplingAlgorithmType, early_termination: EarlyTerminationPolicy | None = None)

パラメーター

sampling_algorithm

必須。 ハイパーパラメーター サンプリング アルゴリズムの種類を指定します。 使用可能な値は、"Grid"、"Random"、"Bayesian" です。

early_termination

パフォーマンスの低いトレーニング候補を終了するためのオプションの早期終了ポリシー。

戻り値

なし

例外

FileExistsError

dest がファイル パスであり、ファイルが既に存在する場合に発生します。

IOError

dest が開いているファイルで、ファイルが書き込み可能でない場合に発生します。

set_training_parameters

すべての受験者のトレーニング手順全体で特定のトレーニング パラメーターを修正します。

渡す。 これは正の整数である必要があります。 :キーワード (keyword) learning_rate: 初期学習率。 (0, 1) の float である必要があります。 :キーワード (keyword) learning_rate_scheduler: 学習率スケジューラの種類。 'linear'、'cosine'、'cosine_with_restarts'、'polynomial'、'constant'、および 'constant_with_warmup' から選択する必要があります。 :キーワード (keyword) model_name: トレーニング中に使用するモデル名。 'bert-base-cased'、'bert-base-uncased'、'bert-base-multilingual-cased'、'bert-base-german-cased'、'bert-large-cased' から選択する必要があります。 'bert-large-uncased'、'distilbert-base-cased'、'distilbert-base-uncased'、'roberta-large'、'distilroberta-base'、'xlm-roberta-base'、'xlm-roberta-large'、xlnet-base-cased'、および 'xlnet-large-cased' 。 :キーワード (keyword) number_of_epochs: トレーニングに使用するエポックの数。 正の整数にする必要があります。 :キーワード (keyword) training_batch_size: トレーニング中のバッチ サイズ。 正の整数にする必要があります。 :キーワード (keyword) validation_batch_size: 検証中のバッチ サイズ。 正の整数にする必要があります。 :キーワード (keyword) warmup_ratio: 0 からlearning_rateまでの線形ウォームアップに使用されるトレーニングステップの合計の比率。 [0, 1] の float である必要があります。 :キーワード (keyword) weight_decay: オプティマイザーが sgd、adam、または adamw の場合の重みの減衰の値。 これは、範囲 [0, 1] の float である必要があります。 :return: None。

set_training_parameters(*, gradient_accumulation_steps: int | None = None, learning_rate: float | None = None, learning_rate_scheduler: str | NlpLearningRateScheduler | None = None, model_name: str | None = None, number_of_epochs: int | None = None, training_batch_size: int | None = None, validation_batch_size: int | None = None, warmup_ratio: float | None = None, weight_decay: float | None = None) -> None

パラメーター

gradient_accumulation_steps

後方の前にグラデーションを蓄積するステップの数

例外

FileExistsError

dest がファイル パスであり、ファイルが既に存在する場合に発生します。

IOError

dest が開いているファイルで、ファイルが書き込み可能でない場合に発生します。

属性

base_path

リソースのベース パス。

戻り値

リソースのベース パス。

の戻り値の型 :

str

creation_context

リソースの作成コンテキスト。

戻り値

リソースの作成メタデータ。

の戻り値の型 :

Optional[SystemData]

featurization

id

リソース ID。

戻り値

リソースのグローバル ID、Azure Resource Manager (ARM) ID。

の戻り値の型 :

Optional[str]

inputs

limits

log_files

ジョブ出力ファイル。

戻り値

ログ名と URL のディクショナリ。

の戻り値の型 :

Optional[Dict[str, str]]

log_verbosity

outputs

primary_metric

search_space

status

ジョブの状態。

一般的には "Running"、"Completed"、"Failed" などの値が返されます。 使用可能なすべての値は次のとおりです。

  • NotStarted - これは、クラウドの送信前にクライアント側の Run オブジェクトが存在する一時的な状態です。

  • Starting - クラウドで Run が処理され始めています。 この時点で、呼び出し元に実行 ID があります。

  • プロビジョニング - 特定のジョブの送信に対してオンデマンド コンピューティングが作成されています。

  • 準備中 - 実行環境は準備中であり、次の 2 つの段階のいずれかにあります。

    • Docker イメージのビルド

    • Conda 環境のセットアップ

  • Queued - ジョブはコンピューティング先でキューに入れられます。 たとえば、BatchAI では、ジョブはキューに入った状態です

    要求されたノードの準備が整うのを待機しています。

  • 実行中 - コンピューティング 先でジョブの実行が開始されました。

  • 最終処理 - ユーザー コードの実行が完了し、実行は後処理段階にあります。

  • CancelRequested - ジョブに対してキャンセルが要求されました。

  • 完了 - 実行が正常に完了しました。 これには、ユーザー コードの実行と実行の両方が含まれます

    後処理のステージ。

  • Failed - 実行に失敗しました。 通常は実行の Error プロパティで、理由に関する詳細が提供されます。

  • Canceled - キャンセル要求に従い、実行が現在正常にキャンセルされたことを示します。

  • NotResponding - ハートビートが有効になっている実行の場合、最近ハートビートが送信されていません。

戻り値

ジョブの状態。

の戻り値の型 :

Optional[str]

studio_url

Azure ML Studio エンドポイント。

戻り値

ジョブの詳細ページの URL。

の戻り値の型 :

Optional[str]

sweep

task_type

タスクの種類を取得します。

戻り値

実行するタスクの種類。 使用できる値は、"classification"、"regression"、"forecasting" です。

の戻り値の型 :

str

test_data

テスト データを取得します。

戻り値

データ入力をテストする

の戻り値の型 :

Input

training_data

トレーニング データを取得します。

戻り値

トレーニング データ入力

の戻り値の型 :

Input

training_parameters

type

ジョブの種類。

戻り値

ジョブの種類。

の戻り値の型 :

Optional[str]

validation_data

検証データを取得します。

戻り値

検証データの入力

の戻り値の型 :

Input