Skip to content

[SPARK-10274][MLlib] Add @since annotation to pyspark.mllib.fpm #8665

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
yu-iskw wants to merge 4 commits into from
Closed

[SPARK-10274][MLlib] Add @since annotation to pyspark.mllib.fpm #8665

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
babb1ea
[SPARK-10274][MLlib] Add @since annotation to pyspark.mllib.fpm
yu-iskw Sep 9, 2015
0e093f1
Add a since comment to FPGrowthModel manually
yu-iskw Sep 10, 2015
817b168
Fix `addedversion` to `versionadded`
yu-iskw Sep 16, 2015
f1ce652
Add versionadded to FPGrowth and FreqItemset
yu-iskw Sep 17, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion python/pyspark/mllib/fpm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
from numpy import array
from collections import namedtuple

from pyspark import SparkContext
from pyspark import SparkContext, since
from pyspark.rdd import ignore_unicode_prefix
from pyspark.mllib.common import JavaModelWrapper, callMLlibFunc, inherit_doc

Expand All @@ -41,8 +41,11 @@ class FPGrowthModel(JavaModelWrapper):
>>> model = FPGrowth.train(rdd, 0.6, 2)
>>> sorted(model.freqItemsets().collect())
[FreqItemset(items=[u'a'], freq=4), FreqItemset(items=[u'c'], freq=3), ...

.. versionadded:: 1.4.0
"""

@since("1.4.0")
def freqItemsets(self):
"""
Returns the frequent itemsets of this model.
Expand All @@ -55,9 +58,12 @@ class FPGrowth(object):
.. note:: Experimental

A Parallel FP-growth algorithm to mine frequent itemsets.

.. versionadded:: 1.4.0
"""

@classmethod
@since("1.4.0")
def train(cls, data, minSupport=0.3, numPartitions=-1):
"""
Computes an FP-Growth model that contains frequent itemsets.
Expand All @@ -74,6 +80,8 @@ def train(cls, data, minSupport=0.3, numPartitions=-1):
class FreqItemset(namedtuple("FreqItemset", ["items", "freq"])):
"""
Represents an (items, freq) tuple.

.. versionadded:: 1.4.0
"""


Expand Down