(Optional) Monitoring models with OpenScale (Notebook)

There are several ways of configuring Watson OpenScale to monitor machine learning deployments, including the FastPath automatic configuration, using the GUI tool, a more manual configuration using the APIs, and some combintation of these. For this exercise we're going to configure our OpenScale service by running a Jupyter Notebook. This provides examples of using the OpenScale Python APIs programatically.

This lab is comprised of the following steps:

Note: The Jupyter notebook included in the project has been cleared of output. If you would like to see the notebook that has already been completed with output, it is hosted in the same repo as this workshop: Notebook with output: with-output/openscale-full-configuration-output.ipynb

1. Open the Notebook

If you Created the Project using the CreditRiskProject.zip file, your notebook will be present in that project.

  • Go the (☰) navigation menu and click on the Projects link and then click on your analytics project.

    (☰) Menu -> Projects

  • From your Project overview page, click on the Assets tab to open the assets page where your project assets are stored and organized.

  • Scroll down to the Notebooks section of the page and Click on the pencil icon at the right of the openscale-full-configuration notebook.

    Notebook Open

  • When the Jupyter notebook is loaded and the kernel is ready, we will be ready to start executing it in the next section.

    Notebook loaded

  • You may now skip to the next step Update credentials

Import the Notebook

NOTE: You should probably not need this step, and should only perform it if instructed to do so.

  • If, for some reason, you are not using the Created the Project step in the Pre-work to import CreditRiskProject.zip, then you will need to import the notebook file by itself. Use the following steps for that.

  • At the project overview click the New Asset button, and choose Add notebook.

  • On the next panel select the From URL tab, give your notebook a name, provide the following URL, and leave the default Python 3.6 environment:


    Add notebook name and URL

  • When the Jupyter notebook is loaded and the kernel is ready then we can start executing cells.

2. Update Credentials

  • In the notebook section 1.2 you edit the first code cell to use your Cloud Pak for Data platform credentials in the WOS_CREDENTIALS.

    • For the url, use the URL your cluster, i.e something like: "url": "https://zen.clusterid.us-south.containers.appdomain.cloud".

    • For the username, use your login username.

    • For the password, user your login password.

    Edite notebook credentials

3. Run the Notebook

Spend some time looking through the sections of the notebook to get an overview. A notebook is composed of text (markdown or heading) cells and code cells. The markdown cells provide comments on what the code is designed to do.

You will run cells individually by highlighting each cell, then either click the Run button at the top of the notebook or hitting the keyboard short cut to run the cell (Shift + Enter but can vary based on platform). While the cell is running, an asterisk ([*]) will show up to the left of the cell. When that cell has finished executing a sequential number will show up (i.e. [17]).

Please note that some of the comments in the notebook are directions for you to modify specific sections of the code. Perform any changes as indicated before running / executing the cell.

4. Get Transactions for Explainability

Under 8.9 Identify transactions for Explainability run the cell. It will produce a series of UIDs for indidvidual ML scoring transactions. Copy one or more of them to examine in the next section.


In this section we covered one of the approaches to configure Watson OpenScale to monitor a machine learning model on Cloud Pak for Data. We have seen:

  • How to build a model using Jupyter Notebook.

  • How to use the OpenScale Python APIs programatically.

  • How to configure all the monitors in OpenScale.

Important: Make sure that you stop the kernel of your notebook(s) when you are done, in order to conserve resources! You can do this by going to the Asset page of the project, selecting the three vertical dots under the Action column for the notebook you have been running (in this case the openscale-full-configuration) and selecting to Stop Kernel from the Actions menu. If you see a lock icon on the notebook, click it to unlock the notebook before you click the Actions menu so you can see the stop kernel option. Stop kernel