Environment 類別

  • 參考

用於定型的環境。

繼承
azure.ai.ml.entities._assets.asset.Asset
Environment
azure.ai.ml.entities._mixins.LocalizableMixin
Environment

建構函式

Environment(*, name: str | None = None, version: str | None = None, description: str | None = None, image: str | None = None, build: BuildContext | None = None, conda_file: str | PathLike | None = None, tags: Dict | None = None, properties: Dict | None = None, datastore: str | None = None, **kwargs)

參數

name
str
必要

資源名稱。

version
str
必要

資產的版本。

description
str
必要

資源的描述。

image
str
必要

自訂基底映射的 URI。

build
BuildContext
必要

用來建立環境的 Docker 建置內容。 與 「image」 互斥

conda_file
Union[str, PathLike]
必要

組態檔的路徑，列出要安裝的 conda 套件。

tags
dict[str, str]
必要

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

properties
dict[str, str]
必要

資產屬性字典。

datastore
str
必要

要上傳本機成品的資料存放區。

kwargs
dict
必要

其他組態參數的字典。

範例

建立 Environment 物件。


   from azure.ai.ml.entities._assets.environment import Environment

   environment = Environment(
       name="env-name",
       version="2.0",
       description="env-description",
       image="env-image",
       conda_file="./sdk/ml/azure-ai-ml/tests/test_configs/deployments/model-1/environment/conda.yml",
       tags={"tag1": "value1", "tag2": "value2"},
       properties={"prop1": "value1", "prop2": "value2"},
       datastore="datastore",
   )

方法

dump

以 YAML 格式將資產內容傾印到檔案中。
validate

藉由檢查環境的名稱、映射和組建來驗證環境

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

validate

藉由檢查環境的名稱、映射和組建來驗證環境

validate()

例外狀況

FileExistsError

如果 dest 是檔案路徑且檔案已經存在，則引發。

IOError

如果 dest 是開啟的檔案，而且無法寫入檔案，則引發。

範例

驗證環境範例。


   from azure.ai.ml.entities import BuildContext, Environment

   env_docker_context = Environment(
       build=BuildContext(
           path="./sdk/ml/azure-ai-ml/tests/test_configs/environment/environment_files",
           dockerfile_path="DockerfileNonDefault",
       ),
       name="create-environment",
       version="2.0",
       description="Environment created from a Docker context.",
   )

   env_docker_context.validate()

屬性

base_path

資源的基底路徑。

傳回

資源的基底路徑。

傳回類型

str

conda_file

Conda 環境規格。

傳回

從 conda_file 參數載入的 Conda 相依性。

傳回類型

Dict

creation_context

資源的建立內容。

傳回

資源的建立中繼資料。

傳回類型

Optional[SystemData]

id

資源識別碼。

傳回

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

傳回類型

Optional[str]

version

資產版本。

傳回

資產版本。

傳回類型

str