Skip to content
Apache Spark
Scala Java Python HiveQL R TSQL Other
Branch: master
Clone or download
huaxingao and srowen [SPARK-28985][PYTHON][ML] Add common classes (JavaPredictor/JavaClass…
…ificationModel/JavaProbabilisticClassifier) in PYTHON

### What changes were proposed in this pull request?

Add some common classes in Python to make it have the same structure as Scala

1. Scala has ClassifierParams/Classifier/ClassificationModel:

```
trait ClassifierParams
    extends PredictorParams with HasRawPredictionCol

abstract class Classifier
    extends Predictor with ClassifierParams {
    def setRawPredictionCol
}

abstract class ClassificationModel
  extends PredictionModel with ClassifierParams {
    def setRawPredictionCol
}

```
This PR makes Python has the following:

```
class JavaClassifierParams(HasRawPredictionCol, JavaPredictorParams):
    pass

class JavaClassifier(JavaPredictor, JavaClassifierParams):
    def setRawPredictionCol

class JavaClassificationModel(JavaPredictionModel, JavaClassifierParams):
    def setRawPredictionCol
```
2. Scala has ProbabilisticClassifierParams/ProbabilisticClassifier/ProbabilisticClassificationModel:
```
trait ProbabilisticClassifierParams
    extends ClassifierParams with HasProbabilityCol with HasThresholds

abstract class ProbabilisticClassifier
    extends Classifier with ProbabilisticClassifierParams {
    def setProbabilityCol
    def setThresholds
}

abstract class ProbabilisticClassificationModel
    extends ClassificationModel with ProbabilisticClassifierParams {
    def setProbabilityCol
    def setThresholds
}
```
This PR makes Python have the following:
```
class JavaProbabilisticClassifierParams(HasProbabilityCol, HasThresholds, JavaClassifierParams):
    pass

class JavaProbabilisticClassifier(JavaClassifier, JavaProbabilisticClassifierParams):
    def setProbabilityCol
    def setThresholds

class JavaProbabilisticClassificationModel(JavaClassificationModel, JavaProbabilisticClassifierParams):
    def setProbabilityCol
    def setThresholds
```
3. Scala has PredictorParams/Predictor/PredictionModel:
```
trait PredictorParams extends Params
    with HasLabelCol with HasFeaturesCol with HasPredictionCol

abstract class Predictor
    extends Estimator with PredictorParams {
    def setLabelCol
    def setFeaturesCol
    def setPredictionCol
  }

abstract class PredictionModel
    extends Model with PredictorParams {
    def setFeaturesCol
    def setPredictionCol
    def numFeatures
    def predict
}
```
This PR makes Python have the following:
```
class JavaPredictorParams(HasLabelCol, HasFeaturesCol, HasPredictionCol):
    pass

class JavaPredictor(JavaEstimator, JavaPredictorParams):
    def setLabelCol
    def setFeaturesCol
    def setPredictionCol

class JavaPredictionModel(JavaModel, JavaPredictorParams):
    def setFeaturesCol
    def setPredictionCol
    def numFeatures
    def predict
```

### Why are the changes needed?
Have parity between Python and Scala ML

### Does this PR introduce any user-facing change?
Yes. Add the following changes:

```
LinearSVCModel

- get/setFeatureCol
- get/setPredictionCol
- get/setLabelCol
- get/setRawPredictionCol
- predict
```

```
LogisticRegressionModel
DecisionTreeClassificationModel
RandomForestClassificationModel
GBTClassificationModel
NaiveBayesModel
MultilayerPerceptronClassificationModel

- get/setFeatureCol
- get/setPredictionCol
- get/setLabelCol
- get/setRawPredictionCol
- get/setProbabilityCol
- predict
```
```
LinearRegressionModel
IsotonicRegressionModel
DecisionTreeRegressionModel
RandomForestRegressionModel
GBTRegressionModel
AFTSurvivalRegressionModel
GeneralizedLinearRegressionModel

- get/setFeatureCol
- get/setPredictionCol
- get/setLabelCol
- predict
```

