[MRG] Deprecated 'copy' in TfidfVectorizer.transform #14520

GuillemGSubies · 2019-07-30T15:19:44Z

Reference Issues/PRs

Fixes #14501

What does this implement/fix? Explain your changes.

I just deprecated the param as discussed in the issue

Any other comments?

It was my first deprecation in scikit-learn, I don't know if I might be missing anything.

amueller · 2019-07-30T15:34:11Z

sklearn/feature_extraction/text.py

+        # FIXME Remove copy parameter support in 0.23 -------------------------
+        msg = ("'copy' param has been deprecated since version 0.21. Backward compatibility"
+               "for 'copy' will be removed in 0.23")
+        warnings.warn(msg, eprecationWarning)


Suggested change

warnings.warn(msg, eprecationWarning)

warnings.warn(msg, DeprecationWarning)

amueller · 2019-07-30T15:35:21Z

Pleas see https://scikit-learn.org/dev/developers/contributing.html#deprecation
You should only warn if the parameter was changed from its default.

GuillemGSubies · 2019-07-30T15:42:03Z

I can't see that on the documentation @amueller But it makes sense, we avoid a useless warning.
So I sould only put the fixme comment and the docstring for the method?

amueller · 2019-07-30T16:06:15Z

@GuillemGSubies this is the example from the docs:

def example_function(n_clusters=8, k='not_used'):
    if k != 'not_used':
        warnings.warn("'k' was renamed to n_clusters in version 0.13 and "
                      "will be removed in 0.15.", DeprecationWarning)
        n_clusters = k

instead of "not_used" I'd suggest using "deprecated".

So you set copy='deprecated' and if the user changed it from deprecated to anything else you raise the warning.

GuillemGSubies · 2019-07-31T14:47:21Z

Coverage seems to have decreased, but I don't really know if it is worth if making a test that checks if a deprecation warning has been triggered.

rth

Thanks @GuillemGSubies ! Yes, we need to add a test that this deprecation warning is raised. That could be done by adding a test with,

with pytest.warns(DeprecationWarning, match="some message"):
    # run deprecation code here

rth · 2019-07-31T14:50:44Z

sklearn/feature_extraction/text.py

@@ -1681,13 +1681,20 @@ def transform(self, raw_documents, copy=True):
            Whether to copy X and operate on the copy or perform in-place
            operations.

+        .. deprecated:: 0.21
+            The `copy` parameter was deprecated in version 0.21 and will
+            be removed in 0.23. This parameter will be ignored
        Returns


Please add a whitespace

rth · 2019-07-31T14:50:44Z

sklearn/feature_extraction/text.py

+                   " Backward compatibility for 'copy' will be removed in"
+                   " 0.23.")
+            warnings.warn(msg, DeprecationWarning)
+        # ---------------------------------------------------------------------


Please remove this unnecessary formatting.

rth · 2019-07-31T14:50:44Z

sklearn/feature_extraction/text.py

        Returns
        -------
        X : sparse matrix, [n_samples, n_features]
            Tf-idf-weighted document-term matrix.
        """
        check_is_fitted(self, '_tfidf', 'The tfidf vector is not fitted')
-
+        # FIXME Remove copy parameter support in 0.23 -------------------------


Idem for --- here

sklearn/feature_extraction/tests/test_text.py

Co-Authored-By: Andreas Mueller <t3kcit@gmail.com>

jeremiedbb

It should be deprecated in 0.22 and removed in 0.24 (unless we want to deprecate it in a 0.21 bug fix release but it seems weird).

jeremiedbb · 2019-08-03T08:54:59Z

sklearn/feature_extraction/text.py

@@ -1681,13 +1681,23 @@ def transform(self, raw_documents, copy=True):
            Whether to copy X and operate on the copy or perform in-place
            operations.

+            .. deprecated:: 0.21
+               The `copy` parameter was deprecated in version 0.21 and
+               will be removed in 0.23. This parameter will be ignored


Suggested change

will be removed in 0.23. This parameter will be ignored

will be removed in 0.23. This parameter will be ignored.

jeremiedbb · 2019-08-05T11:13:46Z

lgtm. Please add a what's new entry.

doc/whats_new/v0.22.rst

jnothman · 2019-08-05T22:33:23Z

sklearn/feature_extraction/text.py

        Returns
        -------
        X : sparse matrix, [n_samples, n_features]
            Tf-idf-weighted document-term matrix.
        """
        check_is_fitted(self, '_tfidf', 'The tfidf vector is not fitted')

