[MRG + 1] load_iris dataset: added return_X_y option #7049
Conversation
| return_X_y : boolean, default=False. | ||
| If True, returns (data, target) instead of a Bunch object. | ||
| See below for more information about the `data` and `target` object | ||
|
|
||
| Returns | ||
| ------- | ||
| data : Bunch |
There was a problem hiding this comment.
I think you should change this line to reflect how the function can return a Bunch or a tuple now.
There was a problem hiding this comment.
That's precisely what this line defines. Don't you think ?
If True, returns (data, target) instead of a Bunch object.
There was a problem hiding this comment.
Well on line 266 in the diff it still says that it returns data : Bunch. Would it be apt to include information about it possibly returning (data, target) as well?
|
lgtm apart from comments |
|
I restarted CI |
|
@amueller I did the fixes. Do I need to squash commits or do anything else here ? |
| @@ -264,6 +270,8 @@ def load_iris(): | |||
| meaning of the features, and 'DESCR', the | |||
| full description of the dataset. | |||
|
|
|||
| (data,target) : tuple if ``return_X_y`` is True | |||
|
lgtm apart from style comments. No, nothing else to do (except fix these) |
amueller
changed the title
|
@nelson-liu +1 ? |
|
still looking, give me a second |
|
yup LGTM thanks @manu-chroma |
|
does this warrant a what's new? or should there be one after this is implemented in all the loaders. |
|
Also perhaps a versionadded? |
|
good catch. definitely a versionadded for the keyword. We can also add a whatsnew, and edit that in the future when we add this functionality to the other functions. |
|
@manu-chroma does that sound doable? You would have to add an entry in |
|
@nelson-liu Sure, I can do that. I was thinking of updating the |
|
yeah, that's one possibility but i think it would be a bit better to create an entry now, and then edit it as the functionality for more loaders is added with their associated PR's. |
|
Okay, I'll update the PR in a few hours. I suppose this change should come under |
|
yup, that's a good assumption. |
|
Hey, I updated my branch before editing After that I added the version tag (f4d6168) and tried running manu@hp:~/github/scikit-learn/doc$ sudo make html-noplot
sphinx-build -D plot_gallery=0 -b html -d _build/doctrees . _build/html/stable
Running Sphinx v1.4.5
WARNING: sphinx.ext.pngmath has been deprecated. Please use sphinx.ext.imgmath instead.
loading pickled environment... not yet created
/home/manu/github/scikit-learn/sklearn/cross_validation.py:43: DeprecationWarning: This module was deprecated in version 0.18 in favor of the model_selection module into which all the refactored classes and functions are moved. Also note that the interface of the new CV iterators are different from that of this module. This module will be removed in 0.20.
"This module will be removed in 0.20.", DeprecationWarning)
/home/manu/github/scikit-learn/sklearn/learning_curve.py:23: DeprecationWarning: This module was deprecated in version 0.18 in favor of the model_selection module into which all the functions are moved. This module will be removed in 0.20
DeprecationWarning)
Exception occurred:
File "/home/manu/github/scikit-learn/sklearn/tree/tree.py", line 61, in <module>
"mae": _criterion.MAE}
AttributeError: 'module' object has no attribute 'MAE'
The full traceback has been saved in /tmp/sphinx-err-0pnBuo.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
Makefile:47: recipe for target 'html-noplot' failed
make: *** [html-noplot] Error 1 |
|
Did you rerun |
|
Yes, that was the case. Really sorry for forgetting the standard procedure. I've updated |
| @@ -258,6 +258,15 @@ def load_iris(): | |||
|
|
|||
| Read more in the :ref:`User Guide <datasets>`. | |||
|
|
|||
| Parameters | |||
| ---------- | |||
There was a problem hiding this comment.
There is an extra space here. Sphinx will complain.
|
thanks :) |
| Parameters | ||
| ---------- | ||
|
|
||
| .. versionadded:: 0.18 |
There was a problem hiding this comment.
sorry i'm late to the party, shouldn't the versionadded be under return_X_y? and do we need a versionadded under the new return type (say around line 280)?
There was a problem hiding this comment.
yes. Do you want to do a PR to fix it? (sorry I'm swamped)
There was a problem hiding this comment.
sure ill do it / fix the other comments i had on this PR @amueller @manu-chroma
There was a problem hiding this comment.
Sorry for replying late.
I intend on sending the next PR this weekend (adding return_X_y option to load_breast_cancer dataset)
Should I take care of this ?
There was a problem hiding this comment.
that's fine, i made a fix at #7138 . Just make sure to do it for next time :)
There was a problem hiding this comment.
Sorry and I'll keep that in mind.
* load_iris dataset:added return_X_y option * Updated return type description * improved return type description * Removed extra line * Added extra line * Added test sentence. * Remove sample text * Fixes * pep8 * Added version tag * added entry in whats_new * fixed extra space
* load_iris dataset:added return_X_y option * Updated return type description * improved return type description * Removed extra line * Added extra line * Added test sentence. * Remove sample text * Fixes * pep8 * Added version tag * added entry in whats_new * fixed extra space
Reference Issue
Add return_tuple option to data loaders that return a Bunch #6670
What does this implement/fix? Explain your changes.
Any other comments?