Warning: This document is for an old version of Rasa. The latest version is 1.9.5.

Jupyter Notebooks

This page contains the most important methods for using Rasa in a Jupyter notebook.

You need to create a project if you don’t already have one. To do this, run:

rasa init --no-prompt

Now that you have a project, the relevant files and folders exist. Define some variables that contain these paths:

config = "config.yml"
training_files = "data/"
domain = "domain.yml"
output = "models/"

Train a Model

Now we can train a model by passing in the paths to the rasa.train function. Note that the training files are passed as a list. When training has finished, this returns the path where the trained model has been saved.

import rasa

model_path = rasa.train(domain, config, [training_files], output)

Chat with your assistant

To start chatting to an assistant, call the chat function, passing in the path to your saved model:

from rasa.jupyter import chat

Evaluate your model against test data

Rasa has a convenience function for getting your training data. Rasa’s get_core_nlu_directories is a convenience function which recursively finds all the stories and nlu data files in a directory, and copies them into two directories. The return values are the paths to these newly created directories.

import rasa.data as data
stories_directory, nlu_data_directory = data.get_core_nlu_directories(training_files)

To test your model, call the test function, passing in the path to your saved model and directories containing the stories and nlu data to evaluate on.

rasa.test(model_path, stories_directory, nlu_data_directory)

The results of the evaluation will be written to a file called results. This contains information about the accuracy of your model and other metrics.

ls results