ModelPackage 類別

  • 參考

注意

這是實驗性類別，可以隨時變更。 請參閱 https://aka.ms/azuremlexperimental 以取得詳細資訊。

模型套件。

繼承
azure.ai.ml.entities._resource.Resource
ModelPackage
azure.ai.ml._restclient.v2023_02_01_preview.models._models_py3.PackageRequest
ModelPackage

建構函式

ModelPackage(*, target_environment_name: str = None, target_environment_id: str = None, inferencing_server: AzureMLOnlineInferencingServer | AzureMLBatchInferencingServer, base_environment_source: BaseEnvironment = None, target_environment_version: str | None = None, environment_variables: Dict[str, str] | None = None, inputs: List[ModelPackageInput] | None = None, model_configuration: ModelConfiguration | None = None, tags: Dict[str, str] | None = None)

參數

target_environment_name
str
必要

模型封裝的目標環境名稱。

inferencing_server
Union[AzureMLOnlineInferencingServer, AzureMLBatchInferencingServer]
必要

模型封裝的推斷伺服器。

base_environment_source
Optional[BaseEnvironment]
必要

模型封裝的基底環境來源。

target_environment_version
Optional[str]
必要

模型套件的版本。

environment_variables
Optional[dict[str, str]]
必要

模型封裝的環境變數。

inputs
Optional[list[ModelPackageInput]]
必要

模型封裝的輸入。

model_configuration
Optional[ModelConfiguration]
必要

模型組態。

tags
Optional[dict[str, str]]
必要

模型封裝的標記。

範例

建立模型封裝物件。


   from azure.ai.ml.entities import AzureMLOnlineInferencingServer, CodeConfiguration, ModelPackage

   modelPackage = ModelPackage(
       inferencing_server=AzureMLOnlineInferencingServer(
           code_configuration=CodeConfiguration(code="../model-1/foo/", scoring_script="score.py")
       ),
       target_environment_name="env-name",
       target_environment_version="1.0",
       environment_variables={"env1": "value1", "env2": "value2"},
       tags={"tag1": "value1", "tag2": "value2"},
   )

方法

as_dict

使用 json.dump 傳回可以是 JSONify 的聽寫。

進階用法可以選擇性地使用回呼作為參數：

索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。

傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。

請參閱此檔案中的三個範例：

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。
deserialize

使用 RestAPI 語法剖析 str 並傳回模型。
dump

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

使用指定的金鑰擷取器剖析聽寫會傳回模型。

根據預設，請考慮金鑰擷取器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor和last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

傳回會從此模型傳送至 Azure 的 JSON。

這是 as_dict (full_restapi_key_transformer別名，keep_readonly=False) 。

如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。
validate

以遞迴方式驗證此模型，並傳回 ValidationError 的清單。

as_dict

使用 json.dump 傳回可以是 JSONify 的聽寫。

進階用法可以選擇性地使用回呼作為參數：

索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。

傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。

請參閱此檔案中的三個範例：

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

參數

key_transformer
<xref:function>

金鑰轉換器函式。

keep_readonly
預設值: True

傳回

與聽寫 JSON 相容的物件

傳回類型

dict

deserialize

使用 RestAPI 語法剖析 str 並傳回模型。

deserialize(data, content_type=None)

參數

data
str
必要

使用 RestAPI 結構的 str。 JSON 預設為 。

content_type
str
預設值: None

JSON 預設會設定 application/xml if XML。

傳回

此模型的實例

例外狀況

DeserializationError if something went wrong

dump

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

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

參數

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

要寫入 YAML 內容的本機路徑或檔案資料流程。 如果 dest 是檔案路徑，則會建立新的檔案。 如果 dest 是開啟的檔案，則會直接寫入檔案。

例外狀況

FileExistsError

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

IOError

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

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

使用指定的金鑰擷取器剖析聽寫會傳回模型。

根據預設，請考慮金鑰擷取器 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor和last_rest_key_case_insensitive_extractor) 

from_dict(data, key_extractors=None, content_type=None)

參數

data
dict
必要

使用 RestAPI 結構的聽寫

content_type
str
預設值: None

JSON 預設會設定 application/xml if XML。

key_extractors
預設值: None

傳回

此模型的實例

例外狀況

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

傳回會從此模型傳送至 Azure 的 JSON。

這是 as_dict (full_restapi_key_transformer別名，keep_readonly=False) 。

如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。

serialize(keep_readonly=False, **kwargs)

參數

keep_readonly
bool
預設值: False

如果您想要序列化唯讀屬性

傳回

與聽寫 JSON 相容的物件

傳回類型

dict

validate

以遞迴方式驗證此模型，並傳回 ValidationError 的清單。

validate()

傳回

驗證錯誤清單

傳回類型

list

屬性

base_path

資源的基底路徑。

傳回

資源的基底路徑。

傳回類型

str

creation_context

資源的建立內容。

傳回

資源的建立中繼資料。

傳回類型

Optional[SystemData]

id

資源識別碼。

傳回

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

傳回類型

Optional[str]