Version: Master/Unreleased

Installation

Quick Installation

Release candidate

This is the documentation for Rasa Open Source 2.0.0rc1. If you are looking for the production ready stable release, please head over to our 1.x documentation.

You can install Rasa Open Source using pip (requires Python 3.6, 3.7 or 3.8).

pip3 install rasa==2.0.0rc1

You are now ready to go! So what's next? You can create a new project by running

rasa init
Want to explore first?

You can explore Rasa Open Source online using our prototyper without any installation. At the end of the tutorial you can download the resulting assistant, install Rasa on your machine and continue development locally.

Prototype an Assistant

Step-by-step Installation Guide

Prefer following video instructions? Watch our installation series on Youtube, it explains the installation in walkthroughs for all major platforms.

1. Python Environment Setup

Check if your Python environment is already configured:

python3 --version
pip3 --version

If these packages are already installed, these commands should display version numbers for each step, and you can skip to the next step.

Otherwise, proceed with the instructions below to install them.

Fetch the relevant packages using apt, and install virtualenv using pip.

sudo apt update
sudo apt install python3-dev python3-pip

2. Virtual Environment Setup

This step is optional, but we strongly recommend isolating python projects using virtual environments. Tools like virtualenv and virtualenvwrapper provide isolated Python environments, which are cleaner than installing packages system-wide (as they prevent dependency conflicts). They also let you install packages without root privileges.

Create a new virtual environment by choosing a Python interpreter and making a ./venv directory to hold it:

python3 -m venv ./venv

Activate the virtual environment:

source ./venv/bin/activate

3. Install Rasa Open Source

First make sure your pip version is up to date:

pip3 install -U pip

To install Rasa Open Source:

pip3 install rasa
Telemetry reporting

When you run Rasa Open Source for the first time, you’ll see a message notifying you about anonymous usage data that is being collected. You can read more about how that data is pulled out and what it is used for in the telemetry documentation.

Congratulations! You have successfully installed Rasa Open Source!

Next step: Start prototyping your first assistant online and download it afterwards

Building from Source

If you want to use the development version of Rasa Open Source, you can get it from GitHub:

curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
git clone https://github.com/RasaHQ/rasa.git
cd rasa
poetry install

Additional Dependencies

For some machine learning algorithms you need to install additional python packages. They aren't installed by default to keep the footprint small.

The page on Tuning Your Model will help you pick the right configuration for your assistant and alert you to additional dependencies.

Just give me everything!

If you don't mind the additional dependencies lying around, you can use

pip3 install rasa[full]

to install all needed dependencies for every configuration.

Dependencies for spaCy

For more information on spaCy, check out the spaCy docs.

You can install it with the following commands:

pip3 install rasa[spacy]
python3 -m spacy download en_core_web_md
python3 -m spacy link en_core_web_md en

This will install Rasa Open Source as well as spaCy and its language model for the English language. We recommend using at least the “medium” sized models (_md) instead of the spaCy's default small en_core_web_sm model. Small models require less memory to run, but will somewhat reduce intent classification performance.

Dependencies for MITIE

First, run

pip3 install git+https://github.com/mit-nlp/MITIE.git
pip3 install rasa[mitie]

and then download the MITIE models. The file you need is total_word_feature_extractor.dat. Save this anywhere. If you want to use MITIE, you need to tell it where to find this file (in this example it was saved in the data folder of the project directory).

Upgrading Versions

To upgrade your installed version of Rasa Open Source to the latest version from PyPI:

pip install --upgrade rasa

To download a specific version, specify the version number:

pip install rasa==1.8.3