Skip to content

Commit

Permalink
Add information to README highlighting the update guidance. To be rem…
Browse files Browse the repository at this point in the history
…oved at first release.
  • Loading branch information
jatkinson1000 committed Jun 27, 2024
1 parent 945e24a commit f97909c
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ For full API and user documentation please see the
[online documentation](https://cambridge-iccs.github.io/FTorch/) which is
significantly more detailed than this README.

**NOTE:** _We recently made breaking changes to the API as it heads towards a stable release.
Please see the
[online updates documentation](https://cambridge-iccs.github.io/FTorch/page/updates.html)
for clear guidance on how to easily update your older code to run with the latest version of
FTorch._


## Contents
- [Description](#description)
- [Installation](#installation)
Expand Down Expand Up @@ -60,7 +67,10 @@ The following presentations provide an introduction and overview of _FTorch_:

Project status: This project is currently in pre-release with documentation and code
being prepared for a first release.
As such breaking changes may be made.
As we stabilise the API in preparation for first release there may be some breaking changes.
Please see
[online updates documentation](https://cambridge-iccs.github.io/FTorch/page/updates.html)
for clear guidance on how to easily update your older code to run with the latest version.\
If you are interested in using this library please get in touch.

_For a similar approach to calling TensorFlow models from Fortran please see [Fortran-TF-lib](https://github.com/Cambridge-ICCS/fortran-tf-lib)._
Expand Down

0 comments on commit f97909c

Please sign in to comment.