notice
This is unreleased documentation for Rasa Documentation Main/Unreleased version.
For the latest released documentation, see the latest version (3.x).
Installing Rasa Open Source
Install Rasa Open Source
- Ubuntu / macOS / Windows
First make sure your pip version is up to date:
To install Rasa Open Source:
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!
You can now create a new project with:
You can learn about the most important Rasa commands in the Command Line Interface.
Building from Source
If you want to use the development version of Rasa Open Source, you can get it from GitHub:
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
to install all needed dependencies for every configuration.
Python 3.10 requirements
If you are using Linux, installing rasa[full] could result in a failure while installing tokenizers and
cryptography.
In order to resolve it, you must follow these steps to install a Rust compiler:
After initializing the Rust compiler, you should restart the console and check its installation:
In case the PATH variable had not been automatically setup, run:
If you are using macOS, note that installing rasa[full] (either via pip or from source) could result in a failure
while installing tokenizers (issue described in depth here).
In order to resolve it, you must follow these steps to install a Rust compiler:
After initializing the Rust compiler, you should restart the console and check its installation:
In case the PATH variable had not been automatically setup, run:
Dependencies for spaCy
For more information on spaCy models, check out the spaCy docs.
You can install it with the following commands:
Using zsh?
In zsh, square brackets are interpreted as patterns on the command line.
To run commands with square brackets, you can either enclose the arguments
with square brackets in quotes, like pip3 install 'rasa[spacy]', or escape
the square brackets using backslashes, like pip3 install rasa\[spacy\].
We recommend using the former method (pip3 install 'rasa[spacy]') in our
documentation because it works as expected across any shell
This will install Rasa Open Source as well as spaCy and its language model
for the English language, but many other languages are available too.
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 likely reduce intent classification performance.
Dependencies for MITIE
First, run
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:
To download a specific version, specify the version number: