yhjohn163 / assistant-improve-recommendations-notebook

Watson Assistant Recommendation Notebooks

This repository houses Watson Assistant notebooks with a set of data operation and visualization functions.

Introduction

To help improving your Watson Assistant after you have deployed it to production, we prepared the following two Jupyter notebooks. These notebooks include practical steps for measuring, analyzing, and actively improving your virtual assistant in a continuous manner. Check out IBM Watson Assistant Continuous Improvement Best Practices for more details.

Measure Notebook

The Measure notebook contains a set of automated metrics that help you monitor and understand the behavior of your system. The goal is to understand where your assistant is doing well vs where it isn’t, and to focus your improvement effort to one of the problem areas identified.

Effectiveness Notebook

The Effectiveness notebook helps you understand relative performance of each intent and entity as well as the confusion between your intents. This information helps you prioritize your improvement effort.

Getting Started

We provide two versions of the above notebooks Jupyter Notebook and Watson Studio Notebook.

• Jupyter Notebook

  1. Install Jupyter Notebook, see Jupyter/IPython Notebook Quick Start Guide for more details.

  2. Download the Jupyter notebooks available in this repository's notebook directory.

     • Measure Notebook.ipynb
     • Effectiveness Notebook.ipynb

     Note: These notebook files are not designed for Watson Studio environment

  3. Install dependencies with pip install -r requirements.txt

  4. Follow the instructions in each of the notebooks. Be sure to add your Watson Assistant credentials if necessary.

• Watson Studio Notebook

  1. Create a Watson Studio account.

     Sign up in Watson Studio, or use an existing account. Lite plan is free to use.

  2. Create a new project and add a Cloud Object Storage (COS) account.

     For more information regarding COS plans, see Pricing.

  3. Copy Measure or Effectiveness notebook from Watson Studio community into your project.

  4. Follow the instructions in each notebook to add project tokens and Watson Assistant credentials if necessary.

License

This library is licensed under the Apache 2.0 license.