RasaHQ/rasa


💬 Open source machine learning framework to automate text- and voice-based conversations: NLU, dialogue management, connect to Slack, Facebook, and more - Create chatbots and voice assistants

https://rasa.com/docs/

License: Apache-2.0

Language: Python

Keywords: bot, bot-framework, botkit, bots, chatbot, chatbots, chatbots-framework, conversational-agents, conversational-ai, conversational-bots, luis, machine-learning, machine-learning-library, mitie, natural-language-processing, nlp, nlu, rasa, spacy, wit


Rasa Open Source

Join the chat on Rasa Community Forum PyPI version Supported Python Versions Build Status Coverage Status Documentation Status FOSSA Status PRs Welcome

Rasa is an open source machine learning framework to automate text-and voice-based conversations. With Rasa, you can build contexual assistants on:

  • Facebook Messenger
  • Slack
  • 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. You can find more information about how to contribute to Rasa (in lots of different ways!) here.

To contribute via pull request, follow these steps:

  1. Create an issue describing the feature you want to work on (or have a look at the contributor board)
  2. Write your code, tests and documentation, and format them with black
  3. Create a pull request describing your changes

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

Running and changing the documentation

To build & edit the docs, first install all necessary dependencies:

pip3 install -r requirements-dev.txt
pip3 install -r requirements-docs.txt

After the installation has finished, you can run and view the documentation locally using:

make livedocs

Visit the local version of the docs at http://localhost:8000 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:

export PIP_USE_PEP517=false
pip3 install -r requirements-dev.txt
pip3 install -e .
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.

Steps to release a new version

Releasing a new version is quite simple, as the packages are build and distributed by travis.

Terminology:

  • patch release (third version part increases): 1.1.2 -> 1.1.3
  • minor release (second version part increases): 1.1.3 -> 1.2.0
  • major release (first version part increases): 1.2.0 -> 2.0.0

Release steps:

  1. Make sure all dependencies are up to date (especially Rasa SDK)
  2. Switch to the branch you want to cut the release from (master in case of a major / minor, the current feature branch for patch releases)
  3. Run make release
  4. Create a PR against master or the release branch (e.g. 1.2.x)
  5. Once your PR is merged, tag a new release (this SHOULD always happen on master or release branches), e.g. using
    git tag 1.2.0 -m "next release"
    git push origin 1.2.0
    travis will build this tag and push a package to pypi
  6. If this is a minor release, a new release branch should be created pointing to the same commit as the tag to allow for future patch releases, e.g.
    git checkout -b 1.2.x
    git push origin 1.2.x

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, travis 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 pip install -r requirements-dev.txt. To reformat files execute

make formatter

Type Checking

If you want to check types on the codebase, install pytype using pip install -r requirements-dev.txt. To check the types execute

make types

Deploying documentation updates

We use sphinx-versioning to build docs for tagged versions and for the master branch. The static site that gets built is pushed to the docs branch of this repo, which doesn't contain any code, only the site.

We host the site on netlify. On master branch builds (see .travis.yml), we push the built docs to the docs branch. Netlify automatically re-deploys the docs pages whenever there is a change to that branch.

License

Licensed under the Apache License, Version 2.0. Copyright 2020 Rasa Technologies GmbH. Copy of the license.

A list of the Licenses of the dependencies of the project can be found at the bottom of the Libraries Summary.

Project Statistics

Sourcerank 11
Repository Size 839 MB
Stars 8,472
Forks 2,725
Watchers 327
Open issues 326
Dependencies 121
Contributors 311
Tags 261
Created
Last updated
Last pushed

Top Contributors See all

Tom Bocklisch Tobias Wochinger Tanja Ghostvv Alan Nichol ricwo Ella Rohm-Ensing Akela Drissner-Schmid Tom Metcalfe imLew Amogh Mannekote Federico Tedin Daksh Varshneya Johannes E. M. Mosig Brian Hopkins PHLF EPedrotti Tyler Hughes Thomas Werkmeister paulaWesselmann

Packages Referencing this Repo

rasa-hydra
Forked from the open source machine learning framework, Rasa
Latest release 2.2.4 - Updated - 8.47K stars
rasa
Open source machine learning framework to automate text- and voice-based conversations: NLU, dial...
Latest release 1.10.1 - Updated - 8.47K stars
botsfact
Open source machine learning framework to automate text- and voice-based conversations: NLU, dial...
Latest release 1.8.1 - Published - 8.47K stars
proj-cdg
Open source machine learning framework to automate text- and voice-based conversations: NLU, dial...
Latest release 1.8.1 - Published - 8.47K stars
rasafou
Open source machine learning framework to automate text- and voice-based conversations: NLU, dial...
Latest release 1.7.49 - Updated - 8.47K stars
botsfactory
Open source machine learning framework to automate text- and voice-based conversations: NLU, dial...
Latest release 1.6.0 - Published - 8.47K stars
botsf
Open source machine learning framework to automate text- and voice-based conversations: NLU, dial...
Latest release 1.6.0 - Published - 8.47K stars
kdrasa
dialogue manager for enterprise
Latest release 0.3.10 - Updated - 8.47K stars
rasa-x
Rasa X placeholder package
Latest release 0.0.2 - Updated - 8.47K stars

Recent Tags See all

1.10.1 May 15, 2020
1.10.0 April 28, 2020
1.9.7 April 23, 2020
1.10.0-alpha2 April 22, 2020
1.9.6 April 15, 2020
1.10.0-alpha1 April 06, 2020
1.9.5 April 02, 2020
1.9.4 March 30, 2020
1.8.3 March 27, 2020
1.9.3 March 27, 2020
1.9.2 March 26, 2020
1.9.1 March 25, 2020
1.9.0 March 24, 2020
1.8.2 March 19, 2020
1.8.1 March 06, 2020

Interesting Forks See all

btotharye/rasa
💬 Open source machine learning framework to automate text- and voice-based conversations: NLU, di...
Apache-2.0 - Last pushed - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2020-02-11 16:17:30 UTC

Login to resync this repository