Skip to content

Commit deb2ce7

Browse files
committed
Move experimental annotation to the top of the docstrings
1 parent bdea0ff commit deb2ce7

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

python/pyspark/ml/fpm.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,11 @@ def getItemsCol(self):
9595

9696

9797
class FPGrowthModel(JavaModel, JavaMLWritable, JavaMLReadable):
98-
"""Model fitted by FPGrowth.
99-
98+
"""
10099
.. note:: Experimental
101100
101+
Model fitted by FPGrowth.
102+
102103
.. versionadded:: 2.2.0
103104
"""
104105
@property
@@ -125,7 +126,10 @@ def associationRules(self):
125126

126127
class FPGrowth(JavaEstimator, HasItemsCol, HasPredictionCol,
127128
HasSupport, HasConfidence, JavaMLWritable, JavaMLReadable):
128-
"""A parallel FP-growth algorithm to mine frequent itemsets. The algorithm is described in
129+
"""
130+
.. note:: Experimental
131+
132+
A parallel FP-growth algorithm to mine frequent itemsets. The algorithm is described in
129133
Li et al., PFP: Parallel FP-Growth for Query Recommendation [LI2008]_.
130134
PFP distributes computation in such a way that each worker executes an
131135
independent group of mining tasks. The FP-Growth algorithm is described in
@@ -134,7 +138,6 @@ class FPGrowth(JavaEstimator, HasItemsCol, HasPredictionCol,
134138
.. [LI2008] http://dx.doi.org/10.1145/1454008.1454027
135139
.. [HAN2000] http://dx.doi.org/10.1145/335191.335372
136140
137-
.. note:: Experimental
138141
.. note:: null values in the feature column are ignored during fit().
139142
.. note:: Internally `transform` `collects` and `broadcasts` association rules.
140143
@@ -181,8 +184,6 @@ class FPGrowth(JavaEstimator, HasItemsCol, HasPredictionCol,
181184
>>> sorted(fpm.transform(new_data).first().prediction)
182185
['x', 'y', 'z']
183186
184-
.. note:: Experimental
185-
186187
.. versionadded:: 2.2.0
187188
"""
188189
@keyword_only

0 commit comments

Comments
 (0)