Job 類別

  • 參考

作業的基類。

不應該直接具現化這個類別。 請改用它的其中一個子類別。

繼承
azure.ai.ml.entities._resource.Resource
Job
azure.ai.ml.entities._job.pipeline._component_translatable.ComponentTranslatableMixin
Job
azure.ai.ml.entities._mixins.TelemetryMixin
Job

建構函式

Job(name: str | None = None, display_name: str | None = None, description: str | None = None, tags: Dict | None = None, properties: Dict | None = None, experiment_name: str | None = None, compute: str | None = None, services: Dict[str, JobService] | None = None, **kwargs: Dict)

參數

name
Optional[str]
預設值: None

作業的名稱。

display_name
Optional[str]
預設值: None

作業的顯示名稱。

description
Optional[str]
預設值: None

這是作業的描述。

tags
Optional[dict[str, str]]
預設值: None

標記字典。 標記可以新增、移除和更新。

properties
Optional[dict[str, str]]
預設值: None

job 屬性字典。

experiment_name
Optional[str]
預設值: None

將建立作業的實驗名稱。 預設為目前目錄的名稱。

services
Optional[dict[str, JobService]]
預設值: None

與作業相關聯的服務相關資訊。

compute
Optional[str]
預設值: None

與作業相關聯的計算資源相關資訊。

kwargs
dict

其他組態參數的字典。

方法

dump

以 YAML 格式將作業內容傾印到檔案中。

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

屬性

base_path

資源的基底路徑。

傳回

資源的基底路徑。

傳回類型

str

creation_context

資源的建立內容。

傳回

資源的建立中繼資料。

傳回類型

Optional[SystemData]

id

資源識別碼。

傳回

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

傳回類型

Optional[str]

log_files

作業輸出檔案。

傳回

記錄名稱和 URL 的字典。

傳回類型

Optional[Dict[str, str]]

status

工作的狀態。

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

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

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

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

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

    • Docker 映射組建

    • conda 環境設定

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

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

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

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

  • CancelRequested - 已要求取消作業。

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

    後續處理階段。

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

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

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

傳回

作業的狀態。

傳回類型

Optional[str]

studio_url

Azure ML Studio 端點。

傳回

作業詳細資料頁面的 URL。

傳回類型

Optional[str]

type

作業的類型。

傳回

作業的類型。

傳回類型

Optional[str]