Skip to content

Conversation

@ehsun7b
Copy link

@ehsun7b ehsun7b commented Mar 16, 2017

What changes were proposed in this pull request?

This is the partial fix for this JIRA: https://issues.apache.org/jira/browse/SPARK-15790

Since annotation has been added to all classes at package org.apache.spark.ml at class level only.
Future work is to add Since annotation at method levels for all classes at org.apache.spark.ml

How was this patch tested?

This fix is documentation stuff. ./dev/run-tests was successful.

Please review http://spark.apache.org/contributing.html before opening a pull request.

@srowen
Copy link
Member

srowen commented Mar 16, 2017

@ehsun7b close this please

@ehsun7b ehsun7b closed this Mar 16, 2017
@ehsun7b
Copy link
Author

ehsun7b commented Mar 16, 2017

Why? @srowen

@srowen
Copy link
Member

srowen commented Mar 16, 2017

This looks like it is from some other project. What is Openet labs? See http://spark.apache.org/contributing.html

@ehsun7b
Copy link
Author

ehsun7b commented Mar 16, 2017

It's our fork of Apache Spark.

@srowen
Copy link
Member

srowen commented Mar 16, 2017

OK. Is this intended as a pull request for upstream Spark? (We get a couple accidental PRs a week where someone intended to open a PR against their fork) Reformat the title and explain a bit more about the change.

@ehsun7b
Copy link
Author

ehsun7b commented Mar 16, 2017

Yes it is for upstream Spark. Our team is going to contribute on fixing Apache Spark bugs or fixing open JIRA tickets for documentations.

@ehsun7b
Copy link
Author

ehsun7b commented Mar 16, 2017

Should I re-open the PR?

@ehsun7b ehsun7b changed the title Openet labs jira spark 15790 Fix for JIRA ticket SPARK-15790 Mar 17, 2017
@ehsun7b ehsun7b reopened this Mar 17, 2017
@ehsun7b
Copy link
Author

ehsun7b commented Mar 17, 2017

I updated the title and provided more details about the change.

@srowen
Copy link
Member

srowen commented Mar 17, 2017

Please fix the title -- see the link I sent you

@ehsun7b ehsun7b changed the title Fix for JIRA ticket SPARK-15790 [SPARK-15790][MLlib] Audit @Since annotations in ML Mar 17, 2017
import org.apache.spark.sql.{DataFrame, Dataset}

@Since("2.0.0")
private[r] class AFTSurvivalRegressionWrapper private (
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here and many files below are private though?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Private classes must not have the annotation?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No real point because the annotations are for end users and these don't appear in APIs or docs

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK,
We have added the annotations already and the versions are very precise because we have developed a tool to find the exact version a class appeared in, for the first time.
Should we remove the annotations from private classes?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, I think just for consistency, we shouldn't mark non-public APIs. Can you re-run this tool but exclude private classes?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we can, but it takes some time... Finding the API is done by the tool, but adding the annotation was done manually.

@AmplabJenkins
Copy link

Can one of the admins verify this patch?

@srowen
Copy link
Member

srowen commented Apr 13, 2017

@ehsun7b is this still active? if it's not a WIP then you can close it for now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants