# (C) Copyright IBM Corp. 2021.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import print_function
import ibm_watson_machine_learning._wrappers.requests as requests
from ibm_watson_machine_learning.utils import SPACES_DETAILS_TYPE, INSTANCE_DETAILS_TYPE, MEMBER_DETAILS_TYPE,HW_SPEC_DETAILS_TYPE, STR_TYPE, STR_TYPE_NAME, docstring_parameter, meta_props_str_conv, str_type_conv, get_file_from_cos
from ibm_watson_machine_learning.metanames import HwSpecMetaNames
from ibm_watson_machine_learning.wml_resource import WMLResource
from ibm_watson_machine_learning.wml_client_error import WMLClientError, ApiRequestFailure
import os,json
_DEFAULT_LIST_LENGTH = 50
[docs]class HwSpec(WMLResource):
"""
Store and manage your hardware specs.
"""
ConfigurationMetaNames = HwSpecMetaNames()
"""MetaNames for Hardware Specification."""
def __init__(self, client):
WMLResource.__init__(self, __name__, client)
self._ICP = client.ICP
[docs] @docstring_parameter({'str_type': STR_TYPE_NAME})
def get_details(self, hw_spec_uid):
"""
Get hardware specification details.
**Parameters**
.. important::
**hw_spec_uid** : Unique id of the hardware spec
** type**: str
**Output**
.. important::
**returns**: Metadata of the hardware specifications\n
**return type**: dict\n
**Example**
>>> hw_spec_details = client.hardware_specifications.get_details(hw_spec_uid)
"""
HwSpec._validate_type(hw_spec_uid, u'hw_spec_uid', STR_TYPE, 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)
# Creation of new hardware specs is not required at the moment because WML does not support it
# @docstring_parameter({'str_type': STR_TYPE_NAME})
# def store(self, meta_props):
# """
# Create a space.
#
# **Parameters**
#
# .. important::
# #. **meta_props**: meta data of the space configuration. To see available meta names use:\n
# >>> client.hardware_specifications.ConfigurationMetaNames.get()
#
# **type**: dict\n
#
# **Output**
#
# .. important::
#
# **returns**: metadata of the stored space\n
# **return type**: dict\n
#
# **Example**
#
# >>> meta_props = {
# >>> client.hardware_specifications.ConfigurationMetaNames.NAME: "skl_pipeline_heart_problem_prediction",
# >>> client.hardware_specifications.ConfigurationMetaNames.DESCRIPTION: "description scikit-learn_0.20",
# >>> client.hardware_specifications.ConfigurationMetaNames.HARDWARE_CONFIGURATIONS: {},
# >>> }
#
# """
#
# # quick support for COS credentials instead of local path
# # TODO add error handling and cleaning (remove the file)
# 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 new hw specs', creation_response)
#
# return hw_spec_details
[docs] def list(self, name=None):
"""
List hardware specifications.
**Parameters**
.. important::
**name** : Unique id of the hardware spec
** type**: str
**Output**
.. important::
This method only prints the list of all assets in a table format.\n
**return type**: None\n
**Example**
>>> 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]
self._list(hw_spec_values, [u'NAME', u"ID", u'DESCRIPTION'], None, _DEFAULT_LIST_LENGTH)
[docs] @staticmethod
@docstring_parameter({'str_type': STR_TYPE_NAME})
def get_id(hw_spec_details):
"""
Get ID of hardware specifications asset.
**Parameters**
.. important::
#. **asset_details**: Metadata of the hardware specifications \n
**type**: dict\n
**Output**
.. important::
**returns**: Unique Id of hardware specifications\n
**return type**: str\n
**Example**
>>> asset_uid = client.hardware_specifications.get_id(hw_spec_details)
"""
return HwSpec.get_uid(hw_spec_details)
[docs] @staticmethod
@docstring_parameter({'str_type': STR_TYPE_NAME})
def get_uid(hw_spec_details):
"""
Get UID of hardware specifications asset. Deprecated!! Use get_id(hw_spec_details) instead
**Parameters**
.. important::
#. **asset_details**: Metadata of the hardware specifications \n
**type**: dict\n
**Output**
.. important::
**returns**: Unique Id of hardware specifications\n
**return type**: str\n
**Example**
>>> 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
@docstring_parameter({'str_type': STR_TYPE_NAME})
def get_href(hw_spec_details):
"""
Get url of hardware specifications.
**Parameters**
.. important::
#. **hw_spec_details**: hardware specifications details\n
**type**: dict\n
**Output**
.. important::
**returns**: href of hardware specifications\n
**return type**: str\n
**Example**
>>> 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] @docstring_parameter({'str_type': STR_TYPE_NAME})
def get_id_by_name(self, hw_spec_name):
"""
Get Unique Id of hardware specification for the given name.
**Parameters**
.. important::
#. **hw_spec_name**: name of the hardware spec \n
**type**: str\n
**Output**
.. important::
**returns**: Unique Id of hardware specification \n
**return type**: str\n
**Example**
>>> asset_uid = client.hardware_specifications.get_id_by_name(hw_spec_name)
"""
return HwSpec.get_uid_by_name(self, hw_spec_name)
[docs] @docstring_parameter({'str_type': STR_TYPE_NAME})
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(self, hw_spec_name) instead
**Parameters**
.. important::
#. **hw_spec_name**: name of the hardware spec \n
**type**: str\n
**Output**
.. important::
**returns**: Unique Id of hardware specification \n
**return type**: str\n
**Example**
>>> asset_uid = client.hardware_specifications.get_uid_by_name(hw_spec_name)
"""
HwSpec._validate_type(hw_spec_name, u'hw_spec_name', STR_TYPE, 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"
# @docstring_parameter({'str_type': STR_TYPE_NAME})
# def delete(self, hw_spec_uid):
# """
# Delete a hardware specifications.
#
# **Parameters**
#
# .. important::
# #. **hw_spec_uid**: hardware specifications UID\n
# **type**: str\n
#
# **Output**
#
# .. important::
# **returns**: status ("SUCCESS" or "FAILED")\n
# **return type**: str\n
#
# **Example**
#
# >>> client.hw_spec.delete(hw_spec_uid)
# """
# HwSpec._validate_type(hw_spec_uid, u'hw_spec_uid', STR_TYPE, True)
#
# response = requests.delete(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(response.json())
# else:
# 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)
