spark-instrumented-optimizer/python/docs/pyspark.ml.rst
Ilya Matiach 1edb3175d8 [SPARK-21866][ML][PYSPARK] Adding spark image reader
## What changes were proposed in this pull request?
Adding spark image reader, an implementation of schema for representing images in spark DataFrames

The code is taken from the spark package located here:
(https://github.com/Microsoft/spark-images)

Please see the JIRA for more information (https://issues.apache.org/jira/browse/SPARK-21866)

Please see mailing list for SPIP vote and approval information:
(http://apache-spark-developers-list.1001551.n3.nabble.com/VOTE-SPIP-SPARK-21866-Image-support-in-Apache-Spark-td22510.html)

# Background and motivation
As Apache Spark is being used more and more in the industry, some new use cases are emerging for different data formats beyond the traditional SQL types or the numerical types (vectors and matrices). Deep Learning applications commonly deal with image processing. A number of projects add some Deep Learning capabilities to Spark (see list below), but they struggle to communicate with each other or with MLlib pipelines because there is no standard way to represent an image in Spark DataFrames. We propose to federate efforts for representing images in Spark by defining a representation that caters to the most common needs of users and library developers.
This SPIP proposes a specification to represent images in Spark DataFrames and Datasets (based on existing industrial standards), and an interface for loading sources of images. It is not meant to be a full-fledged image processing library, but rather the core description that other libraries and users can rely on. Several packages already offer various processing facilities for transforming images or doing more complex operations, and each has various design tradeoffs that make them better as standalone solutions.
This project is a joint collaboration between Microsoft and Databricks, which have been testing this design in two open source packages: MMLSpark and Deep Learning Pipelines.
The proposed image format is an in-memory, decompressed representation that targets low-level applications. It is significantly more liberal in memory usage than compressed image representations such as JPEG, PNG, etc., but it allows easy communication with popular image processing libraries and has no decoding overhead.

## How was this patch tested?

Unit tests in scala ImageSchemaSuite, unit tests in python

Author: Ilya Matiach <ilmat@microsoft.com>
Author: hyukjinkwon <gurwls223@gmail.com>

Closes #19439 from imatiach-msft/ilmat/spark-images.
2017-11-22 15:45:45 -08:00

115 lines
2.1 KiB
ReStructuredText

pyspark.ml package
==================
ML Pipeline APIs
----------------
.. automodule:: pyspark.ml
:members:
:undoc-members:
:inherited-members:
pyspark.ml.param module
-----------------------
.. automodule:: pyspark.ml.param
:members:
:undoc-members:
:inherited-members:
pyspark.ml.feature module
-------------------------
.. automodule:: pyspark.ml.feature
:members:
:undoc-members:
:inherited-members:
pyspark.ml.classification module
--------------------------------
.. automodule:: pyspark.ml.classification
:members:
:undoc-members:
:inherited-members:
pyspark.ml.clustering module
----------------------------
.. automodule:: pyspark.ml.clustering
:members:
:undoc-members:
:inherited-members:
pyspark.ml.linalg module
----------------------------
.. automodule:: pyspark.ml.linalg
:members:
:undoc-members:
:inherited-members:
pyspark.ml.recommendation module
--------------------------------
.. automodule:: pyspark.ml.recommendation
:members:
:undoc-members:
:inherited-members:
pyspark.ml.regression module
----------------------------
.. automodule:: pyspark.ml.regression
:members:
:undoc-members:
:inherited-members:
pyspark.ml.stat module
----------------------
.. automodule:: pyspark.ml.stat
:members:
:undoc-members:
:inherited-members:
pyspark.ml.tuning module
------------------------
.. automodule:: pyspark.ml.tuning
:members:
:undoc-members:
:inherited-members:
pyspark.ml.evaluation module
----------------------------
.. automodule:: pyspark.ml.evaluation
:members:
:undoc-members:
:inherited-members:
pyspark.ml.fpm module
----------------------------
.. automodule:: pyspark.ml.fpm
:members:
:undoc-members:
:inherited-members:
pyspark.ml.image module
----------------------------
.. automodule:: pyspark.ml.image
:members:
:undoc-members:
:inherited-members:
pyspark.ml.util module
----------------------------
.. automodule:: pyspark.ml.util
:members:
:undoc-members:
:inherited-members: