[MRG] DOC: fix document that fetch_20newsgroups #12783

eamanu · 2018-12-14T16:34:50Z

Reference Issues/PRs

Fix #12777
Related https://github.com/scikit-learn/scikit-learn/pull/12770/files#r241655146

What does this implement/fix? Explain your changes.

Improve doc of fetch_20newsgroups and add target_names on Return on docstring.

Any other comments?

Fix scikit-learn#12777 Related https://github.com/scikit-learn/scikit-learn/pull/12770/files#r241655146

adrinjalali · 2018-12-14T16:51:33Z

sklearn/datasets/twenty_newsgroups.py

-        bunch.DESCR: a description of the dataset.
+    bunch : Bunch object with the following attribute:
+
+    bunch.data: list, length [n_samples]


I think the extra indentation here is actually useful, but maybe this would work?

bunch ... - bunch.blahblah .... ....

adrinjalali · 2018-12-14T16:52:00Z

sklearn/datasets/twenty_newsgroups.py

+
+    bunch.DESCR: a description of the dataset.
+
+    bunch.target_names: a list of categories containing in the dataset,


I think this is the categories of the returned data, not the whole dataset (I may be mistaken)

yes! you are rigth. So. the length should be [n_samples] right?

adrinjalali · 2018-12-14T22:35:19Z

sklearn/datasets/twenty_newsgroups.py

-        bunch.DESCR: a description of the dataset.
+    bunch : Bunch object with the following attribute:
+
+        - bunch.data: list, length [n_samples]


I think you may not need these newlines in between these items.

I remove it.

adrinjalali · 2018-12-14T22:35:56Z

sklearn/datasets/twenty_newsgroups.py

+        - bunch.DESCR: a description of the dataset.
+
+        - bunch.target_names: a list of categories of the returned data,
+          length [n_classes]. This depends of the `categories` parameter.


Is this another one in the itemized list, or is it a second output (in which case it has one extra indentation)?

in the last commit I improve this

eamanu · 2018-12-15T13:34:03Z

El 14 dic. 2018 7:36 PM, Adrin Jalali <notifications@github.com> escribió:@adrinjalali commented on this pull request. In sklearn/datasets/twenty_newsgroups.py:

- bunch.data: list, length [n_samples]

- bunch.target: array, shape [n_samples] - bunch.filenames: list, length [n_classes] - bunch.DESCR: a description of the dataset. + bunch : Bunch object with the following attribute: + + - bunch.data: list, length [n_samples] + + - bunch.target: array, shape [n_samples] + + - bunch.filenames: list, length [n_classes] + + - bunch.DESCR: a description of the dataset. + + - bunch.target_names: a list of categories of the returned data, + length [n_classes]. This depends of the `categories` parameter. Is this another one in the itemized list, or is it a second output (in which case it has one extra indentation)?Is the length of the target_names list. Do I writte it on a different way? —You are receiving this because you authored the thread.Reply to this email directly, view it on GitHub, or mute the thread.

eamanu · 2018-12-15T13:35:43Z

El 14 dic. 2018 7:35 PM, Adrin Jalali <notifications@github.com> escribió:@adrinjalali commented on this pull request. In sklearn/datasets/twenty_newsgroups.py:

@@ -216,11 +216,18 @@ def fetch_20newsgroups(data_home=None, subset='train', categories=None,

Returns ------- - bunch : Bunch object - bunch.data: list, length [n_samples] - bunch.target: array, shape [n_samples] - bunch.filenames: list, length [n_classes] - bunch.DESCR: a description of the dataset. + bunch : Bunch object with the following attribute: + + - bunch.data: list, length [n_samples] I think you may not need these newlines in between these items.Ok! I will clean this —You are receiving this because you authored the thread.Reply to this email directly, view it on GitHub, or mute the thread.

qinhanmin2014 · 2018-12-16T04:04:20Z

sklearn/datasets/twenty_newsgroups.py

-        bunch.DESCR: a description of the dataset.
+    bunch : Bunch object with the following attribute:
+        - bunch.data: list, length [n_samples]
+


Do we need all these blank lines?

Ready. I remove all blank lines from the docs. I did not sure about the sphinx behavior, because of that I used the blank line. :-)

qinhanmin2014 · 2018-12-16T15:35:06Z

sklearn/datasets/twenty_newsgroups.py

+    bunch : Bunch object with the following attribute:
+        - bunch.data: list, length [n_samples]
+        - bunch.target: array, shape [n_samples]
+        - bunch.filenames: list, length [n_classes]


I am trying to say that is the target_names of the returned data (similarly to fetch_20newsgroups). Maybe n_samples is the correct word?

What do you mean?

news = fetch_20newsgroups() len(news.filenames) # 11314

@eamanu no response here?

qinhanmin2014 · 2018-12-16T15:35:18Z

