ibm-watson-machine-learning
¶This notebook demonstrates how to deploy in Watson Machine Learning service a python function with statsmodel
which requires to create custom software specification using conda yaml file with all required libraries.
Some familiarity with bash is helpful. This notebook uses Python 3 with statsmodel.
The learning goals of this notebook are:
This notebook contains the following parts:
Before you use the sample code in this notebook, you must perform the following setup tasks:
Authenticate the Watson Machine Learning service on IBM Cloud. You need to provide platform api_key
and instance location
.
You can use IBM Cloud CLI to retrieve platform API Key and instance location.
API Key can be generated in the following way:
ibmcloud login
ibmcloud iam api-key-create API_KEY_NAME
In result, get the value of api_key
from the output.
Location of your WML instance can be retrieved in the following way:
ibmcloud login --apikey API_KEY -a https://cloud.ibm.com
ibmcloud resource service-instance WML_INSTANCE_NAME
In result, get the value of location
from the output.
Tip: Your Cloud API key
can be generated by going to the Users section of the Cloud console. From that page, click your name, scroll down to the API Keys section, and click Create an IBM Cloud API key. Give your key a name and click Create, then copy the created key and paste it below. You can also get a service specific url by going to the Endpoint URLs section of the Watson Machine Learning docs. You can check your instance location in your Watson Machine Learning (WML) Service instance details.
You can also get service specific apikey by going to the Service IDs section of the Cloud Console. From that page, click Create, then copy the created key and paste it below.
Action: Enter your api_key
and location
in the following cell.
api_key = 'PASTE YOUR PLATFORM API KEY HERE'
location = 'PASTE YOUR INSTANCE LOCATION HERE'
wml_credentials = {
"apikey": api_key,
"url": 'https://' + location + '.ml.cloud.ibm.com'
}
!pip install -U ibm-watson-machine-learning
from ibm_watson_machine_learning import APIClient
client = APIClient(wml_credentials)
First, create a space that will be used for your work. If you do not have space already created, you can use Deployment Spaces Dashboard to create one.
space_id
and paste it belowTip: You can also use SDK to prepare the space for your work. More information can be found here.
Action: Assign space ID below
space_id = 'PASTE YOUR SPACE ID HERE'
You can use list
method to print all existing spaces.
client.spaces.list(limit=10)
To be able to interact with all resources available in Watson Machine Learning, you need to set space which you will be using.
client.set.default_space(space_id)
In this section you will learn how to create deployable function
with statsmodels module calculating describition of a given data.
Hint: To install statsmodels execute !pip install statsmodels
.
def deployable_callable():
"""
Deployable python function with score
function implemented.
"""
try:
from statsmodels.stats.descriptivestats import describe
except ModuleNotFoundError as e:
print(f"statsmodels not installed: {str(e)}")
def score(payload):
"""
Score method.
"""
try:
data = payload['input_data'][0]['values']
return {
'predictions': [
{'values': str(describe(data))}
]
}
except Exception as e:
return {'predictions': [{'values': [repr(e)]}]}
return score
Hint: To install numpy execute !pip install numpy
.
import numpy as np
data = np.random.randn(10, 10)
data_description = deployable_callable()({
"input_data": [{
"values" : data
}]
})
print(data_description["predictions"][0]["values"])
In this section you will learn how to upload the python function to the Cloud.
Create new software specification based on default Python 3.8 environment extended by statsmodel package.
config_yml =\
"""name: python3
channels:
- empty
dependencies:
- pip:
- statsmodels
prefix: /opt/anaconda3/envs/python3
"""
with open("config.yaml", "w", encoding="utf-8") as f:
f.write(config_yml)
base_sw_spec_uid = client.software_specifications.get_uid_by_name("runtime-23.1-py3.10")
!cat config.yaml
config.yaml
file describes details of package extention. Now you need to store new package extention with APIClient.
meta_prop_pkg_extn = {
client.package_extensions.ConfigurationMetaNames.NAME: "statsmodels env",
client.package_extensions.ConfigurationMetaNames.DESCRIPTION: "Environment with statsmodels",
client.package_extensions.ConfigurationMetaNames.TYPE: "conda_yml"
}
pkg_extn_details = client.package_extensions.store(meta_props=meta_prop_pkg_extn, file_path="config.yaml")
pkg_extn_uid = client.package_extensions.get_uid(pkg_extn_details)
pkg_extn_url = client.package_extensions.get_href(pkg_extn_details)
meta_prop_sw_spec = {
client.software_specifications.ConfigurationMetaNames.NAME: "statsmodels software_spec",
client.software_specifications.ConfigurationMetaNames.DESCRIPTION: "Software specification for statsmodels",
client.software_specifications.ConfigurationMetaNames.BASE_SOFTWARE_SPECIFICATION: {"guid": base_sw_spec_uid}
}
sw_spec_details = client.software_specifications.store(meta_props=meta_prop_sw_spec)
sw_spec_uid = client.software_specifications.get_uid(sw_spec_details)
client.software_specifications.add_package_extension(sw_spec_uid, pkg_extn_uid)
client.software_specifications.get_details(sw_spec_uid)
meta_props = {
client.repository.FunctionMetaNames.NAME: "statsmodels function",
client.repository.FunctionMetaNames.SOFTWARE_SPEC_UID: sw_spec_uid
}
function_details = client.repository.store_function(meta_props=meta_props, function=deployable_callable)
function_uid = client.repository.get_function_uid(function_details)
client.repository.get_details(function_uid)
Note: You can see that function is successfully stored in Watson Machine Learning Service.
client.repository.list_functions()
You can use commands bellow to create online deployment for stored function (web service).
metadata = {
client.deployments.ConfigurationMetaNames.NAME: "Deployment of statsmodels function",
client.deployments.ConfigurationMetaNames.ONLINE: {}
}
function_deployment = client.deployments.create(function_uid, meta_props=metadata)
client.deployments.list()
Get deployment id.
deployment_id = client.deployments.get_uid(function_deployment)
print(deployment_id)
scoring_payload = {
"input_data": [{
'values': data
}]
}
predictions = client.deployments.score(deployment_id, scoring_payload)
print(data_description["predictions"][0]["values"])
If you want to clean up all created assets:
see the steps in this sample notebook.
You successfully completed this notebook! You learned how to use Watson Machine Learning for function deployment and scoring with custom software_spec.
Check out our Online Documentation for more samples, tutorials, documentation, how-tos, and blog posts.
Jan Sołtysik Intern in Watson Machine Learning.
Copyright © 2020, 2021, 2022 IBM. This notebook and its source code are released under the terms of the MIT License.