Governing AI Assets

track(self, usecase: ModelUsecaseUtilities = None, approach: ApproachUtilities = None, grc_model: dict = None, version_number: str = None, version_comment: str = None)

Link Model to model use case. Model asset should be stored in either Project or Space and corrsponding ID should be provided when registering to model use case.

Supported for CPD version >=4.7.0

Parameters:

  • usecase (ModelUsecaseUtilities) – Instance of ModelUsecaseUtilities

  • approach (ApproachUtilities) – Instance of ApproachUtilities

  • grc_model (str) – (Optional) Openpages model id. Only applicable for CPD environments. This should be dictionary, output of get_grc_model()

  • version_number (str) – Version number of model. supports either a semantic versioning string or one of the following keywords for auto-incrementing based on the latest version in the approach: “patch”, “minor”, “major”

  • version_comment (str) – (Optional) An optional comment describing the changes made in this version

Return type:

ModelAssetUtilities

For tracking model with model usecase:

>>> model.track(usecase=<instance of ModelUsecaseUtilities>,approach=<instance of ApproachUtilities>,version_number=<version>)
get_tracking_model_usecase(self) → ModelUsecaseUtilities

Get model use case associated to the model.

Return type:

ModelUsecaseUtilities

A way you might use me is:

>>> model.get_tracking_model_usecase()
add_tracking_model_usecase(self, model_usecase_name: str = None, model_usecase_desc: str = None, model_usecase_id: str = None, model_usecase_catalog_id: str = None, grc_model_id: str = None)

Warning

ibm_aigov_facts_client.factsheet.asset_utils_model.ModelAssetUtilities.add_tracking_model_usecase is deprecated. This method will be removed in a future release.Use model.track() instead.

Link Model to model use case. Model asset should be stored in either Project or Space and corrsponding ID should be provided when registering to model use case.

Parameters:

  • model_usecase_name (str) – (Optional) New model use case name. Used only when creating new model use case.

  • model_usecase_desc (str) – (Optional) New model use case description. Used only when creating new model use case.

  • model_usecase_id (str) – (Optional) Existing model use case to link with.

  • model_usecase_catalog_id (str) – (Optional) Catalog ID where model use case exist.

  • grc_model_id (str) – (Optional) Openpages model id. Only applicable for CPD environments.

For new model use case:

>>> model.add_tracking_model_usecase(model_usecase_name=<name>,model_usecase_desc=<description>)

For linking to existing model use case:

>>> model.add_tracking_model_usecase(model_usecase_id=<model use case id to link with>,model_usecase_catalog_id=<model use case catalog id>)
remove_tracking_model_usecase(self)

Warning

ibm_aigov_facts_client.factsheet.asset_utils_model.ModelAssetUtilities.remove_tracking_model_usecase is deprecated. This method will be removed in a future release.Use model.untrack() instead.

Unregister from model use case

Example for IBM Cloud or CPD:

>>> model.remove_tracking_model_usecase()
untrack(self)

Unlink model from it’s usecase and approach

Example for IBM Cloud or CPD:

>>> model.untrack()
get_tracked_models(self) → list

Get models tracked in model use case

Returns:

physical model details for all models in model use case

Return type:

list[dict]

Note

The following section details methods related to OpenPages, offering specific functionalities and interactions within the OpenPages environment along with AI usecase

get_grc_models(self) → list

Returns list of WKC Models associated with Openpages for a particular model usecase

Returns:

All WKC Models associated with Openpages for a particular model usecase

Return type:

list()

Example,:

client.assets.model_usecase.get_grc_models()
get_grc_model(self, id: str = None)

Returns list WKC Model associated with Openpages for a particular model usecase

Returns:

WKC Model associated with Openpages for a particular model usecase

Return type:

dictionary

Example,:

client.assets.model_usecase.get_grc_model(id=<grc_model_id>)