scikit-learn · glemaitre · Oct 16, 2024 · Oct 10, 2024 · Oct 10, 2024 · Oct 10, 2024
diff --git a/doc/conf.py b/doc/conf.py
@@ -179,6 +179,7 @@
    "templates",
    "includes",
    "**/sg_execution_times.rst",
+    "whats_new/upcoming_changes",
 ]

 # The reST default role (used for this markup: `text`) to use for all

diff --git a/doc/whats_new/upcoming_changes/.gitkeep b/doc/whats_new/upcoming_changes/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/README.md b/doc/whats_new/upcoming_changes/README.md
@@ -0,0 +1,47 @@
+# Changelog instructions
+
+This directory (`doc/whats_new/upcoming_changes`) contains "news fragments"
+which are short files that contain a small **ReST**-formatted text that will be
+added to the next release changelog.
+
+Each file should be named like `<PULL REQUEST>.<TYPE>.rst`, where
+`<PULL REQUEST>` is a pull request number, and `<TYPE>` is one of:
+
+* `major-feature`
+* `feature`
+* `efficiency`
+* `enhancement`
+* `fix`
+* `api`
+
+See [this](https://github.com/scikit-learn/scikit-learn/blob/main/doc/whats_new/changelog_legend.inc)
+for more details about the meaning of each type.
+
+This file needs to be added to the right folder like `sklearn.linear_model` or
+`sklearn.tree` depending on which part of scikit-learn your PR changes. There
+are also a few folders for some topics like `array-api`, `metadata-routing` or `security`.
+
+In almost all cases, your fragment should be formatted as a bullet point.
+
+For example, `28268.feature.rst` would be added to the `sklearn.ensemble`
+folder with the following content::
+
+```rst
+- :class:`ensemble.ExtraTreesClassifier` and :class:`ensemble.ExtraTreesRegressor`
+  now supports missing values in the data matrix `X`. Missing-values are
+  handled by randomly moving all of the samples to the left, or right child
+  node as the tree is traversed.
+  By :user:`Adam Li <adam2392>`.
+```
+
+If you are unsure how to name the news fragment or which folder to use, don't
+hesitate to ask in your pull request!
+
+You can install `towncrier` and run `towncrier create` to help you
+create a news fragment. You can also run `towncrier --draft --version 1.6` if
+you want to get a preview of how your change will look in the final release
+notes.
+
+Note: the `custom-top-level` folder is for changes for which there is no good
+folder and are somewhat one-off topics. Type `other` is mostly meant to be used
+in the `custom-top-level` section.
diff --git a/doc/whats_new/upcoming_changes/array-api/.gitkeep b/doc/whats_new/upcoming_changes/array-api/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/changed-models/.gitkeep b/doc/whats_new/upcoming_changes/changed-models/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/custom-top-level/.gitkeep b/doc/whats_new/upcoming_changes/custom-top-level/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/many-modules/.gitkeep b/doc/whats_new/upcoming_changes/many-modules/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/metadata-routing/.gitkeep b/doc/whats_new/upcoming_changes/metadata-routing/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/security/.gitkeep b/doc/whats_new/upcoming_changes/security/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.base/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.base/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.calibration/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.calibration/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.cluster/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.cluster/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.compose/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.compose/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.covariance/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.covariance/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.cross_decomposition/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.cross_decomposition/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.datasets/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.datasets/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.decomposition/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.decomposition/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.discriminant_analysis/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.discriminant_analysis/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.dummy/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.dummy/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.ensemble/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.ensemble/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.exceptions/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.exceptions/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.feature_extraction/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.feature_extraction/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.feature_selection/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.feature_selection/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.gaussian_process/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.gaussian_process/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.impute/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.impute/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.inspection/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.inspection/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.isotonic/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.isotonic/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.kernel_approximation/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.kernel_approximation/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.kernel_ridge/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.kernel_ridge/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.linear_model/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.linear_model/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.manifold/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.manifold/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.metrics/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.metrics/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.mixture/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.mixture/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.model_selection/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.model_selection/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.multiclass/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.multiclass/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.multioutput/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.multioutput/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.naive_bayes/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.naive_bayes/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.neighbors/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.neighbors/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.neural_network/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.neural_network/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.pipeline/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.pipeline/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.preprocessing/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.preprocessing/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.random_projection/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.random_projection/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.semi_supervised/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.semi_supervised/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.svm/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.svm/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.tree/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.tree/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/sklearn.utils/.gitkeep b/doc/whats_new/upcoming_changes/sklearn.utils/.gitkeep
diff --git a/doc/whats_new/upcoming_changes/towncrier_template.rst.jinja2 b/doc/whats_new/upcoming_changes/towncrier_template.rst.jinja2
@@ -0,0 +1,43 @@
+{% if render_title %}
+{% if versiondata.name %}
+{{ versiondata.name }} {{ versiondata.version }} ({{ versiondata.date }})
+{{ top_underline * ((versiondata.name + versiondata.version + versiondata.date)|length + 4)}}
+{% else %}
+{{ versiondata.version }} ({{ versiondata.date }})
+{{ top_underline * ((versiondata.version + versiondata.date)|length + 3)}}
+{% endif %}
+{% endif %}
+
+{% set underline = underlines[0] %}
+{% for section, content_per_category in sections.items() if content_per_category %}
+{% if section != 'custom-top-level' %}
+{{ section }}
+{{ underline * section|length }}
+
+{% endif %}
+{# section-specific description #}
+{% if section == 'Support for Array API' %}
+Additional estimators and functions have been updated to include support for all
+`Array API <https://data-apis.org/array-api/latest/>`_ compliant inputs.
+
+See :ref:`array_api` for more details.
+
+{% endif %}
+{% if section == 'Metadata routing' %}
+Refer to the :ref:`Metadata Routing User Guide <metadata_routing>` for
+more details.
+
+{% endif %}
+{# We loop over definitions because, contrary to content_per_category, it follow the category order as defined in pyproject.toml #}
+{% for category in definitions if category in content_per_category %}
+{% set content = content_per_category[category] %}
+{% for text, issue_links in content.items() %}
+{% set tag = definitions[category]['name'] %}
+{# If category != 'other' add tag like |Fix| or |Feature|. This assumes the text is formatted as a bullet point #}
+{% set text_with_tag = text if category == 'other' else '{0} {1}{2}'.format(text[0], tag, text[1:]) %}
+{# issue_links is a list so need to join. For our purposes, issue_links is always of length 1 #}
+{{ text_with_tag }} {{ issue_links|join(', ') }}
+
+{% endfor %}
+{% endfor %}
+{% endfor %}
diff --git a/pyproject.toml b/pyproject.toml
@@ -252,3 +252,219 @@ package = "sklearn"  # name of your package
 "Documentation" = [
  "spin.cmds.meson.docs"
 ]
+
+[tool.towncrier]
+    package = "sklearn"
+    filename = "doc/whats_new/notes-towncrier.rst"
+    directory = "doc/whats_new/upcoming_changes"
+    issue_format = ":pr:`{issue}`"
+    template = "doc/whats_new/upcoming_changes/towncrier_template.rst.jinja2"
+    title_format = "Version {version} ({project_date})"
+    all_bullets = false
+
+    [[tool.towncrier.type]]
+        directory = "major-feature"
+        name = "|MajorFeature|"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "feature"
+        name = "|Feature|"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "efficiency"
+        name = "|Efficiency|"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "enhancement"
+        name = "|Enhancement|"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "fix"
+        name = "|Fix|"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "api"
+        name = "|API|"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "other"
+        name = ""
+        showcontent = true
+
+    [[tool.towncrier.section]]
+        name = "Security"
+        path = "security"
+
+    [[tool.towncrier.section]]
+        name = "Changed models"
+        path = "changed-models"
+
+    [[tool.towncrier.section]]
+        name = "Changes impacting many modules"
+        path = "many-modules"
+
+    [[tool.towncrier.section]]
+        name = "Support for Array API"
+        path = "array-api"
+
+    [[tool.towncrier.section]]
+        name = "Metadata routing"
+        path = "metadata-routing"
+
+    [[tool.towncrier.section]]
+        name = "custom-top-level"
+        path = "custom-top-level"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.base`"
+        path = "sklearn.base"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.calibration`"
+        path = "sklearn.calibration"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.cluster`"
+        path = "sklearn.cluster"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.compose`"
+        path = "sklearn.compose"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.covariance`"
+        path = "sklearn.covariance"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.cross_decomposition`"
+        path = "sklearn.cross_decomposition"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.datasets`"
+        path = "sklearn.datasets"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.decomposition`"
+        path = "sklearn.decomposition"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.discriminant_analysis`"
+        path = "sklearn.discriminant_analysis"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.dummy`"
+        path = "sklearn.dummy"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.ensemble`"
+        path = "sklearn.ensemble"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.exceptions`"
+        path = "sklearn.exceptions"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.feature_extraction`"
+        path = "sklearn.feature_extraction"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.feature_selection`"
+        path = "sklearn.feature_selection"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.gaussian_process`"
+        path = "sklearn.gaussian_process"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.impute`"
+        path = "sklearn.impute"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.inspection`"
+        path = "sklearn.inspection"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.isotonic`"
+        path = "sklearn.isotonic"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.kernel_approximation`"
+        path = "sklearn.kernel_approximation"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.kernel_ridge`"
+        path = "sklearn.kernel_ridge"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.linear_model`"
+        path = "sklearn.linear_model"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.manifold`"
+        path = "sklearn.manifold"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.metrics`"
+        path = "sklearn.metrics"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.mixture`"
+        path = "sklearn.mixture"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.model_selection`"
+        path = "sklearn.model_selection"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.multiclass`"
+        path = "sklearn.multiclass"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.multioutput`"
+        path = "sklearn.multioutput"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.naive_bayes`"
+        path = "sklearn.naive_bayes"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.neighbors`"
+        path = "sklearn.neighbors"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.neural_network`"
+        path = "sklearn.neural_network"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.pipeline`"
+        path = "sklearn.pipeline"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.preprocessing`"
+        path = "sklearn.preprocessing"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.random_projection`"
+        path = "sklearn.random_projection"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.semi_supervised`"
+        path = "sklearn.semi_supervised"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.svm`"
+        path = "sklearn.svm"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.tree`"
+        path = "sklearn.tree"
+
+    [[tool.towncrier.section]]
+        name = ":mod:`sklearn.utils`"
+        path = "sklearn.utils"