This is the class and function reference of scikit-learn. Please refer to the :ref:`full user guide <user_guide>` for further details, as the class and function raw specifications may not be enough to give full guidelines on their uses.
:mod:`sklearn.base`: Base classes and utility functions
.. automodule:: sklearn.base
:no-members:
:no-inherited-members:
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst base.BaseEstimator base.ClassifierMixin base.ClusterMixin base.RegressorMixin base.TransformerMixin
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: function.rst base.clone
:mod:`sklearn.cluster`: Clustering
.. automodule:: sklearn.cluster :no-members: :no-inherited-members:
User guide: See the :ref:`clustering` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst cluster.AffinityPropagation cluster.AgglomerativeClustering cluster.DBSCAN cluster.FeatureAgglomeration cluster.KMeans cluster.MiniBatchKMeans cluster.MeanShift cluster.SpectralClustering cluster.Ward
.. autosummary:: :toctree: generated/ :template: function.rst cluster.estimate_bandwidth cluster.k_means cluster.ward_tree cluster.affinity_propagation cluster.dbscan cluster.mean_shift cluster.spectral_clustering
:mod:`sklearn.cluster.bicluster`: Biclustering
.. automodule:: sklearn.cluster.bicluster :no-members: :no-inherited-members:
User guide: See the :ref:`biclustering` section for further details.
.. currentmodule:: sklearn.cluster.bicluster
.. autosummary:: :toctree: generated/ :template: class.rst SpectralBiclustering SpectralCoclustering
:mod:`sklearn.covariance`: Covariance Estimators
.. automodule:: sklearn.covariance :no-members: :no-inherited-members:
User guide: See the :ref:`covariance` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst covariance.EmpiricalCovariance covariance.EllipticEnvelope covariance.GraphLasso covariance.GraphLassoCV covariance.LedoitWolf covariance.MinCovDet covariance.OAS covariance.ShrunkCovariance
.. autosummary:: :toctree: generated/ :template: function.rst covariance.empirical_covariance covariance.ledoit_wolf covariance.shrunk_covariance covariance.oas covariance.graph_lasso
:mod:`sklearn.cross_validation`: Cross Validation
.. automodule:: sklearn.cross_validation :no-members: :no-inherited-members:
User guide: See the :ref:`cross_validation` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst cross_validation.KFold cross_validation.LeaveOneLabelOut cross_validation.LeaveOneOut cross_validation.LeavePLabelOut cross_validation.LeavePOut cross_validation.StratifiedKFold cross_validation.ShuffleSplit cross_validation.StratifiedShuffleSplit
.. autosummary:: :toctree: generated/ :template: function.rst cross_validation.train_test_split cross_validation.cross_val_score cross_validation.permutation_test_score cross_validation.check_cv
:mod:`sklearn.datasets`: Datasets
.. automodule:: sklearn.datasets :no-members: :no-inherited-members:
User guide: See the :ref:`datasets` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: function.rst datasets.fetch_20newsgroups datasets.fetch_20newsgroups_vectorized datasets.load_boston datasets.load_diabetes datasets.load_digits datasets.load_files datasets.load_iris datasets.load_lfw_pairs datasets.fetch_lfw_pairs datasets.load_lfw_people datasets.fetch_lfw_people datasets.load_linnerud datasets.fetch_mldata datasets.fetch_olivetti_faces datasets.fetch_california_housing datasets.fetch_covtype datasets.load_mlcomp datasets.load_sample_image datasets.load_sample_images datasets.load_svmlight_file datasets.dump_svmlight_file
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: function.rst datasets.make_blobs datasets.make_classification datasets.make_circles datasets.make_friedman1 datasets.make_friedman2 datasets.make_friedman3 datasets.make_gaussian_quantiles datasets.make_hastie_10_2 datasets.make_low_rank_matrix datasets.make_moons datasets.make_multilabel_classification datasets.make_regression datasets.make_s_curve datasets.make_sparse_coded_signal datasets.make_sparse_spd_matrix datasets.make_sparse_uncorrelated datasets.make_spd_matrix datasets.make_swiss_roll datasets.make_biclusters datasets.make_checkerboard
:mod:`sklearn.decomposition`: Matrix Decomposition
.. automodule:: sklearn.decomposition :no-members: :no-inherited-members:
User guide: See the :ref:`decompositions` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst decomposition.PCA decomposition.ProjectedGradientNMF decomposition.RandomizedPCA decomposition.KernelPCA decomposition.FactorAnalysis decomposition.FastICA decomposition.TruncatedSVD decomposition.NMF decomposition.SparsePCA decomposition.MiniBatchSparsePCA decomposition.SparseCoder decomposition.DictionaryLearning decomposition.MiniBatchDictionaryLearning
.. autosummary:: :toctree: generated/ :template: function.rst decomposition.fastica decomposition.dict_learning decomposition.dict_learning_online decomposition.sparse_encode
:mod:`sklearn.dummy`: Dummy estimators
.. automodule:: sklearn.dummy :no-members: :no-inherited-members:
User guide: See the :ref:`model_evaluation` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst dummy.DummyClassifier dummy.DummyRegressor
.. autosummary:: :toctree: generated/ :template: function.rst
:mod:`sklearn.ensemble`: Ensemble Methods
.. automodule:: sklearn.ensemble :no-members: :no-inherited-members:
User guide: See the :ref:`ensemble` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst ensemble.AdaBoostClassifier ensemble.AdaBoostRegressor ensemble.BaggingClassifier ensemble.BaggingRegressor ensemble.ExtraTreesClassifier ensemble.ExtraTreesRegressor ensemble.GradientBoostingClassifier ensemble.GradientBoostingRegressor ensemble.RandomForestClassifier ensemble.RandomTreesEmbedding ensemble.RandomForestRegressor
.. autosummary:: :toctree: generated/ :template: function.rst
.. automodule:: sklearn.ensemble.partial_dependence :no-members: :no-inherited-members:
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: function.rst ensemble.partial_dependence.partial_dependence ensemble.partial_dependence.plot_partial_dependence
:mod:`sklearn.feature_extraction`: Feature Extraction
.. automodule:: sklearn.feature_extraction :no-members: :no-inherited-members:
User guide: See the :ref:`feature_extraction` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst feature_extraction.DictVectorizer feature_extraction.FeatureHasher
.. automodule:: sklearn.feature_extraction.image :no-members: :no-inherited-members:
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: function.rst feature_extraction.image.img_to_graph feature_extraction.image.grid_to_graph feature_extraction.image.extract_patches_2d feature_extraction.image.reconstruct_from_patches_2d :template: class.rst feature_extraction.image.PatchExtractor
.. automodule:: sklearn.feature_extraction.text :no-members: :no-inherited-members:
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst feature_extraction.text.CountVectorizer feature_extraction.text.HashingVectorizer feature_extraction.text.TfidfTransformer feature_extraction.text.TfidfVectorizer
:mod:`sklearn.feature_selection`: Feature Selection
.. automodule:: sklearn.feature_selection :no-members: :no-inherited-members:
User guide: See the :ref:`feature_selection` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst feature_selection.GenericUnivariateSelect feature_selection.SelectPercentile feature_selection.SelectKBest feature_selection.SelectFpr feature_selection.SelectFdr feature_selection.SelectFwe feature_selection.RFE feature_selection.RFECV feature_selection.VarianceThreshold
.. autosummary:: :toctree: generated/ :template: function.rst feature_selection.chi2 feature_selection.f_classif feature_selection.f_regression
:mod:`sklearn.gaussian_process`: Gaussian Processes
.. automodule:: sklearn.gaussian_process :no-members: :no-inherited-members:
User guide: See the :ref:`gaussian_process` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst gaussian_process.GaussianProcess
.. autosummary:: :toctree: generated :template: function.rst gaussian_process.correlation_models.absolute_exponential gaussian_process.correlation_models.squared_exponential gaussian_process.correlation_models.generalized_exponential gaussian_process.correlation_models.pure_nugget gaussian_process.correlation_models.cubic gaussian_process.correlation_models.linear gaussian_process.regression_models.constant gaussian_process.regression_models.linear gaussian_process.regression_models.quadratic
:mod:`sklearn.grid_search`: Grid Search
.. automodule:: sklearn.grid_search :no-members: :no-inherited-members:
User guide: See the :ref:`grid_search` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst grid_search.GridSearchCV grid_search.ParameterGrid grid_search.ParameterSampler grid_search.RandomizedSearchCV
:mod:`sklearn.isotonic`: Isotonic regression
.. automodule:: sklearn.isotonic :no-members: :no-inherited-members:
User guide: See the :ref:`isotonic` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst isotonic.IsotonicRegression
.. autosummary:: :toctree: generated :template: function.rst isotonic.isotonic_regression isotonic.check_increasing
:mod:`sklearn.kernel_approximation` Kernel Approximation
.. automodule:: sklearn.kernel_approximation :no-members: :no-inherited-members:
User guide: See the :ref:`kernel_approximation` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst kernel_approximation.AdditiveChi2Sampler kernel_approximation.Nystroem kernel_approximation.RBFSampler kernel_approximation.SkewedChi2Sampler
:mod:`sklearn.lda`: Linear Discriminant Analysis
.. automodule:: sklearn.lda :no-members: :no-inherited-members:
User guide: See the :ref:`lda_qda` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated :template: class.rst lda.LDA
:mod:`sklearn.learning_curve` Learning curve evaluation
.. automodule:: sklearn.learning_curve :no-members: :no-inherited-members:
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: function.rst learning_curve.learning_curve learning_curve.validation_curve
:mod:`sklearn.linear_model`: Generalized Linear Models
.. automodule:: sklearn.linear_model :no-members: :no-inherited-members:
User guide: See the :ref:`linear_model` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst linear_model.ARDRegression linear_model.BayesianRidge linear_model.ElasticNet linear_model.ElasticNetCV linear_model.Lars linear_model.LarsCV linear_model.Lasso linear_model.LassoCV linear_model.LassoLars linear_model.LassoLarsCV linear_model.LassoLarsIC linear_model.LinearRegression linear_model.LogisticRegression linear_model.LogisticRegressionCV linear_model.MultiTaskLasso linear_model.MultiTaskElasticNet linear_model.MultiTaskLassoCV linear_model.MultiTaskElasticNetCV linear_model.OrthogonalMatchingPursuit linear_model.OrthogonalMatchingPursuitCV linear_model.PassiveAggressiveClassifier linear_model.PassiveAggressiveRegressor linear_model.Perceptron linear_model.RandomizedLasso linear_model.RandomizedLogisticRegression linear_model.RANSACRegressor linear_model.Ridge linear_model.RidgeClassifier linear_model.RidgeClassifierCV linear_model.RidgeCV linear_model.SGDClassifier linear_model.SGDRegressor
.. autosummary:: :toctree: generated/ :template: function.rst linear_model.lars_path linear_model.lasso_path linear_model.lasso_stability_path linear_model.orthogonal_mp linear_model.orthogonal_mp_gram
:mod:`sklearn.manifold`: Manifold Learning
.. automodule:: sklearn.manifold :no-members: :no-inherited-members:
User guide: See the :ref:`manifold` section for further details.
.. currentmodule:: sklearn
.. autosummary::
:toctree: generated
:template: class.rst
manifold.LocallyLinearEmbedding
manifold.Isomap
manifold.MDS
manifold.SpectralEmbedding
manifold.TSNE
.. autosummary::
:toctree: generated
:template: function.rst
manifold.locally_linear_embedding
manifold.spectral_embedding
:mod:`sklearn.metrics`: Metrics
See the :ref:`model_evaluation` section and the :ref:`metrics` section of the user guide for further details.
.. automodule:: sklearn.metrics :no-members: :no-inherited-members:
.. currentmodule:: sklearn
See the :ref:`scoring_parameter` section of the user guide for further details.
.. autosummary:: :toctree: generated/ :template: function.rst metrics.make_scorer
See the :ref:`classification_metrics` section of the user guide for further details.
.. autosummary:: :toctree: generated/ :template: function.rst metrics.accuracy_score metrics.auc metrics.average_precision_score metrics.classification_report metrics.confusion_matrix metrics.f1_score metrics.fbeta_score metrics.hamming_loss metrics.hinge_loss metrics.jaccard_similarity_score metrics.log_loss metrics.matthews_corrcoef metrics.precision_recall_curve metrics.precision_recall_fscore_support metrics.precision_score metrics.recall_score metrics.roc_auc_score metrics.roc_curve metrics.zero_one_loss
See the :ref:`regression_metrics` section of the user guide for further details.
.. autosummary:: :toctree: generated/ :template: function.rst metrics.explained_variance_score metrics.mean_absolute_error metrics.mean_squared_error metrics.r2_score
See the :ref:`multilabel_ranking_metrics` section of the user guide for further details.
.. autosummary:: :toctree: generated/ :template: function.rst metrics.label_ranking_average_precision_score
See the :ref:`clustering_evaluation` section of the user guide for further details.
.. automodule:: sklearn.metrics.cluster :no-members: :no-inherited-members:
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: function.rst metrics.adjusted_mutual_info_score metrics.adjusted_rand_score metrics.completeness_score metrics.homogeneity_completeness_v_measure metrics.homogeneity_score metrics.mutual_info_score metrics.normalized_mutual_info_score metrics.silhouette_score metrics.silhouette_samples metrics.v_measure_score
See the :ref:`biclustering_evaluation` section of the user guide for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: function.rst metrics.consensus_score
.. automodule:: sklearn.metrics.pairwise :no-members: :no-inherited-members:
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: function.rst metrics.pairwise.additive_chi2_kernel metrics.pairwise.chi2_kernel metrics.pairwise.distance_metrics metrics.pairwise.euclidean_distances metrics.pairwise.kernel_metrics metrics.pairwise.linear_kernel metrics.pairwise.manhattan_distances metrics.pairwise.pairwise_distances metrics.pairwise.pairwise_kernels metrics.pairwise.polynomial_kernel metrics.pairwise.rbf_kernel metrics.pairwise_distances metrics.pairwise_distances_argmin metrics.pairwise_distances_argmin_min
:mod:`sklearn.mixture`: Gaussian Mixture Models
.. automodule:: sklearn.mixture :no-members: :no-inherited-members:
User guide: See the :ref:`mixture` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst mixture.GMM mixture.DPGMM mixture.VBGMM
:mod:`sklearn.multiclass`: Multiclass and multilabel classification
.. automodule:: sklearn.multiclass :no-members: :no-inherited-members:
User guide: See the :ref:`multiclass` section for further details.
.. currentmodule:: sklearn
.. autosummary::
:toctree: generated
:template: class.rst
multiclass.OneVsRestClassifier
multiclass.OneVsOneClassifier
multiclass.OutputCodeClassifier
:mod:`sklearn.naive_bayes`: Naive Bayes
.. automodule:: sklearn.naive_bayes :no-members: :no-inherited-members:
User guide: See the :ref:`naive_bayes` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst naive_bayes.GaussianNB naive_bayes.MultinomialNB naive_bayes.BernoulliNB
:mod:`sklearn.neighbors`: Nearest Neighbors
.. automodule:: sklearn.neighbors :no-members: :no-inherited-members:
User guide: See the :ref:`neighbors` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst neighbors.NearestNeighbors neighbors.KNeighborsClassifier neighbors.RadiusNeighborsClassifier neighbors.KNeighborsRegressor neighbors.RadiusNeighborsRegressor neighbors.NearestCentroid neighbors.BallTree neighbors.KDTree neighbors.DistanceMetric neighbors.KernelDensity
.. autosummary:: :toctree: generated/ :template: function.rst neighbors.kneighbors_graph neighbors.radius_neighbors_graph
:mod:`sklearn.neural_network`: Neural network models
.. automodule:: sklearn.neural_network :no-members: :no-inherited-members:
User guide: See the :ref:`neural_network` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst neural_network.BernoulliRBM
:mod:`sklearn.cross_decomposition`: Cross decomposition
.. automodule:: sklearn.cross_decomposition :no-members: :no-inherited-members:
User guide: See the :ref:`cross_decomposition` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst cross_decomposition.PLSRegression cross_decomposition.PLSCanonical cross_decomposition.CCA cross_decomposition.PLSSVD
:mod:`sklearn.pipeline`: Pipeline
.. automodule:: sklearn.pipeline :no-members: :no-inherited-members:
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst pipeline.Pipeline pipeline.FeatureUnion
.. autosummary:: :toctree: generated/ :template: function.rst pipeline.make_pipeline pipeline.make_union
:mod:`sklearn.preprocessing`: Preprocessing and Normalization
.. automodule:: sklearn.preprocessing :no-members: :no-inherited-members:
User guide: See the :ref:`preprocessing` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst preprocessing.Binarizer preprocessing.Imputer preprocessing.KernelCenterer preprocessing.LabelBinarizer preprocessing.LabelEncoder preprocessing.MultiLabelBinarizer preprocessing.MinMaxScaler preprocessing.Normalizer preprocessing.OneHotEncoder preprocessing.StandardScaler preprocessing.PolynomialFeatures
.. autosummary:: :toctree: generated/ :template: function.rst preprocessing.add_dummy_feature preprocessing.binarize preprocessing.label_binarize preprocessing.normalize preprocessing.scale
:mod:`sklearn.qda`: Quadratic Discriminant Analysis
.. automodule:: sklearn.qda :no-members: :no-inherited-members:
User guide: See the :ref:`lda_qda` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated :template: class.rst qda.QDA
:mod:`sklearn.random_projection`: Random projection
.. automodule:: sklearn.random_projection :no-members: :no-inherited-members:
User guide: See the :ref:`random_projection` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst random_projection.GaussianRandomProjection random_projection.SparseRandomProjection
.. autosummary:: :toctree: generated/ :template: function.rst random_projection.johnson_lindenstrauss_min_dim
:mod:`sklearn.semi_supervised` Semi-Supervised Learning
.. automodule:: sklearn.semi_supervised :no-members: :no-inherited-members:
User guide: See the :ref:`semi_supervised` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst semi_supervised.LabelPropagation semi_supervised.LabelSpreading
:mod:`sklearn.svm`: Support Vector Machines
.. automodule:: sklearn.svm :no-members: :no-inherited-members:
User guide: See the :ref:`svm` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst svm.SVC svm.LinearSVC svm.NuSVC svm.SVR svm.NuSVR svm.OneClassSVM
.. autosummary:: :toctree: generated/ :template: function.rst svm.l1_min_c
.. autosummary:: :toctree: generated :template: function.rst svm.libsvm.fit svm.libsvm.decision_function svm.libsvm.predict svm.libsvm.predict_proba svm.libsvm.cross_validation
:mod:`sklearn.tree`: Decision Trees
.. automodule:: sklearn.tree :no-members: :no-inherited-members:
User guide: See the :ref:`tree` section for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: class.rst tree.DecisionTreeClassifier tree.DecisionTreeRegressor tree.ExtraTreeClassifier tree.ExtraTreeRegressor
.. autosummary:: :toctree: generated/ :template: function.rst tree.export_graphviz
:mod:`sklearn.utils`: Utilities
.. automodule:: sklearn.utils :no-members: :no-inherited-members:
Developer guide: See the :ref:`developers-utils` page for further details.
.. currentmodule:: sklearn
.. autosummary:: :toctree: generated/ :template: function.rst utils.check_random_state utils.resample utils.shuffle