Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[MRG] DOC Replacing "the scikit" with "scikit-learn" #10126

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 4 commits into from
Nov 14, 2017

Conversation

FarahSaeed
Copy link
Contributor

What does this implement/fix? Explain your changes.

Fixes #10120

To avoid references to this project as "the scikit" in Doc, replacing "the scikit" with "the scikit-learn"

In Doc, replacing "the scikit" with "scikit-learn"
@jnothman
Copy link
Member

I prefer scikit-learn be treated as a proper noun: don't put "the" before it.

@FarahSaeed
Copy link
Contributor Author

Removed "the" from "the scikit-learn" in recent commit.

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.

@jnothman Some related concerns:
(1)There are some "the scikit" in other folders, e.g., sklearn/, should we also replace them with "scikit-learn"?
(2)There are some "the scikit-learn", should we replace them with "scikit-learn"?

@qinhanmin2014 qinhanmin2014 changed the title [MRG] Replacing "the scikit" with "the scikit-learn" [MRG] DOC Replacing "the scikit" with "scikit-learn" Nov 14, 2017
@lesteve
Copy link
Member

lesteve commented Nov 14, 2017

Good point @qinhanmin2014. For (1)

❯ git grep -iP 'the scikit[^-]'
doc/datasets/index.rst:The scikit also embed a couple of sample JPEG images published under Creative
examples/README.txt:General-purpose and introductory examples for the scikit.
examples/applications/wikipedia_principal_eigenvector.py:algorithm implemented in the scikit.
sklearn/__check_build/__init__.py:compile the scikit properly.
sklearn/__init__.py:    # We are not importing the rest of the scikit during the build
sklearn/preprocessing/label.py:    available in the scikit. A simple way to extend these algorithms
sklearn/preprocessing/label.py:    available in the scikit. A simple way to extend these algorithms

For (2) I could not find quickly looking at the matches a problem with "the scikit-learn". Generally there is a word afterwards like in "the scikit-learn project". I used this command: git grep -i -C1 'the scikit-learn'

@qinhanmin2014
Copy link
Member

@lesteve Thanks. Agree :)
@FarahSaeed Could you please extend the replacement ("the scikit" -> "scikit-learn") to other folders? Thanks.

@FarahSaeed
Copy link
Contributor Author

@qinhanmin2014 Sure.

@jnothman
Copy link
Member

jnothman commented Nov 14, 2017 via email

@lesteve
Copy link
Member

lesteve commented Nov 14, 2017

I'd say yes to #1; #2 is more minor, imo
But I also have no idea if others think this is the right thing to do

I think we all agree on this one ! @FarahSaeed all the matches I found are in #10126 (comment). You can run the same git grep command to make sure you removed all of them.

@FarahSaeed
Copy link
Contributor Author

In recent commit, I've extended the replacement ("the scikit" -> "scikit-learn") to all folders.

@qinhanmin2014
Copy link
Member

@FarahSaeed Seems that there's still another one
sklearn/tests/test_common.py: # 'configure' functions in the setup.pys in the scikit
It might be better if you can use git grep or Linux grep to check your result :)

@FarahSaeed
Copy link
Contributor Author

@qinhanmin2014 let me recheck and commit again.

@FarahSaeed
Copy link
Contributor Author

Replaced "the scikit" with "scikit-learn" in all other places.

@lesteve
Copy link
Member

lesteve commented Nov 14, 2017

LGTM. I double-checked that there were no remaining "the scikit" occurences with git grep -iP 'the scikit[^-]'.

@lesteve
Copy link
Member

lesteve commented Nov 14, 2017

Merging without waiting for the CIs, thanks a lot @FarahSaeed !

@lesteve lesteve merged commit b272358 into scikit-learn:master Nov 14, 2017
@FarahSaeed
Copy link
Contributor Author

Thank you! :) @lesteve @qinhanmin2014 @jnothman

@FarahSaeed FarahSaeed deleted the feature branch November 14, 2017 10:34
maskani-moh pushed a commit to maskani-moh/scikit-learn that referenced this pull request Nov 15, 2017
jwjohnson314 pushed a commit to jwjohnson314/scikit-learn that referenced this pull request Dec 18, 2017
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.

DOC Avoid references to this project as "the scikit"
4 participants