ibm_aigov_facts_client.factsheet.approaches module

class ApproachUtilities(assets_me_client: ModelUsecaseUtilities, approach_id: str = None, approach_name: str = None, approach_desc: str = None, approach_icon: str = None, approach_icon_color: str = None, versions: list = None, model_asset_id: str = None, model_container_type: str = None, model_container_id: str = None, op_id: str = None)

Bases: object

Approach utilities. Running client.assets.ai_usecase().get_approaches makes all methods in ApproachUtilities object available to use.

classmethod from_dict(_dict: Dict) → ApproachUtilities: Initialize a ApproachUtilities object from a json dictionary.

to_dict() → Dict: Return a json dictionary representing this approach.

get_info() → Dict

Get approach object details. Supported for CPD version >=4.7.0

Return type:: dict

The way to use me is:

>>> get_approach.get_info()

get_versions() → list

Returns list of WKC Model usecase approache versions. Supported for CPD version >=4.7.0

Returns:: All WKC Model usecase approache versions
Return type:: list

Example.:

ai_usecase.get_approach.get_versions()

set_name(name: str = None)

Returns WKC Model usecase updated approach. Supported for CPD version >=4.7.0

Parameters:: name (str) – New name for approach
Return type:: ApproachUtilities
Returns:: WKC Model usecase approache is updated

Example,:

ai_usecase.get_approach.set_name(name=<new approach name>)

set_description(description: str = None)

Returns WKC Model usecase updated approach. Supported for CPD version >=4.7.0

Parameters:: description (str) – New description for approach
Return type:: ApproachUtilities
Returns:: WKC Model usecase approache is updated

Example,:

ai_usecase.get_approach.set_description(description=<new approach description>)

set_op_id_for_model_group(op_id)

Returns updated approach with model group OP ID. Supported for CPD version >=4.7.0

Parameters:: set_op_id_for_model_group (str) – New model group op ID for approach
Return type:: ApproachUtilities

Example:

approach.set_op_id_for_model_group(op_id=<new op ID>)

get_name() → str

Returns model approach name

Returns:: Model approach name
Return type:: str

Example,:

ai_usecase.get_approach.get_name()

get_id() → str

Returns approach ID

Returns:: Approach ID
Return type:: str

Example,:

ai_usecase.get_approach.get_id()

get_description() → str

Returns approach description

Returns:: Approach description
Return type:: str

Example,:

ai_usecase.get_approach.get_description()

get_model_useacse_id() → str

Returns model usecase asset ID to which approach is defined

Returns:: Model usecase asset ID to which approach is defined
Return type:: str

Example,:

model_usecase.get_approach.get_model_useacse_id()

get_model_usecase_container_type() → str

Returns model usecase container type to which approach is defined

Returns:: Model usecase container type to which approach is defined
Return type:: str

Example,:

model_usecase.get_approach.get_model_usecase_container_type()

get_model_usecase_container_id() → str

Returns model usecase container ID to which approach is defined

Returns:: Model usecase container ID to which approach is defined
Return type:: str

Example,:

model_usecase.get_approach.get_model_usecase_container_id()