1
1
# Goal
2
2
3
- This repo implements brownout for the deprecated ` sklearn ` package on PyPI.
3
+ This repo implements the brownout for deprecating the ` sklearn ` package on PyPI.
4
+
5
+ # How to fix the error for the main use cases
6
+
7
+ - use ` pip install scikit-learn ` rather than ` pip install sklearn `
8
+ - replace ` sklearn ` by ` scikit-learn ` in your pip requirements files
9
+ (` requirements.txt ` , ` setup.py, ` ` setup.cfg ` , ` Pipfile ` , etc ...)
10
+ - if the ` sklearn ` package is used by one of your dependencies
11
+ it would be great if you take some time to track which package uses
12
+ ` sklearn ` instead of ` scikit-learn ` and report it to their issue tracker
13
+ - as last resort, set the environment variable ,
14
+ ` SKLEARN_ALLOW_DEPRECATED_SKLEARN_PACKAGE_INSTALL=True ` to avoid this error
4
15
5
16
# Brownout schedule
6
17
@@ -17,16 +28,20 @@ raised if you attempt to install the `sklearn` package from PyPI.
17
28
| 2023 October 1st - November 30th | :00-:20 and :00-50 every hour |
18
29
| 2023 December 1st onwards | always raise an exception |
19
30
20
- # How to fix the error for the main use cases
31
+ # Testing whether a package will be affected by the ` sklearn ` deprecation
21
32
22
- - use ` pip install scikit-learn ` rather than ` pip install sklearn `
23
- - replace ` sklearn ` by ` scikit-learn ` in your pip requirements files
24
- (` requirements.txt ` , ` setup.py, ` ` setup.cfg ` , ` Pipfile ` , etc ...)
25
- - if the ` sklearn ` package is used by one of your dependencies
26
- it would be great if you take some time to track which package uses
27
- ` sklearn ` instead of ` scikit-learn ` and report it to their issue tracker
28
- - as last resort, set the environment variable ,
29
- ` SKLEARN_ALLOW_DEPRECATED_SKLEARN_PACKAGE_INSTALL=True ` to avoid this error
33
+ If you want to test whether a package has ` sklearn ` in its dependencies
34
+ independently of the brownout schedule, you can do:
35
+
36
+ ```
37
+ SKLEARN_ALLOW_DEPRECATED_SKLEARN_PACKAGE_INSTALL=False \
38
+ pip install package-to-test-goes-here
39
+ ```
40
+
41
+ If you get an error that means that the package has ` sklearn ` in one of its
42
+ dependencies. It would be greatly appreciated if you track which package it is,
43
+ and if you report it to the appropriate project issue tracker to make them
44
+ aware of the ` sklearn ` deprecation.
30
45
31
46
# Reason for the deprecation
32
47
@@ -52,17 +67,3 @@ implemented:
52
67
list` output prompting questions like "why do I have scikit-learn 1.1.1 and
53
68
sklearn 0.0, and what does it even mean"?
54
69
55
- # Testing whether a package will be affected by the ` sklearn ` deprecation
56
-
57
- If you want to test whether a package has ` sklearn ` in its dependencies
58
- independently of the brownout schedule, you can do:
59
-
60
- ```
61
- SKLEARN_ALLOW_DEPRECATED_SKLEARN_PACKAGE_INSTALL=False \
62
- pip install package-to-test-goes-here
63
- ```
64
-
65
- If you get an error that means that the package has ` sklearn ` in one of its
66
- dependencies. It would be greatly appreciated if you track which package it is,
67
- and if you report it to the appropriate project issue tracker to make them
68
- aware of the ` sklearn ` deprecation.
0 commit comments