sklearn/datasets/twenty_newsgroups.py

+        - bunch.filenames: list, length [n_classes]
+        - bunch.DESCR: a description of the dataset.
+        - bunch.target_names: a list of categories of the returned data,
+          length [n_classes]. This depends of the `categories` parameter.


depends on?

qinhanmin2014 · 2018-12-17T02:28:13Z

sklearn/datasets/twenty_newsgroups.py

+    bunch : Bunch object with the following attribute:
+        - bunch.data: sparse matrix, shape [n_samples, n_features]
+        - bunch.target: array, shape [n_samples]
+        - bunch.target_names: list, length [n_samples]


n_classes? copy paste your version from fetch_20newsgroups

Ok, I will do that

…t-learn#12783)

scikit-learn#12783)" This reverts commit 29ac841.

…t-learn#12783)

[WIP] DOC: fix document that fetch_20newsgroups

14bae44

Fix scikit-learn#12777 Related https://github.com/scikit-learn/scikit-learn/pull/12770/files#r241655146

adrinjalali reviewed Dec 14, 2018

View reviewed changes

improve docstring

d4b7c02

eamanu changed the title ~~[WIP] DOC: fix document that fetch_20newsgroups~~ [MRG] DOC: fix document that fetch_20newsgroups Dec 14, 2018

adrinjalali reviewed Dec 14, 2018

View reviewed changes

fix docs

aaeaebf

qinhanmin2014 reviewed Dec 16, 2018

View reviewed changes

fix whitelines on bullets

0f6dac5

qinhanmin2014 reviewed Dec 16, 2018

View reviewed changes

eamanu added 2 commits December 16, 2018 13:38

fix doc

580b3fc

fix docs

082fdc6

qinhanmin2014 reviewed Dec 17, 2018

View reviewed changes

eamanu and others added 2 commits December 16, 2018 23:38

fix doc

0275d02

correction

22f259f

qinhanmin2014 approved these changes Dec 23, 2018

View reviewed changes

qinhanmin2014 merged commit 19a7c08 into scikit-learn:master Dec 23, 2018

adrinjalali pushed a commit to adrinjalali/scikit-learn that referenced this pull request Jan 7, 2019

DOC Document that fetch_20newsgroups also returns target_names (sciki…

097129f

…t-learn#12783)

jnothman pushed a commit to jnothman/scikit-learn that referenced this pull request Feb 19, 2019

DOC Document that fetch_20newsgroups also returns target_names (sciki…

fccea55

…t-learn#12783)

xhluca pushed a commit to xhluca/scikit-learn that referenced this pull request Apr 28, 2019

DOC Document that fetch_20newsgroups also returns target_names (sciki…

29ac841

…t-learn#12783)

xhluca pushed a commit to xhluca/scikit-learn that referenced this pull request Apr 28, 2019

Revert "DOC Document that fetch_20newsgroups also returns target_names (

da5f25f

scikit-learn#12783)" This reverts commit 29ac841.

xhluca pushed a commit to xhluca/scikit-learn that referenced this pull request Apr 28, 2019

Revert "DOC Document that fetch_20newsgroups also returns target_names (

957b464

scikit-learn#12783)" This reverts commit 29ac841.

koenvandevelde pushed a commit to koenvandevelde/scikit-learn that referenced this pull request Jul 12, 2019

DOC Document that fetch_20newsgroups also returns target_names (sciki…

232f508

…t-learn#12783)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MRG] DOC: fix document that fetch_20newsgroups #12783

[MRG] DOC: fix document that fetch_20newsgroups #12783

eamanu commented Dec 14, 2018

adrinjalali Dec 14, 2018

eamanu Dec 14, 2018

adrinjalali Dec 14, 2018

eamanu Dec 14, 2018

adrinjalali Dec 14, 2018

eamanu Dec 16, 2018

adrinjalali Dec 14, 2018

eamanu Dec 16, 2018

eamanu commented Dec 15, 2018 via email

eamanu commented Dec 15, 2018 via email

qinhanmin2014 Dec 16, 2018

eamanu Dec 16, 2018

qinhanmin2014 Dec 16, 2018

eamanu Dec 16, 2018

qinhanmin2014 Dec 17, 2018

qinhanmin2014 Dec 17, 2018

qinhanmin2014 Dec 16, 2018

eamanu Dec 16, 2018

qinhanmin2014 Dec 17, 2018

eamanu Dec 17, 2018


		bunch.DESCR: a description of the dataset.

		bunch.target_names: a list of categories containing in the dataset,

[MRG] DOC: fix document that fetch_20newsgroups #12783

[MRG] DOC: fix document that fetch_20newsgroups #12783

Conversation

eamanu commented Dec 14, 2018

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Any other comments?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eamanu commented Dec 15, 2018 via email

eamanu commented Dec 15, 2018 via email

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment