From babb1ea7756eaafe4ebc29fd59ef670e8ed5114f Mon Sep 17 00:00:00 2001 From: Yu ISHIKAWA Date: Wed, 9 Sep 2015 15:04:29 +0900 Subject: [PATCH 1/4] [SPARK-10274][MLlib] Add @since annotation to pyspark.mllib.fpm --- python/pyspark/mllib/fpm.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/python/pyspark/mllib/fpm.py b/python/pyspark/mllib/fpm.py index bdc4a132b1b18..41e30ef867382 100644 --- a/python/pyspark/mllib/fpm.py +++ b/python/pyspark/mllib/fpm.py @@ -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 @@ -43,6 +43,7 @@ class FPGrowthModel(JavaModelWrapper): [FreqItemset(items=[u'a'], freq=4), FreqItemset(items=[u'c'], freq=3), ... """ + @since("1.4.0") def freqItemsets(self): """ Returns the frequent itemsets of this model. @@ -58,6 +59,7 @@ class FPGrowth(object): """ @classmethod + @since("1.4.0") def train(cls, data, minSupport=0.3, numPartitions=-1): """ Computes an FP-Growth model that contains frequent itemsets. From 0e093f193e417479359c1f9f0afe6dd813f87c97 Mon Sep 17 00:00:00 2001 From: Yu ISHIKAWA Date: Thu, 10 Sep 2015 11:13:53 +0900 Subject: [PATCH 2/4] Add a since comment to FPGrowthModel manually --- python/pyspark/mllib/fpm.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/python/pyspark/mllib/fpm.py b/python/pyspark/mllib/fpm.py index 41e30ef867382..a6c8c229dfdc0 100644 --- a/python/pyspark/mllib/fpm.py +++ b/python/pyspark/mllib/fpm.py @@ -41,6 +41,8 @@ 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), ... + + .. addedversion:: 1.4.0 """ @since("1.4.0") From 817b168117493d7c93fa9491a64f1d1cc745cada Mon Sep 17 00:00:00 2001 From: Yu ISHIKAWA Date: Wed, 16 Sep 2015 17:11:59 +0900 Subject: [PATCH 3/4] Fix `addedversion` to `versionadded` --- python/pyspark/mllib/fpm.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python/pyspark/mllib/fpm.py b/python/pyspark/mllib/fpm.py index a6c8c229dfdc0..0e399fcbdae89 100644 --- a/python/pyspark/mllib/fpm.py +++ b/python/pyspark/mllib/fpm.py @@ -42,7 +42,7 @@ class FPGrowthModel(JavaModelWrapper): >>> sorted(model.freqItemsets().collect()) [FreqItemset(items=[u'a'], freq=4), FreqItemset(items=[u'c'], freq=3), ... - .. addedversion:: 1.4.0 + .. versionadded:: 1.4.0 """ @since("1.4.0") From f1ce6520f338205605cb01ed0a2d7214e4d69e29 Mon Sep 17 00:00:00 2001 From: Yu ISHIKAWA Date: Thu, 17 Sep 2015 16:16:32 +0900 Subject: [PATCH 4/4] Add versionadded to FPGrowth and FreqItemset --- python/pyspark/mllib/fpm.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/python/pyspark/mllib/fpm.py b/python/pyspark/mllib/fpm.py index 0e399fcbdae89..bdabba9602a8c 100644 --- a/python/pyspark/mllib/fpm.py +++ b/python/pyspark/mllib/fpm.py @@ -58,6 +58,8 @@ class FPGrowth(object): .. note:: Experimental A Parallel FP-growth algorithm to mine frequent itemsets. + + .. versionadded:: 1.4.0 """ @classmethod @@ -78,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 """