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

Clarify limitations of LanguageModelFeaturizer in docs #10616

Merged
merged 6 commits into from
Jan 5, 2022

Conversation

mleimeister
Copy link
Contributor

@mleimeister mleimeister commented Jan 3, 2022

This docs update aims to clarify some details around which HuggingFace models can be used with LanguageModelFeaturizer. Despite the supported architectures being listed in our docs, users often try others and report errors in the forum. Furthermore, not all pretrained weights from the HF models hub for the supported architectures can be used (e.g. due to missing TF weights or non-standard tokenizers being used), which results in error messages that are hard to interpret.

A related ticket with links to forum issues can be found here here.

Proposed changes:

  • Clarify the limitations of the current implementation of LanguageModelFeaturizer w.r.t. model architectures and weights from HuggingFace

Status (please check what you already did):

  • added some tests for the functionality
  • updated the documentation
  • updated the changelog (please check changelog for instructions)
  • reformat files using black (please check Readme for instructions)

@mleimeister mleimeister changed the base branch from main to 3.0.x January 3, 2022 10:23
@github-actions
Copy link
Contributor

github-actions bot commented Jan 3, 2022

🚀 A preview of the docs have been deployed at the following URL: https://10616--rasahq-docs-rasa-v2.netlify.app/docs/rasa

@mleimeister
Copy link
Contributor Author

mleimeister commented Jan 3, 2022

@koernerfelicia @dakshvar22 Hi, I just wanted to check what you think and if this would improve the LM featurizer docs, since we've had frequent questions about this on the user forum recently. Not sure if I'm missing anything on the requirements for model weights to be useable with our implementation, but those listed were the ones I experienced as causes for errors.

Copy link
Contributor

@koaning koaning left a comment

Choose a reason for hiding this comment

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

+1 for picking this one up @mleimeister! I've added a few comments.

Copy link
Contributor

@koaning koaning left a comment

Choose a reason for hiding this comment

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

This looks grand!

@mleimeister mleimeister marked this pull request as ready for review January 5, 2022 09:26
@mleimeister mleimeister enabled auto-merge (squash) January 5, 2022 11:25
@mleimeister mleimeister merged commit fa93af4 into 3.0.x Jan 5, 2022
@mleimeister mleimeister deleted the document-lmfeaturizer-limitations branch January 5, 2022 11:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants