rasa: Clarify if component method required_packages returns module names or requirements

Rasa version: 1.0.2

Python version: 3.7.3

Operating system (windows, osx, …): Debian testing

Issue: The doc at http://rasa.com/docs/rasa/api/custom-nlu-components/#rasa.nlu.components.Component.required_packages doesn’t make clear whether the strings returned should be module names (i.e. importable, like sklearn) or requirements (i.e. checked using packaging introspection methods, e.g. scikit-learn).

About this issue

Original URL
State: closed
Created 5 years ago
Comments: 18 (10 by maintainers)

Commits related to this issue

Updated documentation to clarify Component's required_packages The list of requirements is actually a list of importable python modules, not package names. See issue #3647 for more details. — committed to hsm207/rasa by hsm207 5 years ago

Most upvoted comments

Thanks for improving the docs! 🙂

merwok on Aug 1, 2019

The exception message and also the doc I linked from my first message.

merwok on Jul 30, 2019

I don’t know how to say the same thing in a different way 🙁

To repeat my initial message: if import sklearn fails, it is not correct to say you need to run pip install sklearn, because the (importable) module name is not the same as the (installable) package name (here: scikit-learn).

merwok on Jul 30, 2019

I want to work on this

hsm207 on Jul 28, 2019

Sure, but maybe not before a few weeks.

merwok on Jun 6, 2019

could you clarify what you mean? it specifies the names of python packages

akelad on Jun 3, 2019