Skip to content

Commit 9e18649

Browse files
committed
update readme and doc for pip installing from branch
1 parent 8d87250 commit 9e18649

File tree

6 files changed

+12
-16
lines changed

6 files changed

+12
-16
lines changed

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,15 @@ has many applications ranging from adversarial robustness to Wasserstein
3838
distance estimation.
3939

4040
This library provides an efficient implementation of **k-Lispchitz
41-
layers for keras**.
41+
layers for Keras 3**.
4242

4343
> [!CAUTION]
44-
> **Incompatibility with TensorFlow >= 2.16 and Keras 3**
44+
> **This branch is a major update designed for compatibility with TensorFlow 2.16 and Keras 3**
4545
>
46-
> Due to significant changes introduced in TensorFlow version 2.16 and Keras 3, this
47-
> package is currently incompatible with TensorFlow versions 2.16 and above. Users are
48-
> advised to use TensorFlow versions lower than 2.16 to ensure compatibility and proper
46+
> Due to significant changes introduced in TensorFlow 2.16 and Keras 3, backward compatibility
47+
> with older TensorFlow versions can no longer be maintained. Users requiring an older version
48+
> of TensorFlow are encouraged to clone the master branch to ensure compatibility and proper
4949
> functionality of this package.
50-
>
51-
> We are actively working on updating the package to support Keras 3. Please stay tuned
52-
> for updates. For now, make sure to install an earlier version of TensorFlow by
53-
> specifying it in your environment.
5450
5551
## 📚 Table of contents
5652

@@ -69,7 +65,7 @@ layers for keras**.
6965
You can install ``deel-lip`` directly from pypi:
7066

7167
```python
72-
pip install deel-lip
68+
pip install git+https://github.com/deel-ai/deel-lip.git@keras3
7369
```
7470

7571
In order to use ``deel-lip``, you also need a [valid tensorflow

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ layers for keras**.
5454
You can install ``deel-lip`` directly from pypi:
5555

5656
```python
57-
pip install deel-lip
57+
pip install git+https://github.com/deel-ai/deel-lip.git@keras3
5858
```
5959

6060
In order to use ``deel-lip``, you also need a [valid tensorflow

docs/notebooks/demo1.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
"metadata": {},
5353
"outputs": [],
5454
"source": [
55-
"# pip install deel-lip -qqq"
55+
"# pip install git+https://github.com/deel-ai/deel-lip.git@keras3 -qqq"
5656
]
5757
},
5858
{

docs/notebooks/demo2.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"metadata": {},
2020
"outputs": [],
2121
"source": [
22-
"# pip install deel-lip -qqq"
22+
"# pip install git+https://github.com/deel-ai/deel-lip.git@keras3 -qqq"
2323
]
2424
},
2525
{

docs/notebooks/demo3.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"metadata": {},
1818
"outputs": [],
1919
"source": [
20-
"# pip install deel-lip -qqq"
20+
"# pip install git+https://github.com/deel-ai/deel-lip.git@keras3 -qqq"
2121
]
2222
},
2323
{

docs/notebooks/demo4.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
},
2525
{
2626
"cell_type": "code",
27-
"execution_count": 1,
27+
"execution_count": null,
2828
"metadata": {
2929
"colab": {
3030
"base_uri": "https://localhost:8080/"
@@ -34,7 +34,7 @@
3434
},
3535
"outputs": [],
3636
"source": [
37-
"# pip install deel-lip foolbox -qqq"
37+
"# pip install git+https://github.com/deel-ai/deel-lip.git@keras3 foolbox -qqq"
3838
]
3939
},
4040
{

0 commit comments

Comments
 (0)