Miscellaneous Methods

Note

This section includes various utility methods providing additional functionality for different purposes.

get_info(self, verbose=False) → Dict

Get model object details

Parameters:

verbose (bool, optional) – If True, returns additional model details. Defaults to False

Return type:

dict

The way to use me is:

>>> model.get_info()
>>> model.get_info(verbose=True)

get_PAC_id(self) → str

Get Platform Asset Catalog ( PAC ) ID.

Return type:

PAC ID

The way to use me is:

>>> client.assets.get_PAC_id()

get_external_model_inventory_config(self)

Retrieves the external model inventory configuration for the current account.

Returns the external model tracking status, the inventory name used for external model governance, and the admin user details. This is specific to the external model inventory setup and is only supported on IBM Cloud (SaaS).

Raises:

ClientError – If called from a Cloud Pak for Data environment, or if external model inventory has not been enabled.

Usage:

>>> client.assets.get_external_model_inventory_config()

get_version(self) → Dict

Get model version details. Supported for CPD version >=4.7.0

Return type:

dict

The way to use me is:

>>> model.get_version()

get_name(self) → str

Returns model name

Returns:

Model name

Return type:

str

Example,:

model.get_name()

get_id(self) → str

Returns model ID

Returns:

Model ID

Return type:

str

Example,:

model.get_id()

get_container_id(self) → str

Returns model container ID

Returns:

Model container ID

Return type:

str

Example,:

model.get_container_id()

get_container_type(self) → str

Returns model container type

Returns:

Model container type

Return type:

str

Example,:

model.get_container_type()

get_description(self) → str

Returns model description

Returns:

Model description

Return type:

str

Example,:

model.get_description()