spark-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Joseph K. Bradley (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (SPARK-14813) ML 2.0 QA: API: Python API coverage
Date Thu, 28 Apr 2016 22:14:13 GMT

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

Joseph K. Bradley updated SPARK-14813:
--------------------------------------
    Description: 
For new public APIs added to MLlib, we need to check the generated HTML doc and compare the
Scala & Python versions.  We need to track:
* Inconsistency: Do class/method/parameter names match?
* Docs: Is the Python doc missing or just a stub?  We want the Python doc to be as complete
as the Scala doc.
* API breaking changes: These should be very rare but are occasionally either necessary (intentional)
or accidental.  These must be recorded and added in the Migration Guide for this release.
** Note: If the API change is for an Alpha/Experimental/DeveloperApi component, please note
that as well.
* Missing classes/methods/parameters: We should create to-do JIRAs for functionality missing
from Python, to be added in the next release cycle.  Please use a *separate* JIRA (linked
below) for this list of to-do items.

UPDATE: This only needs to cover spark.ml since spark.mllib is going into maintenance mode.

  was:
For new public APIs added to MLlib, we need to check the generated HTML doc and compare the
Scala & Python versions.  We need to track:
* Inconsistency: Do class/method/parameter names match?
* Docs: Is the Python doc missing or just a stub?  We want the Python doc to be as complete
as the Scala doc.
* API breaking changes: These should be very rare but are occasionally either necessary (intentional)
or accidental.  These must be recorded and added in the Migration Guide for this release.
** Note: If the API change is for an Alpha/Experimental/DeveloperApi component, please note
that as well.
* Missing classes/methods/parameters: We should create to-do JIRAs for functionality missing
from Python, to be added in the next release cycle.  Please use a *separate* JIRA (linked
below) for this list of to-do items.


> ML 2.0 QA: API: Python API coverage
> -----------------------------------
>
>                 Key: SPARK-14813
>                 URL: https://issues.apache.org/jira/browse/SPARK-14813
>             Project: Spark
>          Issue Type: Sub-task
>          Components: Documentation, ML, PySpark
>            Reporter: Joseph K. Bradley
>
> For new public APIs added to MLlib, we need to check the generated HTML doc and compare
the Scala & Python versions.  We need to track:
> * Inconsistency: Do class/method/parameter names match?
> * Docs: Is the Python doc missing or just a stub?  We want the Python doc to be as complete
as the Scala doc.
> * API breaking changes: These should be very rare but are occasionally either necessary
(intentional) or accidental.  These must be recorded and added in the Migration Guide for
this release.
> ** Note: If the API change is for an Alpha/Experimental/DeveloperApi component, please
note that as well.
> * Missing classes/methods/parameters: We should create to-do JIRAs for functionality
missing from Python, to be added in the next release cycle.  Please use a *separate* JIRA
(linked below) for this list of to-do items.
> UPDATE: This only needs to cover spark.ml since spark.mllib is going into maintenance
mode.



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

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


Mime
View raw message