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

Fix & improve docs related to story augmentation #9691

Closed
samsucik opened this issue Sep 21, 2021 · 1 comment · Fixed by #9825
Closed

Fix & improve docs related to story augmentation #9691

samsucik opened this issue Sep 21, 2021 · 1 comment · Fixed by #9825
Assignees
Labels
area:rasa-oss 🎡 Anything related to the open source Rasa framework type:docs 📖 Improvements to the documenation. Adding missing pieces or improving existing ones. type:enhancement ✨ Additions of new features or changes to existing ones, should be doable in a single PR

Comments

@samsucik
Copy link
Contributor

samsucik commented Sep 21, 2021

What problem are you trying to solve?

The augmentation CLI arg is quite mysterious even though it impacts Core training a lot. We should add more info to the docs, as discussed in #6550.

What's your suggested solution?

Changes we should make:

  • Make it explicit that augmentation is a crucial parameter when trying to speed up Core training, but less augmentation can make TED's performance worse
  • Correct the docs to state the correct default augmentation factor (they say it's 20 but it's 50).
  • Make it explicit that augmentation affects only TED (out of the policies we provide)

Optionally, we might add these recommendations based on our observations:

  • If your config contains TEDPolicy and no memoization policies, start with story augmentation turned on (e.g. the default value of 50)
  • Otherwise (if a memoization policy is used too), try out also with story augmentation turned off -- to potentially speed up training

Examples (if relevant)

No response

Is anything blocking this from being implemented? (if relevant)

No response

Definition of Done

  • Discussed and decided whether or not to add the recommendations to the docs
  • Updated the docs
@samsucik samsucik added type:enhancement ✨ Additions of new features or changes to existing ones, should be doable in a single PR area:rasa-oss 🎡 Anything related to the open source Rasa framework labels Sep 21, 2021
@TyDunn TyDunn added type:docs 📖 Improvements to the documenation. Adding missing pieces or improving existing ones. effort:research/2 labels Oct 1, 2021
@samsucik
Copy link
Contributor Author

samsucik commented Oct 1, 2021

Btw this issue has a natural followup here, but that one's more technical and has been decided to be done only after 3.0.

@kedz kedz linked a pull request Oct 7, 2021 that will close this issue
3 tasks
@kedz kedz closed this as completed Oct 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:rasa-oss 🎡 Anything related to the open source Rasa framework type:docs 📖 Improvements to the documenation. Adding missing pieces or improving existing ones. type:enhancement ✨ Additions of new features or changes to existing ones, should be doable in a single PR
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants