# -----------------------------------------------------------------------------------------
# (C) Copyright IBM Corp. 2020-2024.
# https://opensource.org/licenses/BSD-3-Clause
# -----------------------------------------------------------------------------------------
from __future__ import print_function
import json
import ibm_watson_machine_learning._wrappers.requests as requests
from ibm_watson_machine_learning.metanames import HwSpecMetaNames
from ibm_watson_machine_learning.utils import HW_SPEC_DETAILS_TYPE
from ibm_watson_machine_learning.wml_client_error import WMLClientError
from ibm_watson_machine_learning.wml_resource import WMLResource
_DEFAULT_LIST_LENGTH = 50
[docs]
class HwSpec(WMLResource):
"""Store and manage hardware specs."""
ConfigurationMetaNames = HwSpecMetaNames()
"""MetaNames for Hardware Specification."""
def __init__(self, client):
WMLResource.__init__(self, __name__, client)
self._ICP = client.ICP
[docs]
def get_details(self, hw_spec_uid):
"""Get hardware specification details.
:param hw_spec_uid: Unique id of the hardware spec
:type hw_spec_uid: str
:return: metadata of the hardware specifications
:rtype: dict
**Example**
.. code-block:: python
hw_spec_details = client.hardware_specifications.get_details(hw_spec_uid)
"""
HwSpec._validate_type(hw_spec_uid, u'hw_spec_uid', str, True)
if not self._ICP or self._client.ICP_PLATFORM_SPACES:
response = requests.get(self._client.service_instance._href_definitions.get_hw_spec_href(hw_spec_uid), params=self._client._params(skip_space_project_chk=True),
headers=self._client._get_headers())
else:
response = requests.get(self._client.service_instance._href_definitions.get_hw_spec_href(hw_spec_uid), params=self._client._params(),
headers=self._client._get_headers())
if response.status_code == 200:
return self._get_required_element_from_response(self._handle_response(200, u'get hardware spec details', response))
else:
return self._handle_response(200, u'get hardware spec details', response)
[docs]
def store(self, meta_props):
"""Create a hardware specification.
:type meta_props: dict
:return: metadata of the created hardware specification
:rtype: dict
**Example**
.. code-block:: python
meta_props = {
client.hardware_specifications.ConfigurationMetaNames.NAME: "custom hardware specification",
client.hardware_specifications.ConfigurationMetaNames.DESCRIPTION: "Custom hardware specification creted with SDK",
client.hardware_specifications.ConfigurationMetaNames.NODES:{"cpu":{"units":"2"},"mem":{"size":"128Gi"},"gpu":{"num_gpu":1}}
}
client.hardware_specifications.store(meta_props)
"""
HwSpec._validate_type(meta_props, u'meta_props', dict, True)
hw_spec_meta = self.ConfigurationMetaNames._generate_resource_metadata(
meta_props,
with_validation=True,
client=self._client)
hw_spec_meta_json = json.dumps(hw_spec_meta)
href = self._client.service_instance._href_definitions.get_hw_specs_href()
creation_response = requests.post(href, params=self._client._params(), headers=self._client._get_headers(), data=hw_spec_meta_json)
hw_spec_details = self._handle_response(201, u'creating hardware specification', creation_response)
return hw_spec_details
[docs]
def list(self, name=None, return_as_df=True):
"""Print hardware specifications in a table format.
:param name: Unique id of the hardware spec
:type name: str, optional
:param return_as_df: determinate if table should be returned as pandas.DataFrame object, default: True
:type return_as_df: bool, optional
:return: pandas.DataFrame with listed hardware specifications or None if return_as_df is False
:rtype: pandas.DataFrame or None
**Example**
.. code-block:: python
client.hardware_specifications.list()
"""
params = {}
if name is not None:
params.update({'name': name})
# Todo provide api to return
href = self._client.service_instance._href_definitions.get_hw_specs_href()
response = requests.get(href, params, headers=self._client._get_headers())
self._handle_response(200, u'list hw_specs', response)
asset_details = self._handle_response(200, u'list assets', response)["resources"]
hw_spec_values = [
(m[u'metadata'][u'name'], m[u'metadata'][u'asset_id'], m[u'metadata'][u'description']) for
m in asset_details]
table = self._list(hw_spec_values, [u'NAME', u"ID", u'DESCRIPTION'], None, _DEFAULT_LIST_LENGTH)
if return_as_df:
return table
[docs]
@staticmethod
def get_id(hw_spec_details):
"""Get ID of hardware specifications asset.
:param hw_spec_details: metadata of the hardware specifications
:type hw_spec_details: dict
:return: Unique Id of hardware specifications
:rtype: str
**Example**
.. code-block:: python
asset_uid = client.hardware_specifications.get_id(hw_spec_details)
"""
return HwSpec.get_uid(hw_spec_details)
[docs]
@staticmethod
def get_uid(hw_spec_details):
"""Get UID of hardware specifications asset.
*Deprecated:* Use ``get_id(hw_spec_details)`` instead.
:param hw_spec_details: metadata of the hardware specifications
:type hw_spec_details: dict
:return: Unique Id of hardware specifications
:rtype: str
**Example**
.. code-block:: python
asset_uid = client.hardware_specifications.get_uid(hw_spec_details)
"""
HwSpec._validate_type(hw_spec_details, u'hw_spec_details', object, True)
HwSpec._validate_type_of_details(hw_spec_details, HW_SPEC_DETAILS_TYPE)
return WMLResource._get_required_element_from_dict(hw_spec_details, u'hw_spec_details',
[u'metadata', u'asset_id'])
[docs]
@staticmethod
def get_href(hw_spec_details):
"""Get url of hardware specifications.
:param hw_spec_details: hardware specifications details
:type hw_spec_details: dict
:return: href of hardware specifications
:rtype: str
**Example**
.. code-block:: python
hw_spec_details = client.hw_spec.get_details(hw_spec_uid)
hw_spec_href = client.hw_spec.get_href(hw_spec_details)
"""
HwSpec._validate_type(hw_spec_details, u'hw_spec_details', object, True)
HwSpec._validate_type_of_details(hw_spec_details, HW_SPEC_DETAILS_TYPE)
return WMLResource._get_required_element_from_dict(hw_spec_details, u'hw_spec_details', [u'metadata', u'href'])
[docs]
def get_id_by_name(self, hw_spec_name):
"""Get Unique Id of hardware specification for the given name.
:param hw_spec_name: name of the hardware spec
:type hw_spec_name: str
:return: Unique Id of hardware specification
:rtype: str
**Example**
.. code-block:: python
asset_uid = client.hardware_specifications.get_id_by_name(hw_spec_name)
"""
return HwSpec.get_uid_by_name(self, hw_spec_name)
[docs]
def get_uid_by_name(self, hw_spec_name):
"""Get Unique Id of hardware specification for the given name.
*Deprecated:* Use ``get_id_by_name(hw_spec_name)`` instead.
:param hw_spec_name: name of the hardware spec
:type hw_spec_name: str
:return: Unique Id of hardware specification
:rtype: str
**Example**
.. code-block:: python
asset_uid = client.hardware_specifications.get_uid_by_name(hw_spec_name)
"""
HwSpec._validate_type(hw_spec_name, u'hw_spec_name', str, True)
parameters = self._client._params(skip_space_project_chk=True)
parameters.update(name=hw_spec_name)
response = requests.get(self._client.service_instance._href_definitions.get_hw_specs_href(),
params=parameters,
headers=self._client._get_headers())
if response.status_code == 200:
total_values = self._handle_response(200, u'list assets', response)["total_results"]
if total_values != 0:
hw_spec_details = self._handle_response(200, u'list assets', response)["resources"]
return hw_spec_details[0][u'metadata'][u'asset_id']
else:
return "Not Found"
[docs]
def delete(self, hw_spec_id: str):
"""Delete a hardware specifications.
:param hw_spec_id: Unique Id of hardware specification which should be deleted
:type hw_spec_id: str
:return: status ("SUCCESS" or "FAILED")
:rtype: str
"""
HwSpec._validate_type(hw_spec_id, u'hw_spec_id', str, True)
response = requests.delete(self._client.service_instance._href_definitions.get_hw_spec_href(hw_spec_id), params=self._client._params(),
headers=self._client._get_headers())
return self._handle_response(204, u'delete hardware specification', response)
def _get_required_element_from_response(self, response_data):
WMLResource._validate_type(response_data, u'hw_spec_response', dict)
try:
if self._client.default_space_id is not None:
new_el = {'metadata': {
'name': response_data['metadata']['name'],
'asset_id': response_data['metadata']['asset_id'],
'href': response_data['metadata']['href'],
'asset_type': response_data['metadata']['asset_type'],
'created_at': response_data['metadata']['created_at']
#'updated_at': response_data['metadata']['updated_at']
},
'entity': response_data['entity']
}
elif self._client.default_project_id is not None:
if self._client.WSD:
new_el = {'metadata': {
'name': response_data['metadata']['name'],
'asset_id': response_data['metadata']['asset_id'],
'href': response_data['metadata']['href'],
'asset_type': response_data['metadata']['asset_type'],
'created_at': response_data['metadata']['created_at']
},
'entity': response_data['entity']
}
else:
new_el = {'metadata': {
'name': response_data['metadata']['name'],
'asset_id': response_data['metadata']['asset_id'],
'href': response_data['metadata']['href'],
'asset_type': response_data['metadata']['asset_type'],
'created_at': response_data['metadata']['created_at']
},
'entity': response_data['entity']
}
else:
# For system hardware spec
new_el = {'metadata': {
'name': response_data['metadata']['name'],
'asset_id': response_data['metadata']['asset_id'],
'href': response_data['metadata']['href'],
'asset_type': response_data['metadata']['asset_type'],
'created_at': response_data['metadata']['created_at']
#'updated_at': response_data['metadata']['updated_at']
},
'entity': response_data['entity']
}
if (self._client.CLOUD_PLATFORM_SPACES or self._client.ICP_PLATFORM_SPACES) and 'href' in response_data['metadata']:
href_without_host = response_data['metadata']['href'].split('.com')[-1]
new_el[u'metadata'].update({'href': href_without_host})
return new_el
except Exception as e:
raise WMLClientError("Failed to read Response from down-stream service: " + response_data.text)