Sweep 類別

掃掠節點的基類。

此類別不應該直接具現化。 相反地，它應該透過建立器函式建立：掃掠。

繼承

azure.ai.ml.entities._job.sweep.parameterized_sweep.ParameterizedSweep

Sweep

azure.ai.ml.entities._builders.base_node.BaseNode

Sweep

建構函式

Sweep(*, trial: CommandComponent | str | None = None, compute: str | None = None, limits: SweepJobLimits | None = None, sampling_algorithm: str | SamplingAlgorithm | None = None, objective: Objective | None = None, early_termination: BanditPolicy | MedianStoppingPolicy | TruncationSelectionPolicy | None = None, search_space: Dict[str, Choice | LogNormal | LogUniform | Normal | QLogNormal | QLogUniform | QNormal | QUniform | Randint | Uniform] | None = None, inputs: Dict[str, int | str | float | bool | Input] | None = None, outputs: Dict[str, str | Output] | None = None, identity: ManagedIdentityConfiguration | AmlTokenConfiguration | UserIdentityConfiguration | None = None, queue_settings: QueueSettings | None = None, **kwargs)

參數

trial

Union[CommandComponent, str]

必要

要針對步驟執行的命令元件或作業的識別碼或實例。

compute

str

必要

包含步驟計算資訊的計算定義。

limits

SweepJobLimits

必要

掃掠節點的限制。

sampling_algorithm

str

必要

用於在搜尋空間內取樣的取樣演算法。 接受的值為：「random」、「grid」 或 「bayesian」。

objective

Objective

必要

用來判斷目標在搜尋空間中使用本機最佳超參數執行的目標。

early_termination_policy

Union[BanditPolicy, MedianStoppingPolicy, TruncationSelectionPolicy]

必要

掃掠節點的早期終止原則。

search_space

Dict[str, Union[Choice, LogNormal, LogUniform, Normal, QLogNormal, QLogUniform, QNormal, QUniform, Randint, Uniform]]

必要

要執行試用版的超參數搜尋空間。

inputs

Dict[str, Union[Input, str, bool, int, float]]

必要

對應作業中使用的輸入資料系結。

outputs

Dict[str, Union[str, Output]]

必要

對應作業中使用的輸出資料系結。

identity

Union[ManagedIdentityConfiguration, AmlTokenConfiguration, UserIdentityConfiguration]

必要

在計算上執行時，定型作業將使用的身分識別。

queue_settings

QueueSettings

必要

作業的佇列設定。

方法

clear
copy
dump	以 YAML 格式將作業內容傾印到檔案中。
fromkeys	建立新的字典，其中包含可反覆運算的索引鍵，並將值設定為 value。
get	如果索引鍵位於字典中，則傳回索引鍵的值，否則為預設值。
items
keys
pop	如果找不到索引鍵，則傳回指定的預設值;否則，請引發 KeyError。
popitem	移除並傳回 (索引鍵、值) 組作為 2 元組。 配對會以 LIFO 傳回， (先出) 順序。 如果聽寫是空的，則引發 KeyError。
set_limits	設定 [掃掠] 節點的限制。 如果您不想更新對應的值，請將參數保留為 None。
set_objective	設定掃掠物件。 如果您不想更新對應的值，請將參數保留為 None。 「minimize」、「maximize」。 ：type goal： str ：keyword primary_metric：要優化的計量名稱。 :p aramtype primary_metric： str
setdefault	如果索引鍵不在字典中，則插入值為預設值的索引鍵。 如果索引鍵位於字典中，則傳回索引鍵的值，否則為預設值。
update	如果 E 存在且具有 .keys () 方法，則執行： e： D[k] = E[k] 如果 E 存在且缺少 .keys () 方法，則會執行： for k， v in E： D[k] = v 在任一案例中，後面接著： f： D[k] = F[k]
values

clear

clear() -> None.  Remove all items from D.

copy

copy() -> a shallow copy of D

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 是開啟的檔案，而且無法寫入檔案，則引發。

fromkeys

建立新的字典，其中包含可反覆運算的索引鍵，並將值設定為 value。

fromkeys(value=None, /)

參數

type

必要

iterable

必要

value

預設值: None

get

如果索引鍵位於字典中，則傳回索引鍵的值，否則為預設值。

get(key, default=None, /)

參數

key

必要

default

預設值: None

items

items() -> a set-like object providing a view on D's items

keys

keys() -> a set-like object providing a view on D's keys

pop

如果找不到索引鍵，則傳回指定的預設值;否則，請引發 KeyError。

pop(k, [d]) -> v, remove specified key and return the corresponding value.

popitem

移除並傳回 (索引鍵、值) 組作為 2 元組。

配對會以 LIFO 傳回， (先出) 順序。 如果聽寫是空的，則引發 KeyError。

popitem()

set_limits

設定 [掃掠] 節點的限制。 如果您不想更新對應的值，請將參數保留為 None。

set_limits(*, max_concurrent_trials: int | None = None, max_total_trials: int | None = None, timeout: int | None = None, trial_timeout: int | None = None) -> None

參數

max_concurrent_trials

int

並行試用數目上限。

max_total_trials

int

試用版總數上限。

timeout

int

掃掠節點以秒為單位的總逾時

trial_timeout

int

每個試用版的逾時以秒為單位

set_objective

設定掃掠物件。 如果您不想更新對應的值，請將參數保留為 None。

「minimize」、「maximize」。 ：type goal： str ：keyword primary_metric：要優化的計量名稱。 :p aramtype primary_metric： str

set_objective(*, goal: str | None = None, primary_metric: str | None = None) -> None

參數

goal

定義超參數微調支援的計量目標。 可接受的值如下：

setdefault

如果索引鍵不在字典中，則插入值為預設值的索引鍵。

如果索引鍵位於字典中，則傳回索引鍵的值，否則為預設值。

setdefault(key, default=None, /)

參數

key

必要

default

預設值: None

update

如果 E 存在且具有 .keys () 方法，則執行： e： D[k] = E[k] 如果 E 存在且缺少 .keys () 方法，則會執行： for k， v in E： D[k] = v 在任一案例中，後面接著： f： D[k] = F[k]

update([E], **F) -> None.  Update D from dict/iterable E and F.

values

values() -> an object providing a view on D's values

屬性

base_path

資源的基底路徑。

傳回

資源的基底路徑。

傳回類型

str

creation_context

資源的建立內容。

傳回

資源的建立中繼資料。

傳回類型

Optional[SystemData]

early_termination

掃掠作業的早期終止原則。

傳回類型

Union[str, BanditPolicy, MedianStoppingPolicy, TruncationSelectionPolicy]

id

資源識別碼。

傳回

資源的全域識別碼，Azure Resource Manager (ARM) 識別碼。

傳回類型

Optional[str]

inputs

取得 物件的輸入。

傳回

字典，包含 物件的輸入。

傳回類型

Dict[str, Union[Input, str, bool, int, float]]

limits

掃掠作業的限制。

傳回

掃掠作業的限制。

傳回類型

SweepJobLimits

log_files

作業輸出檔案。

傳回

記錄名稱和 URL 的字典。

傳回類型

Optional[Dict[str, str]]

name

取得節點的名稱。

傳回

節點的名稱。

傳回類型

str

outputs

取得 物件的輸出。

傳回

字典，包含 物件的輸出。

傳回類型

Dict[str, Union[str, Output]]

sampling_algorithm

掃掠作業的取樣演算法。

傳回

掃掠作業的取樣演算法。

傳回類型

SamplingAlgorithm

search_space

超參數搜尋空間的字典。

每個索引鍵都是超參數的名稱，而其值是參數運算式。

傳回類型

Dict[str, Union[Choice, LogNormal, LogUniform, Normal, QLogNormal, QLogUniform, QNormal, QUniform, Randint, Uniform]]

status

工作的狀態。

傳回的常見值包括 「Running」、「Completed」 和 「Failed」。 所有可能的值為：

• NotStarted - 這是用戶端 Run 物件在雲端提交之前所在的暫時狀態。

• 啟動 - 執行已在雲端中開始處理。 呼叫端此時有執行識別碼。

• 布建 - 針對指定的作業提交建立隨選計算。

• 準備 - 正在準備執行環境，且處於兩個階段之一：

  • Docker 映射組建

  • conda 環境設定

• 已排入佇列 - 作業會排入計算目標上的佇列。 例如，在 BatchAI 中，作業處於佇列狀態

  等候所有要求的節點準備就緒時。

• 執行 - 作業已開始在計算目標上執行。

• 完成 - 使用者程式碼執行已完成，且執行處於後續處理階段。

• CancelRequested - 已要求取消作業。

• 已完成 - 執行已順利完成。 這包括使用者程式碼執行和執行

  後續處理階段。

• 失敗 - 執行失敗。 執行上的 Error 屬性通常會提供原因的詳細資料。

• 已取消 - 遵循取消要求，並指出現在已成功取消執行。

• NotResponding - 針對已啟用活動訊號的執行，最近不會傳送活動訊號。

傳回

作業的狀態。

傳回類型

Optional[str]

studio_url

Azure ML Studio 端點。

傳回

作業詳細資料頁面的 URL。

傳回類型

Optional[str]

trial

要針對步驟執行的命令元件或作業的識別碼或實例。

傳回類型

CommandComponent

type

作業的類型。

傳回

作業的類型。

傳回類型

Optional[str]