@@ -83,6 +83,8 @@ def _sparse_encode(X, dictionary, gram, cov=None, algorithm='lasso_lars',
83
83
positive: boolean
84
84
Whether to enforce a positivity constraint on the sparse code.
85
85
86
+ .. versionadded:: 0.20
87
+
86
88
Returns
87
89
-------
88
90
code : array of shape (n_components, n_features)
@@ -256,6 +258,8 @@ def sparse_encode(X, dictionary, gram=None, cov=None, algorithm='lasso_lars',
256
258
positive : boolean, optional
257
259
Whether to enforce positivity when finding the encoding.
258
260
261
+ .. versionadded:: 0.20
262
+
259
263
Returns
260
264
-------
261
265
code : array of shape (n_samples, n_components)
@@ -358,6 +362,8 @@ def _update_dict(dictionary, Y, code, verbose=False, return_r2=False,
358
362
positive : boolean, optional
359
363
Whether to enforce positivity when finding the dictionary.
360
364
365
+ .. versionadded:: 0.20
366
+
361
367
Returns
362
368
-------
363
369
dictionary : array of shape (n_features, n_components)
@@ -478,9 +484,13 @@ def dict_learning(X, n_components, alpha, max_iter=100, tol=1e-8,
478
484
positive_dict : bool
479
485
Whether to enforce positivity when finding the dictionary.
480
486
487
+ .. versionadded:: 0.20
488
+
481
489
positive_code : bool
482
490
Whether to enforce positivity when finding the code.
483
491
492
+ .. versionadded:: 0.20
493
+
484
494
Returns
485
495
-------
486
496
code : array of shape (n_samples, n_components)
@@ -684,9 +694,13 @@ def dict_learning_online(X, n_components=2, alpha=1, n_iter=100,
684
694
positive_dict : bool
685
695
Whether to enforce positivity when finding the dictionary.
686
696
697
+ .. versionadded:: 0.20
698
+
687
699
positive_code : bool
688
700
Whether to enforce positivity when finding the code.
689
701
702
+ .. versionadded:: 0.20
703
+
690
704
Returns
691
705
-------
692
706
code : array of shape (n_samples, n_components),
@@ -942,6 +956,8 @@ class SparseCoder(BaseEstimator, SparseCodingMixin):
942
956
positive_code : bool
943
957
Whether to enforce positivity when finding the code.
944
958
959
+ .. versionadded:: 0.20
960
+
945
961
Attributes
946
962
----------
947
963
components_ : array, [n_components, n_features]
@@ -1080,9 +1096,13 @@ class DictionaryLearning(BaseEstimator, SparseCodingMixin):
1080
1096
positive_code : bool
1081
1097
Whether to enforce positivity when finding the code.
1082
1098
1099
+ .. versionadded:: 0.20
1100
+
1083
1101
positive_dict : bool
1084
1102
Whether to enforce positivity when finding the dictionary
1085
1103
1104
+ .. versionadded:: 0.20
1105
+
1086
1106
Attributes
1087
1107
----------
1088
1108
components_ : array, [n_components, n_features]
@@ -1256,9 +1276,13 @@ class MiniBatchDictionaryLearning(BaseEstimator, SparseCodingMixin):
1256
1276
positive_code : bool
1257
1277
Whether to enforce positivity when finding the code.
1258
1278
1279
+ .. versionadded:: 0.20
1280
+
1259
1281
positive_dict : bool
1260
1282
Whether to enforce positivity when finding the dictionary.
1261
1283
1284
+ .. versionadded:: 0.20
1285
+
1262
1286
Attributes
1263
1287
----------
1264
1288
components_ : array, [n_components, n_features]
0 commit comments