DOC Improve minor and bug-fix release processes' documentation #25457

jjerphan · 2023-01-23T10:43:23Z

Reference Issues/PRs

What does this implement/fix? Explain your changes.

This updates the changes to the documentation regarding bug-fix releases.

Instructions unclear, got Julien stuck in a _nœud de cerveaux_. This should prevent others to fall in the same trap.

ogrisel

This looks good to me but I would gladly like to get feedback from other people with more experience.

I think @jnothman was the first to use this way of preparing minor releases. I think @jeremiedbb also used this approach several times.

jeremiedbb · 2023-01-23T12:24:33Z

I think I only did one minor release and it was a while ago, so I don't remember well :/
Intuitively I would have just cherry picked

jeremiedbb · 2023-01-23T12:34:09Z

@glemaitre has done most of the recent minor releases

jjerphan · 2023-01-23T12:52:49Z

For #25442, I rebased on 1.2.0 several times (because people proposed suggestions in the meantime).

It looked like it worked, yet I would like to know if it could messed up with the history.

I am currently rebasing on 1.2.0 and I am waiting for a confirmation that this is correct.

ogrisel · 2023-01-23T14:03:13Z

I am currently rebasing on 1.2.0 and I am waiting for a confirmation that this is correct.

I think you should rebase on top of 1.2.X, otherwise you will pick the commits that have been pushed to 1.2.X after the 1.2.0 release (e.g. fixes to the stable website) again in your release PR.

glemaitre · 2023-01-23T14:04:07Z

Intuitively I would have just cherry picked

rebase -i is the same than cherry-picking one-by-one. Rebasing on 1.2.X is better because you might have a couple of changes that have been ported in 1.2.X which are not in the tag 1.2.0.

ogrisel · 2023-01-23T15:03:12Z

So +1 for merge this small doc PR @glemaitre?

glemaitre · 2023-01-23T15:04:25Z

Yep I just wanted to wait that @jjerphan make the release to know if he has to make some other changes.

jjerphan · 2023-01-24T08:35:26Z

Yes, this PR is to be completed with some notes I took during the process.

jjerphan · 2023-01-26T13:34:16Z

I extracted some of the content present in the "Maintainers" section to propose to create a new section dedicated to the release process. The content it self has not changed.

Do you think this is relevant? If so, we can perform this first change and I can open another PR to improve this section.

glemaitre · 2023-01-26T14:23:21Z

doc/developers/maintainer.rst

@@ -1,319 +1,6 @@
-Maintainer / core-developer information
+    Maintainer / core-developer information


Suggested change

Maintainer / core-developer information

Maintainer / core-developer information

glemaitre · 2023-01-26T14:29:38Z

For me, this is fine to keep the release process in the "Maintainer" section.

We should update some of the parts of this documentation thought: I am under the impression that the Travis CRON job should is not useful anymore.

One useful thing to have in this doc (until it is up to date) is the reason to use a CI provider, e.g. CircleCI for the documentation, CirrusCI for ARM build, etc.

jeremiedbb · 2023-01-26T14:29:54Z

I'm not sure about moving it in developpers. To me it really is the main topic (or one of the main topics) of the maintainers section. It's stuff you don't need to worry about unless you are a maintainer.

jeremiedbb · 2023-01-26T14:35:02Z

doc/developers/release_process.rst

+**Permissions**
+
+The release manager requires a set of permissions on top of the usual
+permissions given to maintainers, which includes:
+
+- *maintainer* role on ``scikit-learn`` projects on ``pypi.org`` and
+  ``test.pypi.org``, separately.
+- become a member of the *scikit-learn* team on conda-forge by editing the
+  ``recipe/meta.yaml`` file on
+  ``https://github.com/conda-forge/scikit-learn-feedstock``


The PyPI part is not strict requirement anymore, We should say that all you need is to be a core dev to be able to upload a release on PyPI, and that being admin on PyPI allows to manage a release in case something went wrong.

Let me know if 5944d98 addresses your comment.

jeremiedbb · 2023-01-26T14:37:55Z

doc/developers/release_process.rst

+   You should then be able to upload the generated artifacts (.tar.gz and .whl
+   files) to https://test.pypi.org using the "Run workflow" form for the
+   following GitHub Actions workflow:
+
+   https://github.com/scikit-learn/scikit-learn/actions?query=workflow%3A%22Publish+to+Pypi%22


Here we can maybe be more specific and warn to be careful to set the appropriate branch (main for a major/minor release and 0.999.X for a bugfix release)

a2f71c6 should have clarified that.

This reverts commit 293ccca.

ogrisel

Thanks, this is release helpful. Here is a round of review.

ogrisel · 2023-02-02T15:56:31Z

doc/developers/maintainer.rst

@@ -17,6 +17,8 @@ Before a release

 1. Update authors table:

+   Create a token on GitHub's page with the following permission: ``read:org``.
+   Run the following script, entering the token in:


If I remember correctly, there are several kinds of tokens and some do not work. I think it would be helpful to be more precise and give the URL of the token creation page.

I think there is:

