891c5e661a
### What changes were proposed in this pull request? The class `KMeansSummary` in pyspark is not included in `clustering.py`'s `__all__` declaration. It isn't included in the docs as a result. `InheritableThread` and `KMeansSummary` should be into corresponding RST files for documentation. ### Why are the changes needed? It seems like an oversight to not include this as all similar "summary" classes are. `InheritableThread` should also be documented. ### Does this PR introduce _any_ user-facing change? I don't believe there are functional changes. It should make this public class appear in docs. ### How was this patch tested? Existing tests / N/A. Closes #29470 from srowen/KMeansSummary. Lead-authored-by: Sean Owen <srowen@gmail.com> Co-authored-by: HyukjinKwon <gurwls223@apache.org> Signed-off-by: HyukjinKwon <gurwls223@apache.org>
367 lines
6.7 KiB
ReStructuredText
367 lines
6.7 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
|
|
MultilayerPerceptronClassificationSummary
|
|
MultilayerPerceptronClassificationTrainingSummary
|
|
OneVsRest
|
|
OneVsRestModel
|
|
FMClassifier
|
|
FMClassificationModel
|
|
FMClassificationSummary
|
|
FMClassificationTrainingSummary
|
|
|
|
|
|
Clustering
|
|
----------
|
|
|
|
.. currentmodule:: pyspark.ml.clustering
|
|
|
|
.. autosummary::
|
|
:template: class_with_docs.rst
|
|
:toctree: api/
|
|
|
|
BisectingKMeans
|
|
BisectingKMeansModel
|
|
BisectingKMeansSummary
|
|
KMeans
|
|
KMeansModel
|
|
KMeansSummary
|
|
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
|
|
|