Skip to content

Commit 053f81c

Browse files
Update README.md
1 parent 40d5584 commit 053f81c

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ADAPT
22

33
[![PyPI version](https://badge.fury.io/py/adapt.svg)](https://pypi.org/project/adapt)
4-
[![Build Status](https://github.com/adapt-python/adapt/workflows/build/badge.svg)](https://github.com/adapt-python/adapt/actions)
4+
[![Build Status](https://github.com/adapt-python/adapt/actions/workflows/run-test.yml/badge.svg)](https://github.com/adapt-python/adapt/actions)
55
[![Python Version](https://img.shields.io/badge/python-3.6%20|%203.7%20|%203.8|%203.9-blue)](https://img.shields.io/badge/python-3.6%20|%203.7%20|%203.8|%203.9-blue)
66
[![Codecov Status](https://codecov.io/gh/adapt-python/adapt/branch/master/graph/badge.svg?token=IWQXMYGY2Q)](https://codecov.io/gh/adapt-python/adapt)
77

@@ -72,11 +72,12 @@ The following dependencies are required and will be installed with the library:
7272
- `tensorflow` (>= 2.0)
7373
- `scikit-learn`
7474
- `cvxopt`
75+
- `scikeras`
7576

7677
If for some reason, these packages failed to install, you can do it manually with:
7778

7879
```
79-
pip install numpy scipy tensorflow scikit-learn cvxopt
80+
pip install numpy scipy tensorflow scikit-learn cvxopt scikeras
8081
```
8182

8283
Finally import the module in your python scripts with:
@@ -87,6 +88,15 @@ import adapt
8788

8889
A simple example of usage is given in the [Quick-Start](#Quick-Start) below.
8990

91+
### Stable environments [Updated Dec 2023]
92+
93+
ADAPT sometimes encounters incompatibility issue after a new Tensorflow release. In this case, you can use the following environment, which has passed all tests. ADAPT should work well on it:
94+
- OS: `ubuntu-22.04, windows-2022, macos-12`
95+
- Python versions: `3.8 to 3.11`
96+
97+
```
98+
pip install numpy==1.26.2 scipy==1.11.4 tensorflow==2.15.0 scikit-learn==1.3.2 cvxopt==1.3.2 scikeras==0.12.0
99+
```
90100

91101
## ADAPT Guideline
92102

0 commit comments

Comments
 (0)