github.com/RasaHQ/rasa @3.7.0b2 sqlite
README
Rasa Open Source
💡 We're migrating issues to Jira 💡
Starting January 2023, issues for Rasa Open Source are located in this Jira board. You can browse issues without being logged in; if you want to create issues, you'll need to create a Jira account.
Rasa is an open source machine learning framework to automate text and voice-based conversations. With Rasa, you can build contextual assistants on: - Facebook Messenger - Slack - Google Hangouts - Webex Teams - Microsoft Bot Framework - Rocket.Chat - Mattermost - Telegram - Twilio - Your own custom conversational channels
or voice assistants as: - Alexa Skills - Google Home Actions
Rasa helps you build contextual assistants capable of having layered conversations with lots of back-and-forth. In order for a human to have a meaningful exchange with a contextual assistant, the assistant needs to be able to use context to build on things that were previously discussed – Rasa enables you to build assistants that can do this in a scalable way.
There's a lot more background information in this blog post.
Where to get help
There is extensive documentation in the Rasa Docs. Make sure to select the correct version so you are looking at the docs for the version you installed.
Please use Rasa Community Forum for quick answers to questions.
README Contents:
How to contribute
We are very happy to receive and merge your contributions into this repository!
To contribute via pull request, follow these steps:
- Create an issue describing the feature you want to work on (or have a look at the contributor board)
- Write your code, tests and documentation, and format them with
black - Create a pull request describing your changes
For more detailed instructions on how to contribute code, check out these code contributor guidelines.
You can find more information about how to contribute to Rasa (in lots of different ways!) on our website..
Your pull request will be reviewed by a maintainer, who will get back to you about any necessary changes or questions. You will also be asked to sign a Contributor License Agreement.
Development Internals
Installing Poetry
Rasa uses Poetry for packaging and dependency management. If you want to build it from source, you have to install Poetry first. Please follow the official guide to see all possible options.
To update an existing poetry version to the version, currently used in rasa, run:
poetry self update <version>
Managing environments
The official Poetry guide suggests to use pyenv or any other similar tool to easily switch between Python versions. This is how it can be done:
pyenv install 3.10.10
pyenv local 3.10.10 # Activate Python 3.10.10 for the current project
Note: If you have trouble installing a specific version of python on your system it might be worth trying other supported versions.
By default, Poetry will try to use the currently activated Python version to create the virtual environment for the current project automatically. You can also create and activate a virtual environment manually — in this case, Poetry should pick it up and use it to install the dependencies. For example:
python -m venv .venv
source .venv/bin/activate
You can make sure that the environment is picked up by executing
poetry env info
Building from source
To install dependencies and rasa itself in editable mode execute
make install
Note for macOS users: under macOS Big Sur we've seen some compiler issues for
dependencies. Using export SYSTEM_VERSION_COMPAT=1 before the installation helped.
Installing optional dependencies
In order to install rasa's optional dependencies, you need to run:
make install-full
Note for macOS users: The command make install-full 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:
brew install rustup
rustup-init
After initialising the Rust compiler, you should restart the console and check its installation:
rustc --version
In case the PATH variable had not been automatically setup, run:
export PATH="$HOME/.cargo/bin:$PATH"
Running and changing the documentation
First of all, install all the required dependencies:
make install install-docs
After the installation has finished, you can run and view the documentation locally using:
make livedocs
It should open a new tab with the local version of the docs in your browser; if not, visit http://localhost:3000 in your browser. You can now change the docs locally and the web page will automatically reload and apply your changes.
Running the Tests
In order to run the tests, make sure that you have the development requirements installed:
make prepare-tests-ubuntu # Only on Ubuntu and Debian based systems
make prepare-tests-macos # Only on macOS
Then, run the tests:
make test
They can also be run at multiple jobs to save some time:
JOBS=[n] make test
Where [n] is the number of jobs desired. If omitted, [n] will be automatically chosen by pytest.
Running the Integration Tests
In order to run the integration tests, make sure that you have the development requirements installed:
make prepare-tests-ubuntu # Only on Ubuntu and Debian based systems
make prepare-tests-macos # Only on macOS
Then, you'll need to start services with the following command which uses Docker Compose:
make run-integration-containers
Finally, you can run the integration tests like this:
make test-integration
Resolving merge conflicts
Poetry doesn't include any solution that can help to resolve merge conflicts in
the lock file poetry.lock by default.
However, there is a great tool called poetry-merge-lock.
Here is how you can install it:
pip install poetry-merge-lock
Just execute this command to resolve merge conflicts in poetry.lock automatically:
poetry-merge-lock
Build a Docker image locally
In order to build a Docker image on your local machine execute the following command:
make build-docker
The Docker image is available on your local machine as rasa:localdev.
Code Style
To ensure a standardized code style we use the formatter black. To ensure our type annotations are correct we use the type checker pytype. If your code is not formatted properly or doesn't type check, GitHub will fail to build.
Formatting
If you want to automatically format your code on every commit, you can use pre-commit.
Just install it via pip install pre-commit and execute pre-commit install in the root folder.
This will add a hook to the repository, which reformats files on every commit.
If you want to set it up manually, install black via poetry install.
To reformat files execute
make formatter
Type Checking
If you want to check types on the codebase, install mypy using poetry install.
To check the types execute
make types
Deploying documentation updates
We use Docusaurus v2 to build docs for tagged versions and for the main branch.
To run Docusaurus, install Node.js 12.x.
The static site that gets built is pushed to the documentation branch of this repo.
We host the site on netlify. On main branch builds (see .github/workflows/documentation.yml), we push the built docs to
the documentation branch. Netlify automatically re-deploys the docs pages whenever there is a change to that branch.
Releases
Rasa has implemented robust policies governing version naming, as well as release pace for major, minor, and patch releases.
The values for a given version number (MAJOR.MINOR.PATCH) are incremented as follows: - MAJOR version for incompatible API changes or other breaking changes. - MINOR version for functionality added in a backward compatible manner. - PATCH version for backward compatible bug fixes.
The following table describes the version types and their expected release cadence:
| Version Type | Description | Target Cadence |
|---|---|---|
| Major | For significant changes, or when any backward-incompatible changes are introduced to the API or data model. | Every 1 - 2 yrs |
| Minor | For when new backward-compatible functionality is introduced, a minor feature is introduced, or when a set of smaller features is rolled out. | +/- Quarterly |
| Patch | For backward-compatible bug fixes that fix incorrect behavior. | As needed |
While this table represents our target release frequency, we reserve the right to modify it based on changing market conditions and technical requirements.
Maintenance Policy
Our End of Life policy defines how long a given release is considered supported, as well as how long a release is considered to be still in active development or maintenance.
The maintentance duration and end of life for every release are shown on our website as part of the Product Release and Maintenance Policy.
Cutting a Major / Minor release
A week before release day
- Make sure the milestone already exists and is scheduled for the correct date.
- Take a look at the issues & PRs that are in the milestone: does it look about right for the release highlights we are planning to ship? Does it look like anything is missing? Don't worry about being aware of every PR that should be in, but it's useful to take a moment to evaluate what's assigned to the milestone.
- Post a message on the engineering Slack channel, letting the team know you'll be the one cutting the upcoming
release, as well as:
- Providing the link to the appropriate milestone
- Reminding everyone to go over their issues and PRs and please assign them to the milestone
- Reminding everyone of the scheduled date for the release
A day before release day
- Go over the milestone and evaluate the status of any PR merging that's happening. Follow up with people on their bugs and fixes. If the release introduces new bugs or regressions that can't be fixed in time, we should discuss on Slac