[ 
https://issues.apache.org/jira/browse/SPARK-7751?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Xiangrui Meng updated SPARK-7751:
---------------------------------
    Description: 
This is useful to check whether a feature exists in some version of Spark. This 
is an umbrella JIRA to track the progress. We want to have -@since tag- @Since 
annotation for both stable (those without any 
Experimental/DeveloperApi/AlphaComponent annotations) and experimental methods 
in MLlib:

(Do NOT tag private or package private classes or methods, nor local variables 
and methods.)

* an example PR for Scala: https://github.com/apache/spark/pull/8309

We need to dig the history of git commit to figure out what was the Spark 
version when a method was first introduced. Take `NaiveBayes.setModelType` as 
an example. We can grep `def setModelType` at different version git tags.

{code}
meng@xm:~/src/spark
$ git show 
v1.3.0:mllib/src/main/scala/org/apache/spark/mllib/classification/NaiveBayes.scala
 | grep "def setModelType"
meng@xm:~/src/spark
$ git show 
v1.4.0:mllib/src/main/scala/org/apache/spark/mllib/classification/NaiveBayes.scala
 | grep "def setModelType"
  def setModelType(modelType: String): NaiveBayes = {
{code}

If there are better ways, please let us know.

We cannot add all -@since tags- @Since annotation in a single PR, which is hard 
to review. So we made some subtasks for each package, for example 
`org.apache.spark.classification`. Feel free to add more sub-tasks for Python 
and the `spark.ml` package.

  was:
This is useful to check whether a feature exists in some version of Spark. This 
is an umbrella JIRA to track the progress. We want to have ~~@since tag~~ 
@Since annotation for both stable (those without any 
Experimental/DeveloperApi/AlphaComponent annotations) and experimental methods 
in MLlib:

(Do NOT tag private or package private classes or methods, nor local variables 
and methods.)

* an example PR for Scala: https://github.com/apache/spark/pull/8309

We need to dig the history of git commit to figure out what was the Spark 
version when a method was first introduced. Take `NaiveBayes.setModelType` as 
an example. We can grep `def setModelType` at different version git tags.

{code}
meng@xm:~/src/spark
$ git show 
v1.3.0:mllib/src/main/scala/org/apache/spark/mllib/classification/NaiveBayes.scala
 | grep "def setModelType"
meng@xm:~/src/spark
$ git show 
v1.4.0:mllib/src/main/scala/org/apache/spark/mllib/classification/NaiveBayes.scala
 | grep "def setModelType"
  def setModelType(modelType: String): NaiveBayes = {
{code}

If there are better ways, please let us know.

We cannot add all ~~@since tags~~ @Since annotation in a single PR, which is 
hard to review. So we made some subtasks for each package, for example 
`org.apache.spark.classification`. Feel free to add more sub-tasks for Python 
and the `spark.ml` package.


> Add @Since annotation to stable and experimental methods in MLlib
> -----------------------------------------------------------------
>
>                 Key: SPARK-7751
>                 URL: https://issues.apache.org/jira/browse/SPARK-7751
>             Project: Spark
>          Issue Type: Umbrella
>          Components: Documentation, MLlib
>    Affects Versions: 1.4.0
>            Reporter: Xiangrui Meng
>            Assignee: Xiangrui Meng
>            Priority: Minor
>              Labels: starter
>
> This is useful to check whether a feature exists in some version of Spark. 
> This is an umbrella JIRA to track the progress. We want to have -@since tag- 
> @Since annotation for both stable (those without any 
> Experimental/DeveloperApi/AlphaComponent annotations) and experimental 
> methods in MLlib:
> (Do NOT tag private or package private classes or methods, nor local 
> variables and methods.)
> * an example PR for Scala: https://github.com/apache/spark/pull/8309
> We need to dig the history of git commit to figure out what was the Spark 
> version when a method was first introduced. Take `NaiveBayes.setModelType` as 
> an example. We can grep `def setModelType` at different version git tags.
> {code}
> meng@xm:~/src/spark
> $ git show 
> v1.3.0:mllib/src/main/scala/org/apache/spark/mllib/classification/NaiveBayes.scala
>  | grep "def setModelType"
> meng@xm:~/src/spark
> $ git show 
> v1.4.0:mllib/src/main/scala/org/apache/spark/mllib/classification/NaiveBayes.scala
>  | grep "def setModelType"
>   def setModelType(modelType: String): NaiveBayes = {
> {code}
> If there are better ways, please let us know.
> We cannot add all -@since tags- @Since annotation in a single PR, which is 
> hard to review. So we made some subtasks for each package, for example 
> `org.apache.spark.classification`. Feel free to add more sub-tasks for Python 
> and the `spark.ml` package.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org

Reply via email to