You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.rst
+18Lines changed: 18 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,6 +17,24 @@ This project adheres to `Semantic Versioning`_ starting with version 1.0.
17
17
18
18
.. towncrier release notes start
19
19
20
+
[1.7.1] - 2020-02-11
21
+
^^^^^^^^^^^^^^^^^^^^
22
+
23
+
Bugfixes
24
+
--------
25
+
- `#5106 <https://github.com/rasahq/rasa/issues/5106>`_: Fixed file loading of non proper UTF-8 story files, failing properly when checking for
26
+
story files.
27
+
- `#5162 <https://github.com/rasahq/rasa/issues/5162>`_: Fix problem with multi-intents.
28
+
Training with multi-intents using the ``CountVectorsFeaturizer`` together with ``EmbeddingIntentClassifier`` is
29
+
working again.
30
+
- `#5171 <https://github.com/rasahq/rasa/issues/5171>`_: Fix bug ``ValueError: Cannot concatenate sparse features as sequence dimension does not match``.
31
+
32
+
When training a Rasa model that contains responses for just some of the intents, training was failing.
33
+
Fixed the featurizers to return a consistent feature vector in case no response was given for a specific message.
34
+
- `#5199 <https://github.com/rasahq/rasa/issues/5199>`_: If no text features are present in ``EmbeddingIntentClassifier`` return the intent ``None``.
35
+
- `#5216 <https://github.com/rasahq/rasa/issues/5216>`_: Resolve version conflicts: Pin version of cloudpickle to ~=1.2.0.
Copy file name to clipboardExpand all lines: docs/user-guide/how-to-deploy.rst
+68-25Lines changed: 68 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,64 @@
1
-
:desc: Run and ship your Rasa assistant with Docker containers on any
2
-
Docker-compatible machine or cluster.
1
+
:desc: How to deploy your Rasa Assistant with Docker Compose or Kubernetes/Openshift
3
2
4
-
.. _running-rasa-with-docker:
3
+
.. _deploying-your-rasa-assistant:
5
4
6
-
Running Rasa with Docker
7
-
========================
5
+
Deploying your Rasa Assistant
6
+
=============================
8
7
9
8
.. edit-link::
10
9
11
-
This is a guide on how to build a Rasa assistant with Docker.
12
-
If you haven't used Rasa before, we'd recommend that you start with the :ref:`rasa-tutorial`.
10
+
This page explains when and how to deploy an assistant built with Rasa.
11
+
It will allow you to make your assistant available to users and set you up with a production-ready environment.
13
12
14
13
.. contents::
15
14
:local:
15
+
:depth: 2
16
+
17
+
18
+
When to deploy your assistant
19
+
-----------------------------
20
+
21
+
.. raw:: html
22
+
23
+
The best time to deploy your assistant and make it available to test users is once it can handle the most important happy paths or is what we call a <astyle="text-decoration: none"href="https://rasa.com/docs/rasa/glossary">minimum viable assistant</a>.
24
+
25
+
The recommended deployment methods described below make it easy to share your assistant with test users via the `share your assistant feature in Rasa X <../../rasa-x/docs/user-guide/enable-workflows#conversations-with-test-users>`_. Then, when you’re ready to make your assistant available via one or more :ref:`messaging-and-voice-channels`, you can easily add them to your existing deployment set up.
26
+
27
+
.. _recommended-deployment-methods:
28
+
29
+
Recommended Deployment Methods
30
+
------------------------------
31
+
32
+
The recommended way to deploy an assistant is using either the Docker Compose or Kubernetes/Openshift options we support. Both deploy Rasa X and your assistant. They are the easiest ways to deploy your assistant, allow you to use Rasa X to view conversations and turn them into training data, and are production-ready.
33
+
34
+
Kubernetes/Openshift
35
+
~~~~~~~~~~~~~~~~~~~~
36
+
37
+
Kubernetes/Openshift is the best option if you need a scalable architecture. It's straightforward to deploy if you use the helm charts we provide. However, you can also customize the Helm charts if you have specific requirements.
38
+
39
+
- Default: Read the docs `here <../../rasa-x/docs/installation-and-setup/openshift-kubernetes/>`__.
40
+
- Custom: Read the docs `here <../../rasa-x/docs/installation-and-setup/openshift-kubernetes/>`__ and customize the `open source Helm charts <https://github.com/RasaHQ/rasa-x-helm>`_.
41
+
42
+
Docker Compose
43
+
~~~~~~~~~~~~~~
44
+
45
+
- Default: Watching this `video <https://www.youtube.com/watch?v=IUYdwy8HPVc>`__ or read the docs `here <../../rasa-x/docs/installation-and-setup/docker-compose-script/>`__.
46
+
- Custom: Read the docs `here <../../rasa-x/docs/installation-and-setup/docker-compose-manual/>`__.
47
+
48
+
49
+
.. _rasa-only-deployment:
50
+
51
+
Rasa-Only Deployment with Docker Compose
52
+
----------------------------------------
53
+
54
+
It is also possible to deploy a Rasa assistant using Docker Compose without Rasa X.
55
+
56
+
.. contents::
57
+
:local:
58
+
16
59
17
60
Installing Docker
18
-
-----------------
61
+
~~~~~~~~~~~~~~~~~
19
62
20
63
If you're not sure if you have Docker installed, you can check by running:
21
64
@@ -31,7 +74,7 @@ install Docker.
31
74
See `Docker Installation <https://docs.docker.com/install/>`_ for details.
32
75
33
76
Building an Assistant with Rasa and Docker
34
-
------------------------------------------
77
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35
78
36
79
This section will cover the following:
37
80
@@ -44,7 +87,7 @@ This section will cover the following:
44
87
45
88
46
89
Setup
47
-
~~~~~
90
+
*****
48
91
49
92
Just like in the :ref:`tutorial <rasa-tutorial>`, you'll use the ``rasa init`` command to create a project.
50
93
The only difference is that you'll be running Rasa inside a Docker container, using
@@ -87,7 +130,7 @@ The initial project files should all be there, as well as a ``models`` directory
87
130
run the containers with a different user.
88
131
89
132
Talking to Your Assistant
90
-
~~~~~~~~~~~~~~~~~~~~~~~~~
133
+
*************************
91
134
92
135
To talk to your newly-trained assistant, run this command:
93
136
@@ -104,10 +147,10 @@ you need to pass the ``-it`` flags.
104
147
105
148
106
149
Customizing your Model
107
-
----------------------
150
+
~~~~~~~~~~~~~~~~~~~~~~
108
151
109
152
Choosing a Tag
110
-
~~~~~~~~~~~~~~
153
+
**************
111
154
112
155
To keep images as small as possible, we publish different tags of the ``rasa/rasa`` image
113
156
with different dependencies installed. See :ref:`choosing-a-pipeline` for more information
@@ -135,7 +178,7 @@ Alternatively, you can use the ``-full`` tag, which includes all pipeline depend
135
178
.. _model_training_docker:
136
179
137
180
Training a Custom Rasa Model with Docker
138
-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
181
+
****************************************
139
182
140
183
Edit the ``config.yml`` file to use the pipeline you want, and place
141
184
your NLU and Core data into the ``data/`` directory.
@@ -173,7 +216,7 @@ You can also leave these out since we are passing the default values.
173
216
174
217
175
218
Running the Rasa Server
176
-
-----------------------
219
+
~~~~~~~~~~~~~~~~~~~~~~~
177
220
178
221
To run your AI assistant in production, configure your required
179
222
:ref:`messaging-and-voice-channels` in ``credentials.yml``. If this file does not
@@ -203,7 +246,7 @@ Command Description:
203
246
204
247
205
248
Using Docker Compose to Run Multiple Services
206
-
---------------------------------------------
249
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
207
250
208
251
To run Rasa together with other services, such as a server for custom actions, it is
209
252
recommend to use `Docker Compose <https://docs.docker.com/compose/>`_.
@@ -257,14 +300,14 @@ To run the services configured in your ``docker-compose.yml`` execute:
257
300
258
301
259
302
Adding Custom Actions
260
-
---------------------
303
+
~~~~~~~~~~~~~~~~~~~~~
261
304
262
305
To create more sophisticated assistants, you will want to use :ref:`custom-actions`.
263
306
Continuing the example from above, you might want to add an action which tells
264
307
the user a joke to cheer them up.
265
308
266
309
Creating a Custom Action
267
-
~~~~~~~~~~~~~~~~~~~~~~~~
310
+
************************
268
311
269
312
Start by creating the custom actions in a directory ``actions``:
270
313
@@ -301,7 +344,7 @@ Continuing with the example bot from ``rasa init``, replace ``utter_cheer_up`` i
301
344
``action_joke`` to the actions in the domain file.
302
345
303
346
Adding the Action Server
304
-
~~~~~~~~~~~~~~~~~~~~~~~~
347
+
************************
305
348
306
349
The custom actions are run by the action server.
307
350
To spin it up together with the Rasa instance, add a service
@@ -340,7 +383,7 @@ Run ``docker-compose up`` to start the action server together
340
383
with Rasa.
341
384
342
385
Adding Custom Dependencies
343
-
~~~~~~~~~~~~~~~~~~~~~~~~~~
386
+
**************************
344
387
345
388
If your custom action has additional dependencies of systems or Python libraries,
346
389
you can add these by extending the official image.
@@ -368,15 +411,15 @@ You can then build the image via the following command, and use it in your
368
411
docker build . -t <name of your custom image>:<tag of your custom image>
369
412
370
413
Adding a Custom Tracker Store
371
-
-----------------------------
414
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
372
415
373
416
By default, all conversations are saved in memory. This means that all
374
417
conversations are lost as soon as you restart the Rasa server.
375
418
If you want to persist your conversations, you can use a different
376
419
:ref:`Tracker Store <tracker-stores>`.
377
420
378
421
Using PostgreSQL as Tracker Store
379
-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
422
+
*********************************
380
423
381
424
Start by adding PostgreSQL to your docker-compose file:
0 commit comments