Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add e2e docs #7512

Merged
merged 101 commits into from
Dec 16, 2020
Merged
Show file tree
Hide file tree
Changes from 41 commits
Commits
Show all changes
101 commits
Select commit Hold shift + click to select a range
f556f9a
change TED default params
Ghostvv Dec 10, 2020
03b97d5
Update docs/docs/training-data-format.mdx
Ghostvv Dec 10, 2020
e7a401f
Update docs/docs/training-data-format.mdx
Ghostvv Dec 10, 2020
61e471d
Update docs/docs/training-data-format.mdx
Ghostvv Dec 10, 2020
343c006
update docs phrases
Ghostvv Dec 10, 2020
de86f23
break long line
Ghostvv Dec 10, 2020
e70a4a0
add changelog
Ghostvv Dec 10, 2020
2977825
add deprecation config for dense dimension
Ghostvv Dec 10, 2020
99d3208
Merge branch 'e2e' into e2e-docs
Ghostvv Dec 10, 2020
98f03fe
fix new config parameters
Ghostvv Dec 10, 2020
f09e37f
add comments for config params
Ghostvv Dec 10, 2020
6f40343
fix docstrings
Ghostvv Dec 10, 2020
909b2db
update comments
Ghostvv Dec 10, 2020
0eecb10
update migration guide with new ted parameters
Ghostvv Dec 10, 2020
4ccd1a1
update changelog
Ghostvv Dec 10, 2020
4f4ac6b
a lot of bug fixes regarding updating config
Ghostvv Dec 10, 2020
10b2036
fix updating config dict again
Ghostvv Dec 11, 2020
fb4eca7
Update docs/docs/training-data-format.mdx
Ghostvv Dec 11, 2020
bc2f5e3
remove new-old config param descriptions
Ghostvv Dec 11, 2020
e0633ee
Merge branch 'e2e-docs' of https://github.com/RasaHQ/rasa into e2e-docs
Ghostvv Dec 11, 2020
d8c2297
remove else
Ghostvv Dec 11, 2020
d2f3088
add docstring
Ghostvv Dec 11, 2020
08d49dd
update changelog
Ghostvv Dec 11, 2020
5b0d50a
Update docs/docs/stories.mdx
Ghostvv Dec 11, 2020
27c42f1
Update docs/docs/stories.mdx
Ghostvv Dec 11, 2020
542b403
Update docs/docs/training-data-format.mdx
Ghostvv Dec 11, 2020
3867f45
Update docs/docs/training-data-format.mdx
Ghostvv Dec 11, 2020
a1c9004
update stories.mdx
Ghostvv Dec 11, 2020
cc4380d
update training-data-format.mdx
Ghostvv Dec 11, 2020
36e53e6
substitute we with you
Ghostvv Dec 11, 2020
35aa6f0
don't include e2e in the stories example
Ghostvv Dec 11, 2020
2bafb9b
make list
Ghostvv Dec 11, 2020
88c54de
remove required
Ghostvv Dec 11, 2020
a5105c5
merge e2e
Ghostvv Dec 11, 2020
25b4fde
add migration guide for domain changes
wochinge Dec 11, 2020
97214a5
mention explicitly
Ghostvv Dec 11, 2020
cb89f36
Merge branch 'e2e-docs' of https://github.com/RasaHQ/rasa into e2e-docs
Ghostvv Dec 11, 2020
1aa7ce5
fix import
Ghostvv Dec 11, 2020
7c928fe
add link to ted policy
Ghostvv Dec 11, 2020
d19777a
add docstrings
Ghostvv Dec 11, 2020
18ea94b
fix updating config
Ghostvv Dec 11, 2020
091b246
move e2e into separate paragraph
Ghostvv Dec 14, 2020
91d112a
add blank line back
Ghostvv Dec 14, 2020
10eb13a
add increased train time note
Ghostvv Dec 14, 2020
c7d61ba
Update docs/docs/migration-guide.mdx
Ghostvv Dec 15, 2020
ab6e196
Update docs/docs/migration-guide.mdx
Ghostvv Dec 15, 2020
8be77a5
Update docs/docs/training-data-format.mdx
Ghostvv Dec 15, 2020
2397816
remove the link to the training data format page
Ghostvv Dec 15, 2020
bab28c6
remove the line'
Ghostvv Dec 15, 2020
e1f06a2
remove the line
Ghostvv Dec 15, 2020
ed70b01
break long line
Ghostvv Dec 15, 2020
662a183
Update changelog/7496.improvement.md
Ghostvv Dec 15, 2020
213cdb5
Update docs/docs/stories.mdx
Ghostvv Dec 15, 2020
ff1a99e
Update docs/docs/stories.mdx
Ghostvv Dec 15, 2020
ff936fe
Update docs/docs/stories.mdx
Ghostvv Dec 15, 2020
6af1c87
Update docs/docs/training-data-format.mdx
Ghostvv Dec 15, 2020
02bd138
Update docs/docs/training-data-format.mdx
Ghostvv Dec 15, 2020
3d2c033
Update docs/docs/migration-guide.mdx
Ghostvv Dec 15, 2020
fccecf0
Update docs/docs/stories.mdx
Ghostvv Dec 15, 2020
e0e5246
Update docs/docs/stories.mdx
Ghostvv Dec 15, 2020
e4d5d9d
Update docs/docs/policies.mdx
Ghostvv Dec 15, 2020
51cff11
Update docs/docs/policies.mdx
Ghostvv Dec 15, 2020
22c050d
Update docs/docs/policies.mdx
Ghostvv Dec 15, 2020
0b508b8
Update docs/docs/migration-guide.mdx
Ghostvv Dec 15, 2020
53bd1f0
Update docs/docs/stories.mdx
Ghostvv Dec 15, 2020
2bf401a
Update docs/docs/stories.mdx
Ghostvv Dec 15, 2020
d360f3b
Update docs/docs/stories.mdx
Ghostvv Dec 15, 2020
2aabef9
Update docs/docs/policies.mdx
Ghostvv Dec 15, 2020
d8aa78a
Update docs/docs/policies.mdx
Ghostvv Dec 15, 2020
f803e17
Update docs/docs/policies.mdx
Ghostvv Dec 15, 2020
09d5df8
Update docs/docs/policies.mdx
Ghostvv Dec 15, 2020
4a6a29e
Update docs/docs/policies.mdx
Ghostvv Dec 15, 2020
4aa7e87
Update docs/docs/stories.mdx
Ghostvv Dec 15, 2020
607528b
Update docs/docs/stories.mdx
Ghostvv Dec 15, 2020
8e6dcac
Update docs/docs/stories.mdx
Ghostvv Dec 15, 2020
a1b7d2f
Update docs/docs/stories.mdx
Ghostvv Dec 15, 2020
00efdc6
Update docs/docs/stories.mdx
Ghostvv Dec 15, 2020
2464968
Update docs/docs/training-data-format.mdx
Ghostvv Dec 15, 2020
4df90c7
Update docs/docs/training-data-format.mdx
Ghostvv Dec 15, 2020
3585e11
Update docs/docs/training-data-format.mdx
Ghostvv Dec 15, 2020
73839d5
Update docs/docs/training-data-format.mdx
Ghostvv Dec 15, 2020
c36745e
Update docs/docs/training-data-format.mdx
Ghostvv Dec 15, 2020
94052de
Update docs/docs/training-data-format.mdx
Ghostvv Dec 15, 2020
20d34ff
Update docs/docs/training-data-format.mdx
Ghostvv Dec 15, 2020
998ed42
Update docs/docs/migration-guide.mdx
Ghostvv Dec 15, 2020
ad5d313
add example to migration guide
Ghostvv Dec 15, 2020
6475f4b
remove notes
Ghostvv Dec 15, 2020
6dfe4bc
rename changelog to feature
Ghostvv Dec 15, 2020
b7e7c34
Update docs/docs/stories.mdx
Ghostvv Dec 15, 2020
d4d024f
expand explanation
Ghostvv Dec 15, 2020
6d18fea
update examples in docs to have the same topic as e2ebot
Ghostvv Dec 15, 2020
d3aadd3
copy ted description from diet
Ghostvv Dec 15, 2020
379ac86
update parameter description
Ghostvv Dec 15, 2020
b747396
fix overriding default config
Ghostvv Dec 15, 2020
0c2e20d
merge e2e
Ghostvv Dec 15, 2020
68fcd71
Update docs/docs/training-data-format.mdx
Ghostvv Dec 16, 2020
6bfdfb5
Update docs/docs/training-data-format.mdx
Ghostvv Dec 16, 2020
aafda9f
add actions to doc stories
Ghostvv Dec 16, 2020
be265b3
Merge branch 'e2e-docs' of https://github.com/RasaHQ/rasa into e2e-docs
Ghostvv Dec 16, 2020
78db38c
update story
Ghostvv Dec 16, 2020
b226995
more details in error message
m-vdb Dec 16, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions changelog/7496.improvement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Make [TED Policy](policies.mdx#ted-policy) an end-to-end policy. Namely, make it possible to train TED on stories that contain
intent and entities or user text and bot actions or bot text.
If you don't have text in your stories, TED will behave the same way as before.
Add possibility to predict entities using TED.

Here's an example of a dialogue in the Rasa story format:

```
Ghostvv marked this conversation as resolved.
Show resolved Hide resolved
stories:
- story: collect restaurant booking info # name of the story - just for debugging
steps:
- intent: greet # user message with no entities
- action: utter_ask_howcanhelp # action that the bot should execute
- intent: inform # user message with entities
entities:
- location: "rome"
- price: "cheap"
- bot: On it # actual text that bot can output
- action: utter_ask_cuisine
- user: I would like [spanish](cuisine). # actual text that user input
- action: utter_ask_num_people
```

Some model options for `TEDPolicy` got renamed.
Please update your configuration files using the following mapping:

| Old model option | New model option |
|-----------------------------|--------------------------------------------------------|
|transformer_size |dictionary “transformer_size” with keys |
| |“text”, “action_text”, “label_action_text”, “dialogue” |
|number_of_transformer_layers |dictionary “number_of_transformer_layers” with keys |
| |“text”, “action_text”, “label_action_text”, “dialogue” |
|dense_dimension |dictionary “dense_dimension” with keys |
| |“text”, “action_text”, “label_action_text”, “intent”, |
| |“action_name”, “label_action_name”, “entities”, “slots”,|
| |“active_loop” |
6 changes: 3 additions & 3 deletions docs/docs/components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1429,7 +1429,7 @@ However, additional parameters exist that can be adapted.
+=================================+==================+==============================================================+
| hidden_layers_sizes | text: [] | Hidden layer sizes for layers before the embedding layers |
| | label: [] | for user messages and labels. The number of hidden layers is |
| | | equal to the length of the corresponding. |
| | | equal to the length of the corresponding list. |
+---------------------------------+------------------+--------------------------------------------------------------+
| share_hidden_layers | False | Whether to share the hidden layer weights between user |
| | | messages and labels. |
Expand Down Expand Up @@ -1463,8 +1463,8 @@ However, additional parameters exist that can be adapted.
+---------------------------------+------------------+--------------------------------------------------------------+
| embedding_dimension | 20 | Dimension size of embedding vectors. |
+---------------------------------+------------------+--------------------------------------------------------------+
| dense_dimension | text: 128 | Dense dimension for sparse features to use if no dense |
| | label: 20 | features are present. |
| dense_dimension | text: 128 | Dense dimension for sparse features to use. |
| | label: 20 | |
+---------------------------------+------------------+--------------------------------------------------------------+
| concat_dimension | text: 128 | Concat dimension for sequence and sentence features. |
| | label: 20 | |
Expand Down
23 changes: 23 additions & 0 deletions docs/docs/migration-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,25 @@ how you can migrate from one version to another.

## Rasa 2.1 to Rasa 2.2

### General

Some model options for `TEDPolicy` got renamed.
Ghostvv marked this conversation as resolved.
Show resolved Hide resolved
Please update your configuration files using the following mapping:

| Old model option | New model option |
Ghostvv marked this conversation as resolved.
Show resolved Hide resolved
|-----------------------------|--------------------------------------------------------|
|transformer_size |dictionary “transformer_size” with keys |
Ghostvv marked this conversation as resolved.
Show resolved Hide resolved
Ghostvv marked this conversation as resolved.
Show resolved Hide resolved
| |“text”, “action_text”, “label_action_text”, “dialogue” |
|number_of_transformer_layers |dictionary “number_of_transformer_layers” with keys |
| |“text”, “action_text”, “label_action_text”, “dialogue” |
|dense_dimension |dictionary “dense_dimension” with keys |
| |“text”, “action_text”, “label_action_text”, “intent”, |
| |“action_name”, “label_action_name”, “entities”, “slots”,|
| |“active_loop” |
Ghostvv marked this conversation as resolved.
Show resolved Hide resolved

### Deprecations

#### Markdown Data
Training and test data in Markdown format is now deprecated. This includes:
- reading and writing of story files in Markdown format
- reading and writing of NLU data in Markdown format
Expand All @@ -24,6 +41,12 @@ Support for Markdown data will be removed entirely in Rasa Open Source 3.0.0.
Please convert your existing Markdown data by using the commands
described [here](./migration-guide.mdx#training-data-files).

#### Others
Ghostvv marked this conversation as resolved.
Show resolved Hide resolved
* `Domain.random_template_for` is deprecated and will be removed in Rasa Open Source
3.0.0. You can alternatively use the `TemplatedNaturalLanguageGenerator`.
* `Domain.action_names` is deprecated and will be removed in Rasa Open Source
3.0.0. Please use `Domain.action_names_or_texts` instead.

## Rasa 2.0 to Rasa 2.1

### Deprecations
Expand Down
Loading