Skip to content

[MRG] doc about creating an experimental module #13865

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

Merged
merged 2 commits into from
May 15, 2019

Conversation

NicolasHug
Copy link
Member

Closes #13499

ping @qinhanmin2014

Copy link
Member

@qinhanmin2014 qinhanmin2014 left a comment

Choose a reason for hiding this comment

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

thanks

@jnothman
Copy link
Member

You should also mention that for this to work, the public import path must be to a subpackage not just a .py module. So give an example of directory structure, such that the experimental import copies from the private to the public, but the experimental API needs to be a submodule of the public package to make pickles possibly work into the future

@qinhanmin2014
Copy link
Member

qinhanmin2014 commented May 12, 2019

Note that import * won't work, though I've not understood why

We don't define __all__ in __init__.py, I guess?

@ogrisel
Copy link
Member

ogrisel commented May 15, 2019

We don't define all in init.py, I guess?

Yes and we cannot define __all__ without importing the submodules which we don't want to do by default.

@ogrisel ogrisel merged commit e76984b into scikit-learn:master May 15, 2019
jnothman pushed a commit to jnothman/scikit-learn that referenced this pull request May 21, 2019
koenvandevelde pushed a commit to koenvandevelde/scikit-learn that referenced this pull request Jul 12, 2019
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.

Creation of an experimental module
4 participants