8000 DOC Add lock-file trick to help debug CI issues by lesteve · Pull Request #29435 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC Add lock-file trick to help debug CI issues #29435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 9, 2024
Merged

DOC Add lock-file trick to help debug CI issues #29435

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
62d9374
DOC Add how to create an environment from lock-file to debug CI issues
lesteve Jul 8, 2024
d4a4873
rst what else
lesteve Jul 8, 2024
b7455de
Add backup plan using environment yaml file
lesteve Jul 9, 2024
06a39e2
tweak
lesteve Jul 9, 2024
35e6fbe
Apply suggestions from code review
lesteve Jul 9, 2024
f7b7c11
Tweaks
lesteve Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions doc/developers/tips.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,57 @@ PR: Don't change unrelated

Please do not change unrelated lines. It makes your contribution harder to review and may introduce merge conflicts to other pull requests.

.. _debugging_ci_issues:

Debugging CI issues
-------------------

CI issues may arise for a variety of reasons, so this is by no means a
comprehensive guide, but rather a list of useful tips and tricks.

Using a lock-file to get an environment close to the CI
+++++++++++++++++++++++++++++++++++++++++++++++++++++++

`conda-lock` can be used to create a conda environment with the exact same
conda and pip packages as on the CI. For example, the following command will
create a conda environment named `scikit-learn-doc` that is similar to the CI:

.. prompt:: bash $

conda-lock install -n scikit-learn-doc build_tools/circle/doc_linux-64_conda.lock

.. note::

It only works if you have the same OS as the CI build (check `platform:` in
the lock-file). For example, the previous command will only work if you are
on a Linux machine. Also this may not allow you to reproduce some of the
issues that are more tied to the particularities of the CI environment, for
example CPU architecture reported by OpenBLAS in `sklearn.show_versions()`.

If you don't have the same OS as the CI build you can still create a conda
environment from the right environment yaml file, although it won't be as close
as the CI environment as using the associated lock-file. For example for the
doc build:

.. prompt:: bash $

conda env create -n scikit-learn-doc -f build_tools/circle/doc_environment.yml -y

This may not give you exactly the same package versions as in the CI for a
variety of reasons, for example:

- some packages may have had new releases between the time the lock files were
last updated in the `main` branch and the time you run the `conda create`
command. You can always try to look at the version in the lock-file and
specify the versions by hand for some specific packages that you think would
help reproducing the issue.
- different packages may be installed by default depending on the OS. For
example, the default BLAS library when installing numpy is OpenBLAS on Linux
and MKL on Windows.

Also the problem may be OS specific so the only way to be able to reproduce
would be to have the same OS as the CI build.

.. highlight:: default

Debugging memory errors in Cython with valgrind
Expand Down
0