ibm_aigov_facts_client.factsheet.factsheet_utility module

class FactSheetElements(api_key=None, cp4d_details: CloudPakforDataConfig = None)

Bases: object

Factsheet elements

Parameters:

  • api_key (str) – (Optional) IBM Cloud API key.

  • cloud_pak_for_data_configs (CloudPakforDataConfig) – (Optional) Cloud pak for data cluster details.

replace_asset_properties(csvFilePath, type_name=None, overwrite=True)

Warning

ibm_aigov_facts_client.factsheet.factsheet_utility.FactSheetElements.replace_asset_properties is deprecated. This method will be removed in a future release.Use client.assets.create_custom_facts_definitions() instead.

Utility to add custom asset properties of model or model usecase.

Parameters:

  • csvFilePath (str) – File path of csv having the asset properties.

  • type_name (str) – Asset type user needs to update. Current options are modelfacts_user and model_entry_user. Default is set to modelfacts_user.

  • overwrite (bool) – (Optional) Merge or replace current properties. Default is True.

A way you might use me is:

For IBM Cloud:

>>> from ibm_aigov_facts_client import FactSheetElements
>>> client = FactSheetElements(api_key=API_KEY)
>>> client.replace_asset_properties("Asset_type_definition.csv")
>>> client.replace_asset_properties("Asset_type_definition.csv",type_name="model_entry_user", overwrite=False)

For Cloud Pak for Data:

>>> from ibm_aigov_facts_client import FactSheetElements
>>> client = FactSheetElements(cp4d_details=<CPD credentials>)
>>> client.replace_asset_properties("Asset_type_definition.csv")
>>> client.replace_asset_properties("Asset_type_definition.csv",type_name="model_entry_user", overwrite=False)
register_model_entry(model_entry_props: ModelEntryProps)

Warning

ibm_aigov_facts_client.factsheet.factsheet_utility.FactSheetElements.register_model_entry is deprecated. This method will be removed in a future release.Use client.assets.get_model().add_tracking_model_usecase() instead.

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

Parameters:

mdoel_entry_props (ModelEntryProps) – Properties about model asset and model usecase catalog.

For IBM Cloud:

>>> from ibm_aigov_facts_client import FactSheetElements
>>> from ibm_aigov_facts_client.supporting_classes.factsheet_utils import ModelEntryProps
>>> client = FactSheetElements(api_key=API_KEY)

For new model usecase:

>>> props=ModelEntryProps(
            model_entry_catalog_id=<catalog_id>,
            asset_id=<model_asset_id>,
            model_entry_name=<name>,
            model_entry_desc=<description>,
            project_id=<project_id>
            )

>>> client.register_model_entry(model_entry_props=props)

For linking to existing model usecase:

>>> props=ModelEntryProps(
            asset_id=<model_asset_id>,
            model_entry_catalog_id=<catalog_id>,
            model_entry_id=<model_entry_id to link>,
            space_id_id=<space_id>
            )

>>> client.register_model_entry(model_entry_props=props)

For CPD, initialization changes only:

>>> from ibm_aigov_facts_client import FactSheetElements
>>> from ibm_aigov_facts_client.supporting_classes.factsheet_utils import CloudPakforDataConfig
>>> creds=CloudPakforDataConfig(service_url=<host url>,username=<user name>,password=<password>)
>>> client = FactSheetElements(cp4d_details=creds)
unregister_model_entry(asset_id, catalog_id=None, project_id=None, space_id=None)

Warning

ibm_aigov_facts_client.factsheet.factsheet_utility.FactSheetElements.unregister_model_entry is deprecated. This method will be removed in a future release.Use client.assets.get_model().remove_tracking_model_usecase() instead.

Unregister WKC Model Usecase

Parameters:

  • asset_id (str) – WKC model usecase id

  • catalog_id (str) – (Optional) Catalog ID where asset is stored

  • project_id (str) – (Optional) Project ID where the model exist

  • space_id (str) – (Optional) Space ID where model exist

Example for IBM Cloud or CPD:

>>> client.unregister_model_entry(asset_id=<model id>,project_id=<cpd_project_id>)
>>> client.unregister_model_entry(asset_id=<model id>,space_id=<cpd_space_id>)
>>> client.unregister_model_entry(asset_id=<model id>,catalog_id=<catalog_id>)
list_model_entries(catalog_id=None) → Dict

Warning

ibm_aigov_facts_client.factsheet.factsheet_utility.FactSheetElements.list_model_entries is deprecated. This method will be removed in a future release.Use client.assets.list_model_usecases() instead.

Returns all WKC Model Usecase assets for a catalog

Parameters:

catalog_id (str) – (Optional) Catalog ID where you want to register model, if None list from all catalogs

Returns:

All WKC Model Usecase assets for a catalog

Return type:

dict

Example:

>>> client = FactSheetElements(cp4d_details=creds) or client = FactSheetElements(api_key=API_KEY)
>>> client.list_model_entries()
>>> client.list_model_entries(catalog_id=<catalog_id>)