https://github.com/settings/tokens

for personal access tokens but there are also:

https://github.com/settings/tokens?type=beta

I am not sure which are needed or if both kinds work for this use case.

ogrisel · 2023-02-02T15:59:42Z

doc/developers/maintainer.rst

+The release manager must be a *maintainer* of ``scikit-learn`` to be able to
+publish on ``pypi.org`` and ``test.pypi.org``.


Suggested change

The release manager must be a *maintainer* of ``scikit-learn`` to be able to

publish on ``pypi.org`` and ``test.pypi.org``.

The release manager must be a *maintainer* of the ``scikit-learn/scikit-learn`` repo

to be able to publish on ``pypi.org`` and ``test.pypi.org`` (via a manual trigger of a dedicated Github Actions workflow). The release manager does not need extra permissions on ``pypi.org`` to publish a release in particular.

ogrisel · 2023-02-02T16:05:38Z

doc/developers/maintainer.rst

+        git checkout -b release-1.2.2 main
+        git push -u fork release-1.2.2:release-1.2.2
+
+ - Create a PR to the `upstream/1.2.X` branch (not to `upstream/main`)


Suggested change

- Create a PR to the `upstream/1.2.X` branch (not to `upstream/main`)

- Create a **Draft** PR to the `upstream/1.2.X` branch (not to `upstream/main`)

ogrisel · 2023-02-02T16:09:40Z

doc/developers/maintainer.rst

+Minor version release and bug-fix release
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


Suggested change

Minor version release and bug-fix release

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Minor version release (also known as bug-fix release)

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

I thought the version numbers' semantic and scheme were:

Major release (e.g. 2.0)

Minor release (e.g. 1.3.0)

Bug-fix release (e.g. 1.2.2)

This is similar to the major.minor.micro example given by PEP 440.

Is the version numbers' semantic and scheme that scikit-learn is using documented somewhere?

ogrisel · 2023-02-02T16:15:15Z

doc/developers/maintainer.rst

-It's nice to have a copy of the ``git rebase -i`` log in the PR to help others
-understand what's included.
+Copy the :ref:`release_checklist` template and paste it in the description of the
+Pull Request to track progress.


Suggested change

Pull Request to track progress.

Pull Request to track progress.

Review all the commits included in the release to make sure that they do not introduce

any new feature. We should not blindly trust the commit message prefixes.

Remove the draft status of the release PR and invite other maintainers to review the

list of included commits.

ogrisel · 2023-02-02T16:15:43Z

doc/developers/maintainer.rst


-Do not forget to add a commit updating ``sklearn.__version__``.
+ - Create a commit updating the version number i.e. ``sklearn.__version__``.


The version update is already documented later. Let's remove it to avoid redundancy. The order is not very important.

I think we should add the following instead:

Suggested change

- Create a commit updating the version number i.e. ``sklearn.__version__``.

- Force push the result of the rebase and the extra release commits to the

release PR:

.. prompt:: bash $

git push -f fork release-1.2.2:release-1.2.2

ogrisel · 2023-02-02T16:23:35Z

doc/developers/maintainer.rst


-.. prompt:: bash $
+     - Commits to pick for bug-fix release *generally* are prefixed with: `FIX`, `CI`,
+       `DOC`


Suggested change

`DOC`

`DOC`. They should at least include all the commits of the merged PRs

that were milestoned for this PR on github and/or documented as such in

the changelog. It's likely that the some bugfixes where document in the

changelog of the main major release instead of the next bugfix release,

in which case, the matching changelog entries will need to be moved,

first in the `main` branch then backported in the release PR.

ogrisel · 2023-02-02T16:25:07Z

doc/developers/maintainer.rst


-Copy the :ref:`release_checklist` templates in the description of the Pull
-Request to track progress.
+ - Create a commit reordering the changelog.


This should be pushed to main first and then backported to the release PR. Furthermore, let actual content of the changelog needs to be made consistent with the list of commits included in the release PR.

Each time the changelog is updated, it is required, to issue a PR to main and then backport the commit of the merge to the release PR.

I've adapted the first paragraph of this section in this regards.

Is this clearer now?

Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org>

jjerphan

@ogrisel: dbb9ae4 must integrate all your suggestions with minor adaptations and with minor additions.

Let me know what you think of it.

I just have one question regarding the semantic and the scheme of version numbers.

jjerphan · 2023-02-06T14:40:27Z

doc/developers/maintainer.rst

+Minor version release and bug-fix release
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


I thought the version numbers' semantic and scheme were:

Major release (e.g. 2.0)

Minor release (e.g. 1.3.0)

Bug-fix release (e.g. 1.2.2)

This is similar to the major.minor.micro example given by PEP 440.

Is the version numbers' semantic and scheme that scikit-learn is using documented somewhere?

jjerphan · 2023-02-06T14:41:23Z

doc/developers/maintainer.rst


-Copy the :ref:`release_checklist` templates in the description of the Pull
-Request to track progress.
+ - Create a commit reordering the changelog.


I've adapted the first paragraph of this section in this regards.

