@@ -10,6 +10,23 @@ function raw specifications may not be enough to give full guidelines on their
10
10
uses.
11
11
For reference on concepts repeated across the API, see :ref: `glossary `.
12
12
13
+ :mod: `sklearn `: Settings and information tools
14
+ ==============================================
15
+
16
+ .. automodule :: sklearn
17
+ :no-members:
18
+ :no-inherited-members:
19
+
20
+ .. currentmodule :: sklearn
21
+
22
+ .. autosummary ::
23
+ :toctree: generated/
24
+ :template: function.rst
25
+
26
+ config_context
27
+ get_config
28
+ set_config
29
+ show_versions
13
30
14
31
:mod: `sklearn.base `: Base classes and utility functions
15
32
=======================================================
@@ -51,10 +68,6 @@ Functions
51
68
base.clone
52
69
base.is_classifier
53
70
base.is_regressor
54
- config_context
55
- get_config
56
- set_config
57
- show_versions
58
71
59
72
.. _calibration_ref :
60
73
@@ -150,7 +163,7 @@ details.
150
163
.. currentmodule :: sklearn
151
164
152
165
.. autosummary ::
153
- :toctree: generated
166
+ :toctree: generated/
154
167
:template: class.rst
155
168
156
169
compose.ColumnTransformer
@@ -355,7 +368,7 @@ Samples generator
355
368
.. currentmodule :: sklearn
356
369
357
370
.. autosummary ::
358
- :toctree: generated
371
+ :toctree: generated/
359
372
:template: class.rst
360
373
361
374
discriminant_analysis.LinearDiscriminantAnalysis
@@ -592,7 +605,14 @@ From text
592
605
gaussian_process.GaussianProcessClassifier
593
606
gaussian_process.GaussianProcessRegressor
594
607
595
- Kernels:
608
+ Kernels
609
+ -------
610
+
611
+ .. automodule :: sklearn.gaussian_process.kernels
612
+ :no-members:
613
+ :no-inherited-members:
614
+
615
+ .. currentmodule :: sklearn
596
616
597
617
.. autosummary ::
598
618
:toctree: generated/
@@ -687,7 +707,7 @@ Plotting
687
707
isotonic.IsotonicRegression
688
708
689
709
.. autosummary ::
690
- :toctree: generated
710
+ :toctree: generated/
691
711
:template: function.rst
692
712
693
713
isotonic.check_increasing
@@ -865,9 +885,14 @@ Miscellaneous
865
885
866
886
.. autosummary ::
867
887
:toctree: generated/
868
- :template: function .rst
888
+ :template: classes .rst
869
889
870
890
linear_model.PassiveAggressiveRegressor
891
+
892
+ .. autosummary ::
893
+ :toctree: generated/
894
+ :template: function.rst
895
+
871
896
linear_model.enet_path
872
897
linear_model.lars_path
873
898
linear_model.lars_path_gram
@@ -1266,7 +1291,7 @@ Visualization
1266
1291
.. currentmodule :: sklearn
1267
1292
1268
1293
.. autosummary ::
1269
- :toctree: generated
1294
+ :toctree: generated/
1270
1295
:template: class.rst
1271
1296
1272
1297
multiclass.OneVsRestClassifier
@@ -1608,62 +1633,224 @@ Plotting
1608
1633
:toctree: generated/
1609
1634
:template: function.rst
1610
1635
1611
- utils.arrayfuncs.min_pos
1612
1636
utils.as_float_array
1613
1637
utils.assert_all_finite
1638
+ utils.deprecated
1639
+ utils.estimator_html_repr
1640
+ utils.gen_batches
1641
+ utils.gen_even_slices
1642
+ utils.indexable
1643
+ utils.murmurhash3_32
1644
+ utils.resample
1645
+ utils._safe_indexing
1646
+ utils.safe_mask
1647
+ utils.safe_sqr
1648
+ utils.shuffle
1649
+
1650
+ Input and parameter validation
1651
+ ------------------------------
1652
+
1653
+ .. automodule :: sklearn.utils.validation
1654
+ :no-members:
1655
+ :no-inherited-members:
1656
+
1657
+ .. currentmodule :: sklearn
1658
+
1659
+ .. autosummary ::
1660
+ :toctree: generated/
1661
+ :template: function.rst
1662
+
1614
1663
utils.check_X_y
1615
1664
utils.check_array
1616
1665
utils.check_scalar
1617
1666
utils.check_consistent_length
1618
1667
utils.check_random_state
1668
+ utils.validation.check_is_fitted
1669
+ utils.validation.check_memory
1670
+ utils.validation.check_symmetric
1671
+ utils.validation.column_or_1d
1672
+ utils.validation.has_fit_parameter
1673
+
1674
+ Utilities used in meta-estimators
1675
+ ---------------------------------
1676
+
1677
+ .. automodule :: sklearn.utils.metaestimators
1678
+ :no-members:
1679
+ :no-inherited-members:
1680
+
1681
+ .. currentmodule :: sklearn
1682
+
1683
+ .. autosummary ::
1684
+ :toctree: generated/
1685
+ :template: function.rst
1686
+
1687
+ utils.metaestimators.available_if
1688
+
1689
+ Utilities to handle weights based on class labels
1690
+ -------------------------------------------------
1691
+
1692
+ .. automodule :: sklearn.utils.class_weight
1693
+ :no-members:
1694
+ :no-inherited-members:
1695
+
1696
+ .. currentmodule :: sklearn
1697
+
1698
+ .. autosummary ::
1699
+ :toctree: generated/
1700
+ :template: function.rst
1701
+
1619
1702
utils.class_weight.compute_class_weight
1620
1703
utils.class_weight.compute_sample_weight
1621
- utils.deprecated
1622
- utils.estimator_checks.check_estimator
1623
- utils.estimator_checks.parametrize_with_checks
1624
- utils.estimator_html_repr
1704
+
1705
+ Utilities to deal with multiclass target in classifiers
1706
+ -------------------------------------------------------
1707
+
1708
+ .. automodule :: sklearn.utils.multiclass
1709
+ :no-members:
1710
+ :no-inherited-members:
1711
+
1712
+ .. currentmodule :: sklearn
1713
+
1714
+ .. autosummary ::
1715
+ :toctree: generated/
1716
+ :template: function.rst
1717
+
1718
+ utils.multiclass.type_of_target
1719
+ utils.multiclass.is_multilabel
1720
+ utils.multiclass.unique_labels
1721
+
1722
+ Utilities for optimal mathematical operations
1723
+ ---------------------------------------------
1724
+
1725
+ .. automodule :: sklearn.utils.extmath
1726
+ :no-members:
1727
+ :no-inherited-members:
1728
+
1729
+ .. currentmodule :: sklearn
1730
+
1731
+ .. autosummary ::
1732
+ :toctree: generated/
1733
+ :template: function.rst
1734
+
1625
1735
utils.extmath.safe_sparse_dot
1626
1736
utils.extmath.randomized_range_finder
1627
1737
utils.extmath.randomized_svd
1628
1738
utils.extmath.fast_logdet
1629
1739
utils.extmath.density
1630
1740
utils.extmath.weighted_mode
1631
- utils.gen_batches
1632
- utils.gen_even_slices
1633
- utils.graph.single_source_shortest_path_length
1634
- utils.indexable
1635
- utils.metaestimators.available_if
1636
- utils.multiclass.type_of_target
1637
- utils.multiclass.is_multilabel
1638
- utils.multiclass.unique_labels
1639
- utils.murmurhash3_32
1640
- utils.resample
1641
- utils._safe_indexing
1642
- utils.safe_mask
1643
- utils.safe_sqr
1644
- utils.shuffle
1741
+
1742
+ Utilities to work with sparse matrices and arrays
1743
+ -------------------------------------------------
1744
+
1745
+ .. automodule :: sklearn. utils.sparsefuncs
1746
+ :no-members:
1747
+ :no-inherited-members:
1748
+
1749
+ .. currentmodule :: sklearn
1750
+
1751
+ .. autosummary ::
1752
+ :toctree: generated/
1753
+ :template: function.rst
1754
+
1645
1755
utils.sparsefuncs.incr_mean_variance_axis
1646
1756
utils.sparsefuncs.inplace_column_scale
1647
1757
utils.sparsefuncs.inplace_row_scale
1648
1758
utils.sparsefuncs.inplace_swap_row
1649
1759
utils.sparsefuncs.inplace_swap_column
1650
1760
utils.sparsefuncs.mean_variance_axis
1651
1761
utils.sparsefuncs.inplace_csr_column_scale
1762
+
1763
+ .. automodule :: sklearn.utils.sparsefuncs_fast
1764
+ :no-members:
1765
+ :no-inherited-members:
1766
+
1767
+ .. currentmodule :: sklearn
1768
+
1769
+ .. autosummary ::
1770
+ :toctree: generated/
1771
+ :template: function.rst
1772
+
1652
1773
utils.sparsefuncs_fast.inplace_csr_row_normalize_l1
1653
1774
utils.sparsefuncs_fast.inplace_csr_row_normalize_l2
1775
+
1776
+ Utilities to work with graphs
1777
+ -----------------------------
1778
+
1779
+ .. automodule :: sklearn.utils.graph
1780
+ :no-members:
1781
+ :no-inherited-members:
1782
+
1783
+ .. currentmodule :: sklearn
1784
+
1785
+ .. autosummary ::
1786
+ :toctree: generated/
1787
+ :template: function.rst
1788
+
1789
+ utils.graph.single_source_shortest_path_length
1790
+
1791
+ Utilities for random sampling
1792
+ -----------------------------
1793
+
1794
+ .. automodule :: sklearn.utils.random
1795
+ :no-members:
1796
+ :no-inherited-members:
1797
+
1798
+ .. currentmodule :: sklearn
1799
+
1800
+ .. autosummary ::
1801
+ :toctree: generated/
1802
+ :template: function.rst
1803
+
1654
1804
utils.random.sample_without_replacement
1655
- utils.validation.check_is_fitted
1656
- utils.validation.check_memory
1657
- utils.validation.check_symmetric
1658
- utils.validation.column_or_1d
1659
- utils.validation.has_fit_parameter
1805
+
1806
+
1807
+ Utilities to operate on arrays
1808
+ ------------------------------
1809
+
1810
+ .. automodule :: sklearn.utils.arrayfuncs
1811
+ :no-members:
1812
+ :no-inherited-members:
1813
+
1814
+ .. currentmodule :: sklearn
1815
+
1816
+ .. autosummary ::
1817
+ :toctree: generated/
1818
+ :template: function.rst
1819
+
1820
+ utils.arrayfuncs.min_pos
1821
+
1822
+ Metadata routing
1823
+ ----------------
1824
+
1825
+ .. automodule :: sklearn.utils.metadata_routing
1826
+ :no-members:
1827
+ :no-inherited-members:
1828
+
1829
+ .. currentmodule :: sklearn
1830
+
1831
+ .. autosummary ::
1832
+ :toctree: generated/
1833
+ :template: function.rst
1834
+
1660
1835
utils.metadata_routing.get_routing_for_object
1836
+ utils.metadata_routing.process_routing
1837
+
1838
+ .. autosummary ::
1839
+ :toctree: generated/
1840
+ :template: class.rst
1841
+
1661
1842
utils.metadata_routing.MetadataRouter
1662
1843
utils.metadata_routing.MetadataRequest
1663
1844
utils.metadata_routing.MethodMapping
1664
- utils.metadata_routing.process_routing
1665
1845
1666
- Specific utilities to list scikit-learn components:
1846
+ Scikit-learn object discovery
1847
+ -----------------------------
1848
+
1849
+ .. automodule :: sklearn.utils.discovery
1850
+ :no-members:
1851
+ :no-inherited-members:
1852
+
1853
+ .. currentmodule :: sklearn
1667
1854
1668
1855
.. autosummary ::
1669
1856
:toctree: generated/
@@ -1673,7 +1860,30 @@ Specific utilities to list scikit-learn components:
1673
1860
utils.discovery.all_displays
1674
1861
utils.discovery.all_functions
1675
1862
1676
- Utilities from joblib:
1863
+ Scikit-learn compatibility checker
1864
+ ----------------------------------
1865
+
1866
+ .. automodule :: sklearn.utils.estimator_checks
1867
+ :no-members:
1868
+ :no-inherited-members:
1869
+
1870
+ .. currentmodule :: sklearn
1871
+
1872
+ .. autosummary ::
1873
+ :toctree: generated/
1874
+ :template: function.rst
1875
+
1876
+ utils.estimator_checks.check_estimator
1877
+ utils.estimator_checks.parametrize_with_checks
1878
+
1879
+ Utilities for parallel computing
1880
+ --------------------------------
1881
+
1882
+ .. automodule :: sklearn.utils.parallel
1883
+ :no-members:
1884
+ :no-inherited-members:
1885
+
1886
+ .. currentmodule :: sklearn
1677
1887
1678
1888
.. autosummary ::
1679
1889
:toctree: generated/
0 commit comments