Skip to content

Commit

Permalink
DOC update dependencies in the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
glemaitre committed Dec 20, 2024
1 parent 9c12fc4 commit 646c389
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
.. |PythonMinVersion| replace:: 3.10
.. |NumPyMinVersion| replace:: 1.24.3
.. |SciPyMinVersion| replace:: 1.10.1
.. |ScikitLearnMinVersion| replace:: 1.2.2
.. |ScikitLearnMinVersion| replace:: 1.3.2
.. |MatplotlibMinVersion| replace:: 3.7.3
.. |PandasMinVersion| replace:: 1.5.3
.. |TensorflowMinVersion| replace:: 2.13.1
Expand Down
32 changes: 29 additions & 3 deletions doc/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,35 @@ Getting Started
Prerequisites
=============

You can find the complete list of the dependencies in the following table:

.. include:: min_dependency_table.rst
.. |PythonMinVersion| replace:: 3.10
.. |NumPyMinVersion| replace:: 1.24.3
.. |SciPyMinVersion| replace:: 1.10.1
.. |ScikitLearnMinVersion| replace:: 1.3.2
.. |MatplotlibMinVersion| replace:: 3.7.3
.. |PandasMinVersion| replace:: 1.5.3
.. |TensorflowMinVersion| replace:: 2.13.1
.. |KerasMinVersion| replace:: 3.0.5
.. |SeabornMinVersion| replace:: 0.12.2
.. |PytestMinVersion| replace:: 7.2.2

`imbalanced-learn` requires the following dependencies:

- Python (>= |PythonMinVersion|)
- NumPy (>= |NumPyMinVersion|)
- SciPy (>= |SciPyMinVersion|)
- Scikit-learn (>= |ScikitLearnMinVersion|)
- Pytest (>= |PytestMinVersion|)

Additionally, `imbalanced-learn` requires the following optional dependencies:

- Pandas (>= |PandasMinVersion|) for dealing with dataframes
- Tensorflow (>= |TensorflowMinVersion|) for dealing with TensorFlow models
- Keras (>= |KerasMinVersion|) for dealing with Keras models

The examples will requires the following additional dependencies:

- Matplotlib (>= |MatplotlibMinVersion|)
- Seaborn (>= |SeabornMinVersion|)

Install
=======
Expand Down
2 changes: 2 additions & 0 deletions imblearn/utils/tests/test_min_dependencies.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ def process_requirements(requirements):

package, version = matched.group(2), matched.group(5)
package = package.lower()
if package == "scikitlearn":
package = "scikit-learn"

if package in min_dependencies:
version = parse(version)
Expand Down

0 comments on commit 646c389

Please sign in to comment.