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

Skip to content

[MRG] DOC add versionadded versionchanged v0.19 #16233

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 9 commits into from
Apr 15, 2020
Merged

[MRG] DOC add versionadded versionchanged v0.19 #16233

merged 9 commits into from
Apr 15, 2020

Conversation

noatamir
Copy link
Contributor

Towards #15426

finished v0.19.1 (added as main version v0.19 as per Adrin's advice), still working through v0.19

@adrinjalali #wimlds #scikitlearnsprint

adrinjalali
adrinjalali approved these changes Jan 28, 2020
View reviewed changes
Copy link
Member

@adrinjalali adrinjalali left a comment

Choose a reason for hiding this comment

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

The other changes in that changelog were already covered @noatamir ?

@noatamir
Copy link
Contributor Author

Hi @adrinjalali, so far yes. I'm half-way through checking them all and will finish the rest of the list this Saturday. Thanks for the follow-up.

@cmarmo
Copy link
Contributor

cmarmo commented Feb 6, 2020

Maybe @jnothman could have a look? One approval already and failing checks unrelated to changes. Thanks!

@noatamir
Copy link
Contributor Author

@adrinjalali please review new changes
#wimlds

@adrinjalali
Copy link
Member

You have some linter issues @noatamir :)

@noatamir
Copy link
Contributor Author

of course I do! thanks for catching them, I'll double check..

@noatamir
Copy link
Contributor Author

@adrinjalali can you check again please?

@cmarmo
Copy link
Contributor

cmarmo commented Feb 28, 2020

Hi @noatamir there are still some lines longer than 79 characters.
May I suggest to run flake8 <name-of-the-modified-file> locally in order to check? Thanks for your work!

@adrinjalali
Copy link
Member

Alternatively, you could run ./build_tools/circle/linting.sh from your sklearn fork see the exact same result as the CI, since running flake8 on the files may give errors which are not related to your PR, and you should ignore them :D

@noatamir
Copy link
Contributor Author

Only one of my files has a flake8 error now, and it's in the code, not where I added docstrings.

sklearn/neighbors/_nearest_centroid.py:143:80: E501 line too long (82 > 79 characters)
sklearn/neighbors/_nearest_centroid.py:145:80: E501 line too long (82 > 79 characters)

Ah just saw @adrinjalali comment. I'll try that too.

@noatamir
Copy link
Contributor Author

passed lint. Let me know if there's any other issue. Thanks for the pointers!

@adrinjalali
Copy link
Member

@cmarmo I can't easily figure the indentation issue here. Is it the same issue as the other PR we had?

@cmarmo
Copy link
Contributor

cmarmo commented Mar 2, 2020

@cmarmo I can't easily figure the indentation issue here. Is it the same issue as the other PR we had?

I think so... @noatamir, could you add a blank line before the .. versionadded or .. versionchanged directives? This will improve readability and probably fix the sphinx warning. Thanks!

cmarmo
cmarmo approved these changes Mar 11, 2020
View reviewed changes
Copy link
Contributor

@cmarmo cmarmo left a comment

Choose a reason for hiding this comment

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

Apart those minor comments. Thanks @noatamir for your work.

sklearn/decomposition/_lda.py
@@ -143,6 +143,8 @@ class LatentDirichletAllocation(TransformerMixin, BaseEstimator):
----------
n_components : int, optional (default=10)
Number of topics.
.. versionchanged:: 0.19
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
.. versionchanged:: 0.19
.. versionchanged:: 0.19

This change will fix the sphinx warning.

sklearn/feature_extraction/_hash.py
@@ -68,6 +68,9 @@ class FeatureHasher(TransformerMixin, BaseEstimator):
When True, an alternating sign is added to the features as to
approximately conserve the inner product in the hashed space even for
small n_features. This approach is similar to sparse random projection.
.. versionchanged:: 0.19
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
.. versionchanged:: 0.19
.. versionchanged:: 0.19

just for consistency

sklearn/multiclass.py
@@ -629,6 +633,9 @@ def decision_function(self, X):
Returns
-------
Y : array-like of shape (n_samples, n_classes)
.. versionchanged:: 0.19
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
.. versionchanged:: 0.19
.. versionchanged:: 0.19

just for consistency

.gitignore Outdated
@@ -230,3 +230,4 @@ sklearn/feature_selection/mutual_info.py
sklearn/feature_selection/rfe.py
sklearn/feature_selection/univariate_selection.py
sklearn/feature_selection/variance_threshold.py
Pipfile
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you please remove Pipfile from .gitignore? The file is created by your virtual environment. To avoid this problem you can create the virtual environment files outside the development directory.

@cmarmo
Copy link
Contributor

cmarmo commented Mar 31, 2020

Hi @noatamir, hope you are fine ... one approval already for this PR. Maybe you can find some time to fix the last issues so it can be merged?

@noatamir
Copy link
Contributor Author

noatamir commented Apr 5, 2020

@cmarmo Thanks for the detailed comments. I made all the changes you mentioned.

Please excuse the late reply, I was a bit derailed by COVID-19.

@noatamir noatamir changed the title [WIP] DOC add versionadded versionchanged v0.19 [MRG] DOC add versionadded versionchanged v0.19 Apr 5, 2020
@cmarmo
Copy link
Contributor

cmarmo commented Apr 5, 2020

Please excuse the late reply, I was a bit derailed by COVID-19.

No worries, we are all a bit derailed those days...

CI is failing as reported in #16545: syncing with master will solve the problem.
Maybe @NicolasHug or @thomasjpfan are available for a final review? Thanks!

thomasjpfan
thomasjpfan reviewed Apr 5, 2020
View reviewed changes
Copy link
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

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

Thank you for the PR @noatamir !

noatamir and others added 2 commits April 6, 2020 09:53
@cmarmo
Copy link
Contributor

cmarmo commented Apr 8, 2020

Hi @noatamir , could you please sync with upstream/master? This will fix the failing CI. Thanks a lot!

@noatamir
Copy link
Contributor Author

@cmarmo done =)

@cmarmo
Copy link
Contributor

cmarmo commented Apr 14, 2020

Thanks @noatamir! All green! Maybe @NicolasHug is listening? This PR is ready to merge I think...

@adrinjalali adrinjalali merged commit 5e2d74b into scikit-learn:master Apr 15, 2020
gio8tisu pushed a commit to gio8tisu/scikit-learn that referenced this pull request May 15, 2020
@noatamir @thomasjpfan @gio8tisu
DOC add versionadded versionchanged v0.19 (scikit-learn#16233)
8dfb84e 
* added v0.19.1 and wip v0.19

* finished adding vchanged strings for v0.19

Towards scikit-learn#15426

@adrinjalali #wimlds #scikitlearnsprint

* fixing linter issues

* caught line issues with flake8

* caught the last line issue

* added lines and cleaned gtiignore

* Update sklearn/multiclass.py

Co-Authored-By: Thomas J Fan <[email protected]>

* Update sklearn/multiclass.py

Co-Authored-By: Thomas J Fan <[email protected]>

Co-authored-by: Thomas J Fan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cmarmo cmarmo cmarmo approved these changes

@adrinjalali adrinjalali adrinjalali approved these changes

@thomasjpfan thomasjpfan thomasjpfan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@noatamir @cmarmo @adrinjalali @thomasjpfan