### How was this patch tested?
Add a few doc tests.

Closes #25776 from huaxingao/spark-28985.

Authored-by: Huaxin Gao <huaxing@us.ibm.com>
Signed-off-by: Sean Owen <sean.owen@databricks.com>
Latest commit e97b55d Sep 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github [SPARK-29159][BUILD] Increase ReservedCodeCacheSize to 1G Sep 19, 2019
R [SPARK-28927][ML] Rethrow block mismatch exception in ALS when input … Sep 18, 2019
assembly [SPARK-27300][GRAPH] Add Spark Graph modules and dependencies Jun 9, 2019
bin [SPARK-28525][DEPLOY] Allow Launcher to be applied Java options Jul 30, 2019
build [SPARK-29159][BUILD] Increase ReservedCodeCacheSize to 1G Sep 19, 2019
common [SPARK-28932][BUILD][FOLLOWUP] Switch to scala-library compile depend… Sep 16, 2019
conf [SPARK-29032][CORE] Add PrometheusServlet to monitor Master/Worker/Dr… Sep 13, 2019
core [SPARK-29082][CORE] Skip delegation token generation if no credential… Sep 18, 2019
data [SPARK-22666][ML][SQL] Spark datasource for image format Sep 5, 2018
dev [SPARK-29159][BUILD] Increase ReservedCodeCacheSize to 1G Sep 19, 2019
docs [SPARK-29159][BUILD] Increase ReservedCodeCacheSize to 1G Sep 19, 2019
examples [SPARK-28980][CORE][SQL][STREAMING][MLLIB] Remove most items deprecat… Sep 9, 2019
external [SPARK-29141][SQL][TEST] Use SqlBasedBenchmark in SQL benchmarks Sep 19, 2019
graph [SPARK-27300][GRAPH] Add Spark Graph modules and dependencies Jun 9, 2019
graphx [SPARK-29042][CORE] Sampling-based RDD with unordered input should be… Sep 13, 2019
hadoop-cloud [SPARK-28903][STREAMING][PYSPARK][TESTS] Fix AWS JDK version conflict… Aug 31, 2019
launcher [SPARK-29080][CORE][SPARKR] Support R file extension case-insensitively Sep 15, 2019
licenses-binary [SPARK-28737][CORE] Update Jersey to 2.29 Aug 16, 2019
licenses [SPARK-27557][DOC] Add copy button to Python API docs for easier copy… May 1, 2019
mllib-local [SPARK-28421][ML] SparseVector.apply performance optimization Jul 24, 2019
mllib [SPARK-29118][ML] Avoid redundant computation in transform of GMM & GLR Sep 18, 2019
project [SPARK-28683][BUILD] Upgrade Scala to 2.12.10 Sep 18, 2019
python [SPARK-28985][PYTHON][ML] Add common classes (JavaPredictor/JavaClass… Sep 19, 2019
repl [SPARK-28601][CORE][SQL] Use StandardCharsets.UTF_8 instead of "UTF-8… Aug 6, 2019
resource-managers [SPARK-29159][BUILD] Increase ReservedCodeCacheSize to 1G Sep 19, 2019
sbin [SPARK-28164] Fix usage description of `start-slave.sh` Jun 26, 2019
sql [SPARK-28989][SQL] Add a SQLConf `spark.sql.ansi.enabled` Sep 19, 2019
streaming [SPARK-29105][CORE] Keep driver log file size up to date in HDFS Sep 18, 2019
tools [SPARK-25956] Make Scala 2.12 as default Scala version in Spark 3.0 Nov 15, 2018
.gitattributes [SPARK-3870] EOL character enforcement Oct 31, 2014
.gitignore [SPARK-27371][CORE] Support GPU-aware resources scheduling in Standalone Aug 9, 2019
CONTRIBUTING.md [MINOR][DOCS] Tighten up some key links to the project and download p… May 21, 2019
LICENSE [SPARK-27557][DOC] Add copy button to Python API docs for easier copy… May 1, 2019
LICENSE-binary [SPARK-28921][BUILD][K8S] Upgrade kubernetes client to 4.4.2 Sep 2, 2019
NOTICE [SPARK-23654][BUILD] remove jets3t as a dependency of spark Aug 16, 2018
NOTICE-binary [SPARK-17875][CORE][BUILD] Remove dependency on Netty 3 Aug 22, 2019
README.md [SPARK-28473][DOC] Stylistic consistency of build command in README Jul 23, 2019
appveyor.yml [SPARK-28759][BUILD] Upgrade scala-maven-plugin to 4.2.0 and fix buil… Aug 30, 2019
pom.xml [SPARK-29159][BUILD] Increase ReservedCodeCacheSize to 1G Sep 19, 2019
scalastyle-config.xml [SPARK-25986][BUILD] Add rules to ban throw Errors in application code Nov 14, 2018

README.md

Apache Spark

Spark is a unified analytics engine for large-scale data processing. It provides high-level APIs in Scala, Java, Python, and R, and an optimized engine that supports general computation graphs for data analysis. It also supports a rich set of higher-level tools including Spark SQL for SQL and DataFrames, MLlib for machine learning, GraphX for graph processing, and Structured Streaming for stream processing.

https://spark.apache.org/

Jenkins Build AppVeyor Build PySpark Coverage

Online Documentation

You can find the latest Spark documentation, including a programming guide, on the project web page. This README file only contains basic setup instructions.

Building Spark

Spark is built using Apache Maven. To build Spark and its example programs, run:

./build/mvn -DskipTests clean package

(You do not need to do this if you downloaded a pre-built package.)

You can build Spark using more than one thread by using the -T option with Maven, see "Parallel builds in Maven 3". More detailed documentation is available from the project site, at "Building Spark".

For general development tips, including info on developing Spark using an IDE, see "Useful Developer Tools".

Interactive Scala Shell

The easiest way to start using Spark is through the Scala shell:

./bin/spark-shell

Try the following command, which should return 1,000,000,000:

scala> spark.range(1000 * 1000 * 1000).count()

Interactive Python Shell

Alternatively, if you prefer Python, you can use the Python shell:

./bin/pyspark

And run the following command, which should also return 1,000,000,000:

>>> spark.range(1000 * 1000 * 1000).count()

Example Programs

Spark also comes with several sample programs in the examples directory. To run one of them, use ./bin/run-example <class> [params]. For example:

./bin/run-example SparkPi

will run the Pi example locally.

You can set the MASTER environment variable when running examples to submit examples to a cluster. This can be a mesos:// or spark:// URL, "yarn" to run on YARN, and "local" to run locally with one thread, or "local[N]" to run locally with N threads. You can also use an abbreviated class name if the class is in the examples package. For instance:

MASTER=spark://host:7077 ./bin/run-example SparkPi

Many of the example programs print usage help if no params are given.

Running Tests

Testing first requires building Spark. Once Spark is built, tests can be run using:

./dev/run-tests

Please see the guidance on how to run tests for a module, or individual tests.

There is also a Kubernetes integration test, see resource-managers/kubernetes/integration-tests/README.md

A Note About Hadoop Versions

Spark uses the Hadoop core library to talk to HDFS and other Hadoop-supported storage systems. Because the protocols have changed in different versions of Hadoop, you must build Spark against the same version that your cluster runs.

Please refer to the build documentation at "Specifying the Hadoop Version and Enabling YARN" for detailed guidance on building for a particular distribution of Hadoop, including building for particular Hive and Hive Thriftserver distributions.

Configuration

Please refer to the Configuration Guide in the online documentation for an overview on how to configure Spark.

Contributing

Please review the Contribution to Spark guide for information on how to get started contributing to the project.

You can’t perform that action at this time.