Skip to content

Commit 646c389

Browse files
committed
DOC update dependencies in the documentation
1 parent 9c12fc4 commit 646c389

File tree

3 files changed

+32
-4
lines changed

3 files changed

+32
-4
lines changed

README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
.. |PythonMinVersion| replace:: 3.10
3131
.. |NumPyMinVersion| replace:: 1.24.3
3232
.. |SciPyMinVersion| replace:: 1.10.1
33-
.. |ScikitLearnMinVersion| replace:: 1.2.2
33+
.. |ScikitLearnMinVersion| replace:: 1.3.2
3434
.. |MatplotlibMinVersion| replace:: 3.7.3
3535
.. |PandasMinVersion| replace:: 1.5.3
3636
.. |TensorflowMinVersion| replace:: 2.13.1

doc/install.rst

+29-3
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,35 @@ Getting Started
77
Prerequisites
88
=============
99

10-
You can find the complete list of the dependencies in the following table:
11-
12-
.. include:: min_dependency_table.rst
10+
.. |PythonMinVersion| replace:: 3.10
11+
.. |NumPyMinVersion| replace:: 1.24.3
12+
.. |SciPyMinVersion| replace:: 1.10.1
13+
.. |ScikitLearnMinVersion| replace:: 1.3.2
14+
.. |MatplotlibMinVersion| replace:: 3.7.3
15+
.. |PandasMinVersion| replace:: 1.5.3
16+
.. |TensorflowMinVersion| replace:: 2.13.1
17+
.. |KerasMinVersion| replace:: 3.0.5
18+
.. |SeabornMinVersion| replace:: 0.12.2
19+
.. |PytestMinVersion| replace:: 7.2.2
20+
21+
`imbalanced-learn` requires the following dependencies:
22+
23+
- Python (>= |PythonMinVersion|)
24+
- NumPy (>= |NumPyMinVersion|)
25+
- SciPy (>= |SciPyMinVersion|)
26+
- Scikit-learn (>= |ScikitLearnMinVersion|)
27+
- Pytest (>= |PytestMinVersion|)
28+
29+
Additionally, `imbalanced-learn` requires the following optional dependencies:
30+
31+
- Pandas (>= |PandasMinVersion|) for dealing with dataframes
32+
- Tensorflow (>= |TensorflowMinVersion|) for dealing with TensorFlow models
33+
- Keras (>= |KerasMinVersion|) for dealing with Keras models
34+
35+
The examples will requires the following additional dependencies:
36+
37+
- Matplotlib (>= |MatplotlibMinVersion|)
38+
- Seaborn (>= |SeabornMinVersion|)
1339

1440
Install
1541
=======

imblearn/utils/tests/test_min_dependencies.py

+2
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ def process_requirements(requirements):
7676

7777
package, version = matched.group(2), matched.group(5)
7878
package = package.lower()
79+
if package == "scikitlearn":
80+
package = "scikit-learn"
7981

8082
if package in min_dependencies:
8183
version = parse(version)

0 commit comments

Comments
 (0)