Skip to content

Commit

Permalink
Merge pull request #92 from deel-ai/doc/link_to_keras3_branch
Browse files Browse the repository at this point in the history
Message for Keras 3 nigthly version in documentation
  • Loading branch information
cofri authored Jan 17, 2025
2 parents 51d693b + 4698206 commit c5a450a
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,18 @@ layers for keras**.
> advised to use TensorFlow versions lower than 2.16 to ensure compatibility and proper
> functionality of this package.
>
> We are actively working on updating the package to support Keras 3. Please stay tuned
> for updates. For now, make sure to install an earlier version of TensorFlow by
> specifying it in your environment.
> We're excited to announce that a nightly version of deel-lip with support for Keras 3
> is now available for testing! If you'd like to experiment with the latest updates
> and improvements, feel free to check out the `keras3` branch.
>
> ```bash
> pip install git+https://github.com/deel-ai/deel-lip.git@keras3
> ```
>
> Please note that this version is still under development and may contain experimental
> features. We welcome your feedback and encourage you to report any issues you
> encounter.
## 📚 Table of contents
Expand Down
21 changes: 21 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,27 @@ distance estimation.
This library provides an efficient implementation of **k-Lispchitz
layers for keras**.

> [!CAUTION]
> **Incompatibility with TensorFlow >= 2.16 and Keras 3**
>
> Due to significant changes introduced in TensorFlow version 2.16 and Keras 3, this
> package is currently incompatible with TensorFlow versions 2.16 and above. Users are
> advised to use TensorFlow versions lower than 2.16 to ensure compatibility and proper
> functionality of this package.
>
> We're excited to announce that a nightly version of deel-lip with support for Keras 3
> is now available for testing! If you'd like to experiment with the latest updates
> and improvements, feel free to check out the `keras3` branch.
>
> ```bash
> pip install git+https://github.com/deel-ai/deel-lip.git@keras3
> ```
>
> Please note that this version is still under development and may contain experimental
> features. We welcome your feedback and encourage you to report any issues you
> encounter.
## 📚 Table of contents
- [📚 Table of contents](#-table-of-contents)
Expand Down

0 comments on commit c5a450a

Please sign in to comment.