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 migration guide for policies #7522

Merged
merged 3 commits into from
Dec 11, 2020
Merged
Changes from 2 commits
Commits
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
9 changes: 9 additions & 0 deletions docs/docs/migration-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ description: |
This page contains information about changes between major versions and
how you can migrate from one version to another.

## Rasa 2.1 to Rasa 2.2

### Policies

[Policies](./policies.mdx) now require a `**kwargs` argument in their constructor and `load` method.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we also have a changelog for this, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm I don't think so. Will we have one changelog for the whole of continuous training?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should also add a changelog mentioning this change and then e.g. point to the migration guide.

Will we have one changelog for the whole of continuous training?

I think this change is somewhat unrelated to the training (we needed it, but we could have also done the policy interface change on its own) so I think it deserves it's own changelog. Especially because it's a deprecation.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok I can add it in this PR then. What issue number should we use?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mhm, either the number of this PR or probably better the one from the PR which introduced the change.

Policies without `**kwargs` will be supported until Rasa version `3.0.0`.
However when using [incremental training](./command-line-interface.mdx#incremental-training)
`**kwargs` **must** be included.

## Rasa 2.0 to Rasa 2.1

### Deprecations
Expand Down