utilities 模組
驗證和轉換的公用程式方法。
類別
suppress_stdout_stderr |
用於執行 stdout 和 stderr「深層隱藏」的內容管理員。 即使列印源自編譯的 C/Fortran 子函式,仍會隱藏所有列印。 不會隱藏引發的例外狀況,因為例外狀況會在腳本結束之前列印到 stderr,而且內容管理員結束之後。 建立內容管理員。 |
函式
convert_dict_values_to_str
轉換字典的值,讓每個值都是字串。
convert_dict_values_to_str(input_dict: Dict[Any, Any]) -> Dict[str, str]
參數
名稱 | Description |
---|---|
input_dict
必要
|
應該轉換的字典 |
傳回
類型 | Description |
---|---|
所有值轉換成字串的字典 |
get_default_metric_with_objective
取得計量的字典 - > 指定工作的目標。
get_default_metric_with_objective(task)
參數
名稱 | Description |
---|---|
task
必要
|
字串 「classification」 或 「regression」 |
傳回
類型 | Description |
---|---|
計量字典 - > 目標 |
get_error_code
從例外狀況建置錯誤碼。
get_error_code(exception: BaseException, as_hierarchy: bool = False) -> str
參數
名稱 | Description |
---|---|
exception
必要
|
執行失敗的例外狀況。 |
as_hierarchy
|
如果應該傳回完整的錯誤階層 預設值: False
|
傳回
類型 | Description |
---|---|
傳回包含error_code的 str。 如果as_hierarchy為 True,則傳回的階層會由 '.' 聯結。 |
get_min_points
傳回定型所需的最小資料點數目。
get_min_points(window_size: int, lags: List[int], max_horizon: int, cv: int | None, n_step: int | None = None) -> int
參數
名稱 | Description |
---|---|
window_size
必要
|
滾動視窗大小。 |
lags
必要
|
延隔大小。 |
max_horizon
必要
|
預測所需的長度。 |
cv
必要
|
交叉驗證的數目。 |
n_step
|
一個 CV 折迭origin_time與下一個折迭之間的期間數。 例如,如果 每日資料n_step = 3,則每個折迭的原點時間會相隔三天。 預設值: None
|
傳回
類型 | Description |
---|---|
資料點數目下限。 |
get_primary_metrics
取得指定工作支援的主要計量作為清單。
get_primary_metrics(task: str) -> List[str]
參數
名稱 | Description |
---|---|
task
必要
|
AutoML 所支援的工作類型,如 azureml.automl.core.shared.constants.Tasks 中所定義 |
傳回
類型 | Description |
---|---|
工作支援的主要計量清單。 |
get_value_float
將字串值轉換為 float。 :p aram floatstring:要轉換的輸入值。 :type floatstring: str :return:已轉換的值。 :rtype: float
get_value_float(floatstring: str) -> float | str | None
參數
名稱 | Description |
---|---|
floatstring
必要
|
|
get_value_from_dict
取得具有名稱清單的組態專案值。
get_value_from_dict(dictionary: Dict[str, Any], names: List[str], default_value: Any) -> Any
參數
名稱 | Description |
---|---|
dictionary
必要
|
具有索引鍵值組的設定字典,以尋找資料。 |
names
必要
|
尋找 foi 之專案的名稱清單。 |
default_value
必要
|
如果找不到相符的索引鍵,則傳回的預設值 |
傳回
類型 | Description |
---|---|
從名稱清單中傳回第一個值。 |
get_value_int
將字串值轉換為 int。
get_value_int(intstring: str) -> int | str | None
參數
名稱 | Description |
---|---|
intstring
必要
|
要轉換的輸入值。 |
傳回
類型 | Description |
---|---|
轉換的值。 |
interpret_exception
將例外狀況轉譯為 AzureMLException。
如果例外狀況已經是已知類型的其中一種 (,例如 ServiceException、AzureMLException) ,請依原狀傳回例外狀況。
開發人員注意:如果我們看到新增更多例外狀況,或針對遠端與本機執行新增解譯,請考慮將這項功能轉換成自己的類別
interpret_exception(exception: BaseException, is_aml_compute: bool = True, **kwargs: Any) -> AzureMLException | ServiceException
參數
名稱 | Description |
---|---|
exception
必要
|
需要解譯的例外狀況物件 |
is_aml_compute
|
如果內容是 AML 計算 (上的執行服務受控執行,例如 OSErrors,則網路錯誤可能需要根據執行類型以不同的方式解譯) 預設值: True
|
kwargs
必要
|
ErrorDefinition 預期 (的任何執行時間屬性,例如 reference_code) |
傳回
類型 | Description |
---|---|
例外狀況解譯為具有錯誤碼的 AzureMLException |
is_known_date_time_format
檢查指定的字串是否符合已知的日期時間正則運算式。
is_known_date_time_format(datetime_str: str) -> bool
參數
名稱 | Description |
---|---|
datetime_str
必要
|
輸入字串,以檢查是否為日期 |
傳回
類型 | Description |
---|---|
指定的字串是否為已知的日期時間格式 |
minimize_or_maximize
選取指定計量的目標。
某些計量應該最小化,有些應該最大化:p aram 計量:要查閱的計量名稱:p aram 工作:其中一個常數。任務。 :return: 會傳回其中一個常數。優化器Objectives。
minimize_or_maximize(metric, task=None)
參數
名稱 | Description |
---|---|
metric
必要
|
|
task
|
預設值: None
|
subsampling_recommended
subsampling_recommended(num_samples)
參數
名稱 | Description |
---|---|
num_samples
必要
|
樣本數目。 |
傳回
類型 | Description |
---|---|
如果建議子取樣,則為 True,否則為 False。 |
to_ordinal_string
將整數轉換成序數位符串。
to_ordinal_string(integer: int) -> str
參數
名稱 | Description |
---|---|
integer
必要
|
|