+        # FIXME Remove copy parameter support in 0.24
+        if copy != "deprecated":
+            msg = ("'copy' param has been deprecated since version 0.22."


Maybe again it would be good to say it's unused

Co-Authored-By: Joel Nothman <joel.nothman@gmail.com>

GuillemGSubies · 2019-08-07T06:17:20Z

This should be ready to merge

jnothman

thanks

doc/whats_new/v0.22.rst

Co-Authored-By: Joel Nothman <joel.nothman@gmail.com>

amueller · 2019-08-07T16:20:46Z

Thanks!

amueller reviewed Jul 30, 2019

View changes

amueller mentioned this pull request Jul 30, 2019

change "not_used" to "deprecated" in contributors guide #14521

Merged

Deprecated 'copy' in TfidfVectorizer.transform

83d2e81

GuillemGSubies force-pushed the master branch from cf12dd9 to 83d2e81 Compare Jul 31, 2019

GuillemGSubies changed the title ~~[WIP] Deprecated 'copy' in TfidfVectorizer.transform~~ [MRG] Deprecated 'copy' in TfidfVectorizer.transform Jul 31, 2019

GuillemGSubies added 2 commits Jul 31, 2019

Update text.py

142747a

Update text.py

7eb23f1

rth reviewed Jul 31, 2019

View changes

GuillemGSubies added 2 commits Jul 31, 2019

Update text.py

b5858f0

Added test

70a2e83

amueller reviewed Jul 31, 2019

View changes

sklearn/feature_extraction/tests/test_text.py Outdated Show resolved Hide resolved

GuillemGSubies and others added 2 commits Aug 1, 2019

Update sklearn/feature_extraction/tests/test_text.py

2c6cb55

Co-Authored-By: Andreas Mueller <t3kcit@gmail.com>

Update test_text.py

26eb579

amueller approved these changes Aug 1, 2019

View changes

jeremiedbb reviewed Aug 3, 2019

View changes

thomasjpfan mentioned this pull request Aug 4, 2019

Copy param ignored in TfidfVectorizer #14501

Closed

GuillemGSubies added 4 commits Aug 4, 2019

Update test_text.py

bb7b366

Update text.py

ba8c36a

Update text.py

6050aee

Update text.py

0b9978a

Update v0.22.rst

58b9f28

jnothman reviewed Aug 5, 2019

View changes

GuillemGSubies and others added 3 commits Aug 6, 2019

Update doc/whats_new/v0.22.rst

5d43a86

Co-Authored-By: Joel Nothman <joel.nothman@gmail.com>

Update test_text.py

a394646

Update text.py

411bb3d

GuillemGSubies added 3 commits Aug 6, 2019

Update text.py

62b8a28

Update text.py

eaccf98

Update test_text.py

43e630e

jnothman approved these changes Aug 7, 2019

View changes

doc/whats_new/v0.22.rst Outdated Show resolved Hide resolved

GuillemGSubies and others added 3 commits Aug 7, 2019

Update doc/whats_new/v0.22.rst

6b9be44

Co-Authored-By: Joel Nothman <joel.nothman@gmail.com>

Update v0.22.rst

eed8439

Merge branch 'master' into master

dc55d97

amueller merged commit deec2ba into scikit-learn:master Aug 7, 2019
15 checks passed

rth mentioned this pull request Aug 26, 2019

fixed copy parameter in TfidfVectorizer #14808

Closed

scikit-learn / scikit-learn Public

[MRG] Deprecated 'copy' in TfidfVectorizer.transform #14520

[MRG] Deprecated 'copy' in TfidfVectorizer.transform #14520

GuillemGSubies commented Jul 30, 2019 •

edited

amueller Jul 30, 2019

amueller commented Jul 30, 2019

GuillemGSubies commented Jul 30, 2019

amueller commented Jul 30, 2019

GuillemGSubies commented Jul 31, 2019

rth left a comment

rth Jul 31, 2019

rth Jul 31, 2019

rth Jul 31, 2019

jeremiedbb left a comment

jeremiedbb Aug 3, 2019

GuillemGSubies Aug 4, 2019

jeremiedbb commented Aug 5, 2019

jnothman Aug 5, 2019

GuillemGSubies commented Aug 7, 2019

jnothman left a comment

amueller commented Aug 7, 2019

	warnings.warn(msg, eprecationWarning)
	warnings.warn(msg, DeprecationWarning)

	will be removed in 0.23. This parameter will be ignored
	will be removed in 0.23. This parameter will be ignored.

scikit-learn / scikit-learn Public

[MRG] Deprecated 'copy' in TfidfVectorizer.transform #14520

[MRG] Deprecated 'copy' in TfidfVectorizer.transform #14520

Conversation

GuillemGSubies commented Jul 30, 2019 • edited

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Any other comments?

amueller Jul 30, 2019

Choose a reason for hiding this comment

amueller commented Jul 30, 2019

GuillemGSubies commented Jul 30, 2019

amueller commented Jul 30, 2019

GuillemGSubies commented Jul 31, 2019

rth left a comment

rth Jul 31, 2019

Choose a reason for hiding this comment

rth Jul 31, 2019

Choose a reason for hiding this comment

rth Jul 31, 2019

Choose a reason for hiding this comment

jeremiedbb left a comment

jeremiedbb Aug 3, 2019

Choose a reason for hiding this comment

GuillemGSubies Aug 4, 2019

Choose a reason for hiding this comment

jeremiedbb commented Aug 5, 2019

jnothman Aug 5, 2019

Choose a reason for hiding this comment

GuillemGSubies commented Aug 7, 2019

jnothman left a comment

amueller commented Aug 7, 2019

GuillemGSubies commented Jul 30, 2019 •

edited