6ab29b37cf
### What changes were proposed in this pull request? This PR proposes to redesign the PySpark documentation. I made a demo site to make it easier to review: https://hyukjin-spark.readthedocs.io/en/stable/reference/index.html. Here is the initial draft for the final PySpark docs shape: https://hyukjin-spark.readthedocs.io/en/latest/index.html. In more details, this PR proposes: 1. Use [pydata_sphinx_theme](https://github.com/pandas-dev/pydata-sphinx-theme) theme - [pandas](https://pandas.pydata.org/docs/) and [Koalas](https://koalas.readthedocs.io/en/latest/) use this theme. The CSS overwrite is ported from Koalas. The colours in the CSS were actually chosen by designers to use in Spark. 2. Use the Sphinx option to separate `source` and `build` directories as the documentation pages will likely grow. 3. Port current API documentation into the new style. It mimics Koalas and pandas to use the theme most effectively. One disadvantage of this approach is that you should list up APIs or classes; however, I think this isn't a big issue in PySpark since we're being conservative on adding APIs. I also intentionally listed classes only instead of functions in ML and MLlib to make it relatively easier to manage. ### Why are the changes needed? Often I hear the complaints, from the users, that current PySpark documentation is pretty messy to read - https://spark.apache.org/docs/latest/api/python/index.html compared other projects such as [pandas](https://pandas.pydata.org/docs/) and [Koalas](https://koalas.readthedocs.io/en/latest/). It would be nicer if we can make it more organised instead of just listing all classes, methods and attributes to make it easier to navigate. Also, the documentation has been there from almost the very first version of PySpark. Maybe it's time to update it. ### Does this PR introduce _any_ user-facing change? Yes, PySpark API documentation will be redesigned. ### How was this patch tested? Manually tested, and the demo site was made to show. Closes #29188 from HyukjinKwon/SPARK-32179. Authored-by: HyukjinKwon <gurwls223@apache.org> Signed-off-by: HyukjinKwon <gurwls223@apache.org>
364 lines
6.6 KiB
ReStructuredText
364 lines
6.6 KiB
ReStructuredText
.. Licensed to the Apache Software Foundation (ASF) under one
|
|
or more contributor license agreements. See the NOTICE file
|
|
distributed with this work for additional information
|
|
regarding copyright ownership. The ASF licenses this file
|
|
to you under the Apache License, Version 2.0 (the
|
|
"License"); you may not use this file except in compliance
|
|
with the License. You may obtain a copy of the License at
|
|
|
|
.. http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
.. Unless required by applicable law or agreed to in writing,
|
|
software distributed under the License is distributed on an
|
|
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
KIND, either express or implied. See the License for the
|
|
specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
|
|
ML
|
|
==
|
|
|
|
ML Pipeline APIs
|
|
----------------
|
|
|
|
.. currentmodule:: pyspark.ml
|
|
|
|
.. autosummary::
|
|
:template: class_with_docs.rst
|
|
:toctree: api/
|
|
|
|
Transformer
|
|
UnaryTransformer
|
|
Estimator
|
|
Model
|
|
Predictor
|
|
PredictionModel
|
|
Pipeline
|
|
PipelineModel
|
|
|
|
|
|
Parameters
|
|
----------
|
|
|
|
.. currentmodule:: pyspark.ml.param
|
|
|
|
.. autosummary::
|
|
:template: class_with_docs.rst
|
|
:toctree: api/
|
|
|
|
Param
|
|
Params
|
|
TypeConverters
|
|
|
|
|
|
Feature
|
|
-------
|
|
|
|
.. currentmodule:: pyspark.ml.feature
|
|
|
|
.. autosummary::
|
|
:template: class_with_docs.rst
|
|
:toctree: api/
|
|
|
|
ANOVASelector
|
|
ANOVASelectorModel
|
|
Binarizer
|
|
BucketedRandomProjectionLSH
|
|
BucketedRandomProjectionLSHModel
|
|
Bucketizer
|
|
ChiSqSelector
|
|
ChiSqSelectorModel
|
|
CountVectorizer
|
|
CountVectorizerModel
|
|
DCT
|
|
ElementwiseProduct
|
|
FeatureHasher
|
|
FValueSelector
|
|
FValueSelectorModel
|
|
HashingTF
|
|
IDF
|
|
IDFModel
|
|
Imputer
|
|
ImputerModel
|
|
IndexToString
|
|
Interaction
|
|
MaxAbsScaler
|
|
MaxAbsScalerModel
|
|
MinHashLSH
|
|
MinHashLSHModel
|
|
MinMaxScaler
|
|
MinMaxScalerModel
|
|
NGram
|
|
Normalizer
|
|
OneHotEncoder
|
|
OneHotEncoderModel
|
|
PCA
|
|
PCAModel
|
|
PolynomialExpansion
|
|
QuantileDiscretizer
|
|
RobustScaler
|
|
RobustScalerModel
|
|
RegexTokenizer
|
|
RFormula
|
|
RFormulaModel
|
|
SQLTransformer
|
|
StandardScaler
|
|
StandardScalerModel
|
|
StopWordsRemover
|
|
StringIndexer
|
|
StringIndexerModel
|
|
Tokenizer
|
|
VarianceThresholdSelector
|
|
VarianceThresholdSelectorModel
|
|
VectorAssembler
|
|
VectorIndexer
|
|
VectorIndexerModel
|
|
VectorSizeHint
|
|
VectorSlicer
|
|
Word2Vec
|
|
Word2VecModel
|
|
|
|
|
|
Classification
|
|
--------------
|
|
|
|
.. currentmodule:: pyspark.ml.classification
|
|
|
|
.. autosummary::
|
|
:template: class_with_docs.rst
|
|
:toctree: api/
|
|
|
|
LinearSVC
|
|
LinearSVCModel
|
|
LinearSVCSummary
|
|
LinearSVCTrainingSummary
|
|
LogisticRegression
|
|
LogisticRegressionModel
|
|
LogisticRegressionSummary
|
|
LogisticRegressionTrainingSummary
|
|
BinaryLogisticRegressionSummary
|
|
BinaryLogisticRegressionTrainingSummary
|
|
DecisionTreeClassifier
|
|
DecisionTreeClassificationModel
|
|
GBTClassifier
|
|
GBTClassificationModel
|
|
RandomForestClassifier
|
|
RandomForestClassificationModel
|
|
RandomForestClassificationSummary
|
|
RandomForestClassificationTrainingSummary
|
|
BinaryRandomForestClassificationSummary
|
|
BinaryRandomForestClassificationTrainingSummary
|
|
NaiveBayes
|
|
NaiveBayesModel
|
|
MultilayerPerceptronClassifier
|
|
MultilayerPerceptronClassificationModel
|
|
OneVsRest
|
|
OneVsRestModel
|
|
FMClassifier
|
|
FMClassificationModel
|
|
FMClassificationSummary
|
|
FMClassificationTrainingSummary
|
|
|
|
|
|
Clustering
|
|
----------
|
|
|
|
.. currentmodule:: pyspark.ml.clustering
|
|
|
|
.. autosummary::
|
|
:template: class_with_docs.rst
|
|
:toctree: api/
|
|
|
|
BisectingKMeans
|
|
BisectingKMeansModel
|
|
BisectingKMeansSummary
|
|
KMeans
|
|
KMeansModel
|
|
GaussianMixture
|
|
GaussianMixtureModel
|
|
GaussianMixtureSummary
|
|
LDA
|
|
LDAModel
|
|
LocalLDAModel
|
|
DistributedLDAModel
|
|
PowerIterationClustering
|
|
|
|
|
|
ML Functions
|
|
----------------------------
|
|
|
|
.. currentmodule:: pyspark.ml.functions
|
|
|
|
.. autosummary::
|
|
:toctree: api/
|
|
|
|
vector_to_array
|
|
|
|
|
|
Vector and Matrix
|
|
-----------------
|
|
|
|
.. currentmodule:: pyspark.ml.linalg
|
|
|
|
.. autosummary::
|
|
:template: class_with_docs.rst
|
|
:toctree: api/
|
|
|
|
Vector
|
|
DenseVector
|
|
SparseVector
|
|
Vectors
|
|
Matrix
|
|
DenseMatrix
|
|
SparseMatrix
|
|
Matrices
|
|
|
|
|
|
Recommendation
|
|
--------------
|
|
|
|
.. currentmodule:: pyspark.ml.recommendation
|
|
|
|
.. autosummary::
|
|
:template: class_with_docs.rst
|
|
:toctree: api/
|
|
|
|
ALS
|
|
ALSModel
|
|
|
|
|
|
Regression
|
|
----------
|
|
|
|
.. currentmodule:: pyspark.ml.regression
|
|
|
|
.. autosummary::
|
|
:template: class_with_docs.rst
|
|
:toctree: api/
|
|
|
|
AFTSurvivalRegression
|
|
AFTSurvivalRegressionModel
|
|
DecisionTreeRegressor
|
|
DecisionTreeRegressionModel
|
|
GBTRegressor
|
|
GBTRegressionModel
|
|
GeneralizedLinearRegression
|
|
GeneralizedLinearRegressionModel
|
|
GeneralizedLinearRegressionSummary
|
|
GeneralizedLinearRegressionTrainingSummary
|
|
IsotonicRegression
|
|
IsotonicRegressionModel
|
|
LinearRegression
|
|
LinearRegressionModel
|
|
LinearRegressionSummary
|
|
LinearRegressionTrainingSummary
|
|
RandomForestRegressor
|
|
RandomForestRegressionModel
|
|
FMRegressor
|
|
FMRegressionModel
|
|
|
|
|
|
Statistics
|
|
----------
|
|
|
|
.. currentmodule:: pyspark.ml.stat
|
|
|
|
.. autosummary::
|
|
:template: class_with_docs.rst
|
|
:toctree: api/
|
|
|
|
ANOVATest
|
|
ChiSquareTest
|
|
Correlation
|
|
FValueTest
|
|
KolmogorovSmirnovTest
|
|
MultivariateGaussian
|
|
Summarizer
|
|
SummaryBuilder
|
|
|
|
|
|
Tuning
|
|
------
|
|
|
|
.. currentmodule:: pyspark.ml.tuning
|
|
|
|
.. autosummary::
|
|
:template: class_with_docs.rst
|
|
:toctree: api/
|
|
|
|
ParamGridBuilder
|
|
CrossValidator
|
|
CrossValidatorModel
|
|
TrainValidationSplit
|
|
TrainValidationSplitModel
|
|
|
|
|
|
Evaluation
|
|
----------
|
|
|
|
.. currentmodule:: pyspark.ml.evaluation
|
|
|
|
.. autosummary::
|
|
:template: class_with_docs.rst
|
|
:toctree: api/
|
|
|
|
Evaluator
|
|
BinaryClassificationEvaluator
|
|
RegressionEvaluator
|
|
MulticlassClassificationEvaluator
|
|
MultilabelClassificationEvaluator
|
|
ClusteringEvaluator
|
|
RankingEvaluator
|
|
|
|
|
|
Frequency Pattern Mining
|
|
----------------------------
|
|
|
|
.. currentmodule:: pyspark.ml.fpm
|
|
|
|
.. autosummary::
|
|
:template: class_with_docs.rst
|
|
:toctree: api/
|
|
|
|
FPGrowth
|
|
FPGrowthModel
|
|
PrefixSpan
|
|
|
|
|
|
Image
|
|
-----
|
|
|
|
.. currentmodule:: pyspark.ml.image
|
|
|
|
.. autosummary::
|
|
:template: class_with_docs.rst
|
|
:toctree: api/
|
|
|
|
ImageSchema
|
|
_ImageSchema
|
|
|
|
|
|
Utilities
|
|
---------
|
|
|
|
.. currentmodule:: pyspark.ml.util
|
|
|
|
.. autosummary::
|
|
:template: class_with_docs.rst
|
|
:toctree: api/
|
|
|
|
BaseReadWrite
|
|
DefaultParamsReadable
|
|
DefaultParamsReader
|
|
DefaultParamsWritable
|
|
DefaultParamsWriter
|
|
GeneralMLWriter
|
|
HasTrainingSummary
|
|
Identifiable
|
|
MLReadable
|
|
MLReader
|
|
MLWritable
|
|
MLWriter
|
|
|