Is this clearer now?

thomasjpfan

This looks to be an overall improvement. I'm okay with merging now and having any additional improvements in follow up PRs.

doc/developers/maintainer.rst

Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>

jjerphan · 2023-02-08T10:40:31Z

I think all the comments have been addressed (see #25457 (review)).

I let @thomasjpfan or @ogrisel merge if this LGTT. 🙂

jeremiedbb

LGTM. Just a rendering issue, and a small bullet point that I think is not in the right section

doc/developers/maintainer.rst

Co-authored-by: Jérémie du Boisberranger <jeremiedbb@yahoo.fr>

…-learn#25457) Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com> Co-authored-by: Jérémie du Boisberranger <jeremiedbb@yahoo.fr>

* ENH Raise NotFittedError in get_feature_names_out for MissingIndicator, KBinsDiscretizer, SplineTransformer, DictVectorizer (scikit-learn#25402) Co-authored-by: Alex <alex.buzenet.fr@gmail.com> Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> * DOC Update date and contributors list for v1.2.1 (scikit-learn#25459) * DOC Make MeanShift documentation clearer (scikit-learn#25305) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> * Finishes boolean and arithmetic creation * Skeleton for traditional GP * DOC Reorder whats_new/v1.2.rst (scikit-learn#25461) Follow-up of scikit-learn#25459 Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> Co-authored-by: Jérémie du Boisberranger <jeremiedbb@users.noreply.github.com> Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> Co-authored-by: Jérémie du Boisberranger <jeremiedbb@users.noreply.github.com> * FIX fix faulty test in `cross_validate` that used the wrong estimator (scikit-learn#25456) * ENH Raise NotFittedError in get_feature_names_out for estimators that use ClassNamePrefixFeatureOutMixin and SelectorMixin (scikit-learn#25308) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> * EFF Improve IsolationForest predict time (scikit-learn#25186) Co-authored-by: Felipe Breve Siola <felipe.breve-siola@klarna.com> Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> Co-authored-by: Tim Head <betatim@gmail.com> * MAINT refactor spectral_clustering to call SpectralClustering (scikit-learn#25392) * TST reduce warnings in test_logistic.py (scikit-learn#25469) * CI Build doc on CircleCI (scikit-learn#25466) * DOC Update news footer for 1.2.1 (scikit-learn#25472) * MAINT Validate parameter for `sklearn.cluster.cluster_optics_xi` (scikit-learn#25385) Co-authored-by: adossantosalfam <anthony.dos_santos_alfama@insa-rouen.fr> Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> * MAINT Parameters validation for additive_chi2_kernel (scikit-learn#25424) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> * Initial Program Creation * CI Include linting in CircleCI (scikit-learn#25475) * MAINT Update version number to 1.2.1 in SECURITY.md (scikit-learn#25471) * TST Sets random_state for test_logistic.py (scikit-learn#25446) * MAINT Remove -Wcpp warnings when compiling sklearn.decomposition._online_lda_fast (scikit-learn#25020) Co-authored-by: Julien Jerphanion <git@jjerphan.xyz> * FIX Support readonly sparse datasets for `manhattan_distances` (scikit-learn#25432) * TST Add non-regression test for scikit-learn#7981 This reproducer is adapted from the one of this message: scikit-learn#7981 (comment) Co-authored-by: Loïc Estève <loic.esteve@ymail.com> * FIX Support readonly sparse datasets for manhattan * DOC Add entry in whats_new/v1.2.rst for 1.2.1 * FIX Fix comment * Update sklearn/metrics/tests/test_pairwise.py Co-authored-by: Christian Lorentzen <lorentzen.ch@gmail.com> * DOC Move entry to whats_new/v1.3.rst * Update sklearn/metrics/tests/test_pairwise.py Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> Co-authored-by: Loïc Estève <loic.esteve@ymail.com> Co-authored-by: Christian Lorentzen <lorentzen.ch@gmail.com> Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> * MAINT dynamically expose kulsinski and remove support in BallTree (scikit-learn#25417) Co-authored-by: Loïc Estève <loic.esteve@ymail.com> Co-authored-by: Julien Jerphanion <git@jjerphan.xyz> closes scikit-learn#25212 * DOC Adds CirrusCI badge to readme (scikit-learn#25483) * CI add linter display name (scikit-learn#25485) * DOC update description of X in `FunctionTransformer.transform()` (scikit-learn#24844) * MAINT remove -Wcpp warnings when compiling sklearn.preprocessing._csr_polynomial_expansion (scikit-learn#25041) * DOC more didactic example of bisecting kmeans (scikit-learn#25494) Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> Co-authored-by: Arturo Amor <86408019+ArturoAmorQ@users.noreply.github.com> Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> * ENH csr_row_norms optimization (scikit-learn#24426) Co-authored-by: Julien Jerphanion <git@jjerphan.xyz> Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> Co-authored-by: Jérémie du Boisberranger <jeremiedbb@users.noreply.github.com> * TST Allow callables as valid parameter regarding cloning estimator (scikit-learn#25498) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> Co-authored-by: Loïc Estève <loic.esteve@ymail.com> Co-authored-by: From: Tim Head <betatim@gmail.com> * DOC Fixes sphinx search on website (scikit-learn#25504) * FIX make IsotonicRegression always predict NumPy arrays (scikit-learn#25500) Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com> * FEA Add Gamma deviance as loss function to HGBT (scikit-learn#22409) * FEA add gamma loss to HGBT * DOC add whatsnew * CLN address review comments * TST make test_gamma pass by not testing out-of-sample * TST compare gamma and poisson to LightGBM * TST fix test_gamma by comparing to MSE HGBT instead of Poisson HGBT * TST fix for test_same_predictions_regression for poisson * CLN address review comments * CLN nits * CLN better comments * TST use pytest.param with skip mark * TST Correct conditional test parametrization mark Co-authored-by: Christian Lorentzen <lorentzen.ch@gmail.com> * CI Trigger CI Builds currently fail because requests to Azure Ubuntu repository timeout. * DOC add comment for lax comparison with LightGBM * CLN tuple needs trailing comma --------- Co-authored-by: Julien Jerphanion <git@jjerphan.xyz> * MAINT Remove -Wsign-compare warnings when compiling sklearn.tree._tree (scikit-learn#25507) * MAINT add more intuition on OAS computation based on literature (scikit-learn#23867) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> * CI Allow cirrus arm tests to run with cd build commit tag (scikit-learn#25514) * CI Upload ARM wheels from CirrusCI to nightly and staging index (scikit-learn#25513) Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> * MAINT Remove -Wcpp warnings from sklearn.utils._seq_dataset (scikit-learn#25406) * FIX Fixes linux ARM CI on CirrusCI (scikit-learn#25536) * DOC Fix grammatical mistake in `mixture` module (scikit-learn#25541) * DOC add missing trailing colon (scikit-learn#25542) * MAINT Parameters validation for sklearn.datasets.make_classification (scikit-learn#25474) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> * MNT Expose allow_nan tag in bagging (scikit-learn#25506) * MAINT Clean-up comments and rename variables in `_middle_term_sparse_sparse_{32, 64}` (scikit-learn#25449) Co-authored-by: Julien Jerphanion <git@jjerphan.xyz> * DOC: remove incorrect statement (scikit-learn#25544) * MAINT Parameters validation for reconstruct_from_patches_2d (scikit-learn#25384) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> * MAINT Parameter validation for sklearn.metrics.d2_pinball_score (scikit-learn#25414) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> * MAINT Parameters validation for spectral_clustering (scikit-learn#25378) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> * MAINT Parameters validation for sklearn.datasets.fetch_kddcup99 (scikit-learn#25463) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> * DOC Update MLPRegressor docs (scikit-learn#25556) Co-authored-by: Ian Thompson <ian.thompson@hrblock.com> * DOC Update docs for KMeans (scikit-learn#25546) Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> * FIX BisectingKMeans crashes randomly (scikit-learn#25563) Fixes scikit-learn#25505 * ENH BaseLabelPropagation to accept sparse matrices (scikit-learn#19664) Co-authored-by: Kaushik Amar Das <kaushik.amar.das@accenture.com> Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> * MAINT Remove travis ci config and related doc (scikit-learn#25562) * DOC Add pynndescent to Approximate nearest neighbors in TSNE example (scikit-learn#25480) Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> * DOC Add docstring example to make_regression (scikit-learn#25551) Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com> Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> * MAINT ensure that pos_label support all possible types (scikit-learn#25317) * MAINT Parameters validation for sklearn.metrics.f1_score (scikit-learn#25557) Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> * ENH Adds `class_names` to `tree.export_text` (scikit-learn#25387) Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com> Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> * MAINT Replace cnp.ndarray with memory views in sklearn.tree._tree (where possible) (scikit-learn#25540) * DOC Change print format in TSNE example (scikit-learn#25569) Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> * FIX ColumnTransformer supports empty selection for pandas output (scikit-learn#25570) Co-authored-by: Julien Jerphanion <git@jjerphan.xyz> * DOC fix docstring of _plain_sgd (scikit-learn#25573) * FIX Enable setting of sub-parameters for deprecated base_estimator param (scikit-learn#25477) * DOC Improve minor and bug-fix release processes documentation (scikit-learn#25457) Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com> Co-authored-by: Jérémie du Boisberranger <jeremiedbb@yahoo.fr> * MAINT Remove ReadonlyArrayWrapper from _loss module (scikit-learn#25555) * MAINT Remove ReadonlyArrayWrapper from _loss module * CLN Remove comments about Cython 3.0 * MAINT Remove ReadonlyArrayWrapper from _kmeans (scikit-learn#25554) * MAINT Remove ReadonlyArrayWrapper from _kmeans * more const and remove blas compile warnings * CLN Adds comment about casting to non const pointers * Update sklearn/utils/_cython_blas.pyx * MAINT Remove ReadonlyArrayWrapper from DistanceMetric (scikit-learn#25553) * DOC improve stop_words description w.r.t. max_df range in CountVectorizer (scikit-learn#25489) * MAINT Removes ReadOnlyWrapper (scikit-learn#25586) * MAINT Parameters validation for sklearn.metrics.log_loss (scikit-learn#25577) * MAINT Adds comments and better naming into tree code (scikit-learn#25576) * MAINT Adds comments and better naming into tree code * CLN Use feature_values instead of Xf * Apply suggestions from code review Co-authored-by: Adam Li <adam2392@gmail.com> * DOC Improve comment from review * Apply suggestions from code review Co-authored-by: Julien Jerphanion <git@jjerphan.xyz> Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> --------- Co-authored-by: Adam Li <adam2392@gmail.com> Co-authored-by: Julien Jerphanion <git@jjerphan.xyz> Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> * FIX error when deserialzing a Tree instance from a read only buffer (scikit-learn#25585) * DOC: fix typo in California Housing dataset description (scikit-learn#25613) * ENH: Update KDTree, and example documentation (scikit-learn#25482) * ENH: Update KDTree, and example documentation * ENH: Add valid metric function and reference doc * CHG: Documentation update Co-authored-by: Adam Li <adam2392@gmail.com> * CHG: make valid metric property and fix doc string * FIX: documentation, and add code example * ENH: Change valid metric to class method, and doc * ENH: Change valid metric class variable, and doc * FIX: documentation error * FIX: documentation error * CHG: Use class method for valid metrics * FIX: CI problems --------- Co-authored-by: Adam Li <adam2392@gmail.com> Co-authored-by: Julien Jerphanion <git@jjerphan.xyz> * TST Common test for checking estimator deserialization from a read only buffer (scikit-learn#25624) * DOC fix comment in plot_logistic_l1_l2_sparsity.py (scikit-learn#25633) Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com> * DOC Places governance in navigation bar (scikit-learn#25618) * MAINT Check pyproject toml is consistent with min_dependencies (scikit-learn#25610) * MAINT Check pyproject toml is consistent with min_dependencies * CLN Make it clear that only SciPy and Cython are checked * CLN Revert auto formatter * MAINT Use newest NumPy C API in tree._criterion (scikit-learn#25615) * MAINT Use newest NumPy C API in tree._criterion * FIX Use pointer for children * FIX Fixes check_array nonfinite checks with ArrayAPI specification (scikit-learn#25619) * FIX Fixes check_array nonfinite checks with ArrayAPI specification * DOC Adds PR number * FIX Test on both cupy and numpy * DOC Correctly docstring in StackingRegressor.fit_transform (scikit-learn#25599) * MAINT Remove Cython compilation warnings ahead of Cython3.0 release (scikit-learn#25621) * ENH Preserve DataFrame dtypes in transform for feature selectors (scikit-learn#25102) * FIX report properly n_iter_ when warm_start=True (scikit-learn#25443) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> * DOC fix typo in KMeans's param. (scikit-learn#25649) * FIX use const memory views in hist_gradient_boosting predictor (scikit-learn#25650) * DOC modified the graph for better readability (scikit-learn#25644) * MAINT Removes upper limit on setuptools (scikit-learn#25651) * DOC improve the `warm_start` glossary entry (scikit-learn#25523) * DOC Update governance document for SLEP020 (scikit-learn#25663) Co-authored-by: Tim Head <betatim@gmail.com> Co-authored-by: Christian Lorentzen <lorentzen.ch@gmail.com> * FIX renormalization of y_pred inside log_loss (scikit-learn#25299) * Remove renormalization of y_pred inside log_loss * Deprecate eps parameter in log_loss * ENH Allows target to be pandas nullable dtypes (scikit-learn#25638) * DOC unify usage of 'w.r.t.' (scikit-learn#25683) * MAINT Parameters validation for metrics.max_error (scikit-learn#25679) * MAINT Parameters validation for datasets.make_friedman1 (scikit-learn#25674) Co-authored-by: jeremie du boisberranger <jeremiedbb@yahoo.fr> * MAINT Parameters validation for mean_pinball_loss (scikit-learn#25685) Co-authored-by: jeremie du boisberranger <jeremiedbb@yahoo.fr> * DOC Specify behavior of None for CountVectorizer (scikit-learn#25678) * DOC Specify behaviour of None for TfIdfVectorizer max_features parameter (scikit-learn#25676) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> * MAINT Set random state for plot_anomaly_comparison (scikit-learn#25675) * MAINT Parameters validation for cluster.mean_shift (scikit-learn#25684) Co-authored-by: jeremie du boisberranger <jeremiedbb@yahoo.fr> * MAINT Parameters validation for sklearn.metrics.jaccard_score (scikit-learn#25680) Co-authored-by: jeremie du boisberranger <jeremiedbb@yahoo.fr> * DOC Add the custom compiler section back (scikit-learn#25667) Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com> * MAINT Parameters validation for precision_recall_fscore_support (scikit-learn#25681) Co-authored-by: jeremie du boisberranger <jeremiedbb@yahoo.fr> * FIX Allow negative tol in SequentialFeatureSelector (scikit-learn#25664) * MAINT Replace deprecated cython conditional compilation (scikit-learn#25654) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> * DOC fix formatting typo in related_projects (scikit-learn#25706) * MAINT Parameters validation for metrics.mean_absolute_percentage_error (scikit-learn#25695) * MAINT Parameters validation for metrics.precision_recall_curve (scikit-learn#25698) Co-authored-by: jeremie du boisberranger <jeremiedbb@yahoo.fr> * MAINT Parameter Validation for metrics.precision_score (scikit-learn#25708) Co-authored-by: jeremie du boisberranger <jeremiedbb@yahoo.fr> * CI Stablize build with random_state (scikit-learn#25701) Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> * MAINT Remove -Wcpp warnings when compiling arrayfuncs (scikit-learn#25415) Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com> * DOC Add scikit-learn-intelex to related projects (scikit-learn#23766) Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com> Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com> * ENH Support float32 in SGDClassifier and SGDRegressor (scikit-learn#25587) * FIX Raise appropriate attribute error in ensemble (scikit-learn#25668) * FIX Allow OrdinalEncoder's encoded_missing_value set to the cardinality (scikit-learn#25704) * ENH Let csr_row_norms support multi-thread (scikit-learn#25598) Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> Co-authored-by: Vincent M <maladiere.vincent@yahoo.fr> * MAINT Parameter Validation for feature_selection.chi2 (scikit-learn#25719) Co-authored-by: jeremiedbb <jeremiedbb@yahoo.fr> * MAINT Parameter Validation for feature_selection.f_classif (scikit-learn#25720) Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> * MAINT Parameters validation for sklearn.metrics.matthews_corrcoef (scikit-learn#25712) Co-authored-by: jeremiedbb <jeremiedbb@yahoo.fr> * MAINT parameter validation for sklearn.datasets.dump_svmlight_file (scikit-learn#25726) Co-authored-by: jeremiedbb <jeremiedbb@yahoo.fr> * MAINT Clean dead code in build helpers (scikit-learn#25661) * MAINT Use newest NumPy C API in metrics._dist_metrics (scikit-learn#25702) * CI Adds permissions to workflows that use GITHUB_TOKEN (scikit-learn#25600) Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> * FIX Improves error message in partial_fit when early_stopping=True (scikit-learn#25694) Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> * DOC Makes navbar static (scikit-learn#25688) * MAINT Remove redundant sparse square euclidian distances function (scikit-learn#25731) * MAINT Use float64 for accumulators in WeightVector* (scikit-learn#25721) * API make PatchExtractor being a real scikit-learn transformer (scikit-learn#24230) Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com> Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> * MAINT Update pyparsing.py to use bool instead of double negation (scikit-learn#25724) * API Deprecates values in partial_dependence in favor of pdp_values (scikit-learn#21809) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> * API Use grid_values instead of pdp_values in partial_dependence (scikit-learn#25732) * MAINT remove np.product and inf/nan aliases in favor of canonical names (scikit-learn#25741) * MAINT Parameters validation for metrics.label_ranking_loss (scikit-learn#25742) Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> * MAINT Parameters validation for metrics.coverage_error (scikit-learn#25748) * MAINT Parameters validation for metrics.dcg_score (scikit-learn#25749) * MAINT replace cnp.ndarray with memory views in _fast_dict (scikit-learn#25754) * MAINT Parameter Validation for feature_selection.f_regression (scikit-learn#25736) Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> * MAINT Parameters validation for feature_selection.r_regression (scikit-learn#25734) Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> * MAINT Parameter Validation for metrics.get_scorer (scikit-learn#25738) Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> * DOC Move allowing pandas nullable dtypes to 1.2.2 (scikit-learn#25692) * MAINT replace cnp.ndarray with memory views in sparsefuncs_fast (scikit-learn#25764) * MAINT parameter validation for sklearn.datasets.fetch_covtype (scikit-learn#25759) Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> * MAINT Define centralized generic, but with explicit precision, types (scikit-learn#25739) * CI Disable network when SciPy requires it (scikit-learn#25743) * CI Open issue when arm wheel fails on CirrusCI (scikit-learn#25620) * ENH Speed-up expected mutual information (scikit-learn#25713) Co-authored-by: Kshitij Mathur <k.mathur68@gmail.com> Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> Co-authored-by: Omar Salman <omar.salman@arbisoft.com> * FIX add retry mechanism to handle quotechar in read_csv (scikit-learn#25511) * Merge Population Creation (#1) --------- Co-authored-by: Alex Buzenet <94121450+albuzenet@users.noreply.github.com> Co-authored-by: Alex <alex.buzenet.fr@gmail.com> Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com> Co-authored-by: Julien Jerphanion <git@jjerphan.xyz> Co-authored-by: Adam Kania <48769688+remilvus@users.noreply.github.com> Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> Co-authored-by: Jérémie du Boisberranger <jeremiedbb@users.noreply.github.com> Co-authored-by: Shady el Gewily <90049412+shadyelgewily-slimstock@users.noreply.github.com> Co-authored-by: John Pangas <swiftyxswaggy@outlook.com> Co-authored-by: Felipe Siola <fsiola@gmail.com> Co-authored-by: Felipe Breve Siola <felipe.breve-siola@klarna.com> Co-authored-by: Tim Head <betatim@gmail.com> Co-authored-by: Christian Lorentzen <lorentzen.ch@gmail.com> Co-authored-by: Loïc Estève <loic.esteve@ymail.com> Co-authored-by: Anthony22-dev <122220081+Anthony22-dev@users.noreply.github.com> Co-authored-by: adossantosalfam <anthony.dos_santos_alfama@insa-rouen.fr> Co-authored-by: Xiao Yuan <yuanx749@gmail.com> Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com> Co-authored-by: Omar Salman <omar.salman@arbisoft.com> Co-authored-by: Rahil Parikh <75483881+rprkh@users.noreply.github.com> Co-authored-by: Gael Varoquaux <gael.varoquaux@normalesup.org> Co-authored-by: Arturo Amor <86408019+ArturoAmorQ@users.noreply.github.com> Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com> Co-authored-by: Meekail Zain <34613774+Micky774@users.noreply.github.com> Co-authored-by: davidblnc <40642621+davidblnc@users.noreply.github.com> Co-authored-by: Changyao Chen <changyao.chen@gmail.com> Co-authored-by: Nicola Fanelli <48762613+nicolafan@users.noreply.github.com> Co-authored-by: Vincent M <maladiere.vincent@yahoo.fr> Co-authored-by: partev <petrosyan@gmail.com> Co-authored-by: ouss1508 <121971998+ouss1508@users.noreply.github.com> Co-authored-by: ashah002 <97778401+ashah002@users.noreply.github.com> Co-authored-by: Ahmedbgh <83551938+Ahmedbgh@users.noreply.github.com> Co-authored-by: Pooja M <90301980+pm155@users.noreply.github.com> Co-authored-by: Ian Thompson <ianiat11@gmail.com> Co-authored-by: Ian Thompson <ian.thompson@hrblock.com> Co-authored-by: SANJAI_3 <86285670+sanjail3@users.noreply.github.com> Co-authored-by: Kaushik Amar Das <cozek@users.noreply.github.com> Co-authored-by: Kaushik Amar Das <kaushik.amar.das@accenture.com> Co-authored-by: Nawazish Alam <nawazishmail@gmail.com> Co-authored-by: William M <64324808+Akbeeh@users.noreply.github.com> Co-authored-by: Jérémie du Boisberranger <jeremiedbb@yahoo.fr> Co-authored-by: JanFidor <66260538+JanFidor@users.noreply.github.com> Co-authored-by: Adam Li <adam2392@gmail.com> Co-authored-by: Logan Thomas <logan.thomas005@gmail.com> Co-authored-by: Vyom Pathak <angerstick3@gmail.com> Co-authored-by: as-90 <88336957+as-90@users.noreply.github.com> Co-authored-by: Marvin Krawutschke <101656586+Marvvxi@users.noreply.github.com> Co-authored-by: Haesun Park <haesunrpark@gmail.com> Co-authored-by: Christine P. Chai <star1327p@gmail.com> Co-authored-by: Christian Veenhuis <124370897+ChVeen@users.noreply.github.com> Co-authored-by: Sortofamudkip <wishyutp0328@gmail.com> Co-authored-by: sonnivs <48860780+sonnivs@users.noreply.github.com> Co-authored-by: Ali H. El-Kassas <aliabdelmonem234@gmail.com> Co-authored-by: Yusuf Raji <raji.yusuf234@gmail.com> Co-authored-by: Tabea Kossen <tabeakossen@gmail.com> Co-authored-by: Pooja Subramaniam <poojas2086@gmail.com> Co-authored-by: JuliaSchoepp <63353759+JuliaSchoepp@users.noreply.github.com> Co-authored-by: Jack McIvor <jacktmcivor@gmail.com> Co-authored-by: zeeshan lone <56621467+still-learning-ev@users.noreply.github.com> Co-authored-by: Max Halford <maxhalford25@gmail.com> Co-authored-by: Adrin Jalali <adrin.jalali@gmail.com> Co-authored-by: genvalen <genvalen@protonmail.com> Co-authored-by: Shiva chauhan <103742975+Shivachauhan17@users.noreply.github.com> Co-authored-by: Dayne <daynesorvisto@yahoo.ca> Co-authored-by: Ralf Gommers <ralf.gommers@gmail.com> Co-authored-by: Kshitij Mathur <k.mathur68@gmail.com>

…-learn#25457) Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com> Co-authored-by: Jérémie du Boisberranger <jeremiedbb@yahoo.fr>

Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org> Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com> Co-authored-by: Jérémie du Boisberranger <jeremiedbb@yahoo.fr>

DOC Correct rebase command for minor release

98499ca

Instructions unclear, got Julien stuck in a _nœud de cerveaux_. This should prevent others to fall in the same trap.

github-actions bot added the Documentation label Jan 23, 2023

ogrisel approved these changes Jan 23, 2023

View reviewed changes

jeremiedbb approved these changes Jan 23, 2023

View reviewed changes

jjerphan marked this pull request as draft January 23, 2023 15:12

jjerphan changed the title ~~DOC Correct rebase command for minor release~~ DOC Improve minor and bug-fix release processes' documentation Jan 24, 2023

DOC Create a dedicated section for the Release Process

293ccca

glemaitre reviewed Jan 26, 2023

View reviewed changes

jeremiedbb reviewed Jan 26, 2023

View reviewed changes

jjerphan added 2 commits February 2, 2023 09:06

Revert "DOC Create a dedicated section for the Release Process"

26ed228

This reverts commit 293ccca.

DOC Update instructions for bug-fix release

a2f71c6

jjerphan marked this pull request as ready for review February 2, 2023 09:13

jjerphan added 2 commits February 2, 2023 11:39

DOC Add information regarding the release manager's rights

5944d98

Merge branch 'main' into doc/correct-minor-release-rebase-command

96fcf46

ogrisel reviewed Feb 2, 2023

View reviewed changes

DOC Improve instructions for bug-fixes releases

dbb9ae4

Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org>

jjerphan commented Feb 6, 2023

View reviewed changes

thomasjpfan approved these changes Feb 6, 2023

View reviewed changes

doc/developers/maintainer.rst Outdated Show resolved Hide resolved

Update doc/developers/maintainer.rst

e5d64e9

Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>

Merge branch 'main' into doc/correct-minor-release-rebase-command

7f53c47

thomasjpfan mentioned this pull request Feb 7, 2023

Streamlining Bug Fix Releases #25564

Open

jeremiedbb approved these changes Feb 9, 2023

View reviewed changes

doc/developers/maintainer.rst Outdated Show resolved Hide resolved

doc/developers/maintainer.rst Outdated Show resolved Hide resolved

DOC Simplify instructions and fix rendering

4bb998a

Co-authored-by: Jérémie du Boisberranger <jeremiedbb@yahoo.fr>

jeremiedbb enabled auto-merge (squash) February 9, 2023 13:59

jeremiedbb merged commit 4f85597 into scikit-learn:main Feb 9, 2023

jjerphan deleted the doc/correct-minor-release-rebase-command branch February 9, 2023 14:58

		@@ -1,319 +1,6 @@
		Maintainer / core-developer information
		Maintainer / core-developer information

		The release manager must be a maintainer of ``scikit-learn`` to be able to
		publish on ``pypi.org`` and ``test.pypi.org``.

	- Create a PR to the `upstream/1.2.X` branch (not to `upstream/main`)
	- Create a Draft PR to the `upstream/1.2.X` branch (not to `upstream/main`)

		Minor version release and bug-fix release
		~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-Pull Request to track progress.
+Pull Request to track progress.
+Review all the commits included in the release to make sure that they do not introduce
+any new feature. We should not blindly trust the commit message prefixes.
+Remove the draft status of the release PR and invite other maintainers to review the
+list of included commits.


		Do not forget to add a commit updating ``sklearn.__version__``.
		- Create a commit updating the version number i.e. ``sklearn.__version__``.

- - Create a commit updating the version number i.e. ``sklearn.__version__``.
+ - Force push the result of the rebase and the extra release commits to the
+   release PR:
+   .. prompt:: bash $
+       git push -f fork release-1.2.2:release-1.2.2

-       `DOC`
+       `DOC`. They should at least include all the commits of the merged PRs
+       that were milestoned for this PR on github and/or documented as such in
+       the changelog. It's likely that the some bugfixes where document in the
+       changelog of the main major release instead of the next bugfix release,
+       in which case, the matching changelog entries will need to be moved,
+       first in the `main` branch then backported in the release PR.

DOC Improve minor and bug-fix release processes' documentation #25457

DOC Improve minor and bug-fix release processes' documentation #25457

Conversation

jjerphan commented Jan 23, 2023 • edited Loading

Reference Issues/PRs

What does this implement/fix? Explain your changes.

ogrisel left a comment

Choose a reason for hiding this comment

jeremiedbb commented Jan 23, 2023

jeremiedbb commented Jan 23, 2023

jjerphan commented Jan 23, 2023

ogrisel commented Jan 23, 2023

glemaitre commented Jan 23, 2023

ogrisel commented Jan 23, 2023

glemaitre commented Jan 23, 2023

jjerphan commented Jan 24, 2023

jjerphan commented Jan 26, 2023

Choose a reason for hiding this comment

glemaitre commented Jan 26, 2023

jeremiedbb commented Jan 26, 2023

Choose a reason for hiding this comment

jjerphan Feb 2, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ogrisel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jjerphan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thomasjpfan left a comment

Choose a reason for hiding this comment

jjerphan commented Feb 8, 2023 • edited Loading

jeremiedbb left a comment

Choose a reason for hiding this comment

jjerphan commented Jan 23, 2023 •

edited

Loading

jjerphan Feb 2, 2023 •

edited

Loading

jjerphan commented Feb 8, 2023 •

edited

Loading