From 23e77a5455bf685e8b10b6dff060a43463b8ec19 Mon Sep 17 00:00:00 2001 From: LukasMahieu Date: Fri, 15 Nov 2024 15:44:01 +0100 Subject: [PATCH 1/2] update doc links to stable version --- README.md | 10 ++++++---- docs/installation.md | 6 +++--- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index bbed2ea..8482572 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ Please refer to the [documentation][link-docs]. In particular, the - [Tutorials][link-tutorials] - [API documentation][link-api] +- [API documentation dev][link-api-latest] ## Installation @@ -46,7 +47,7 @@ pip install torch pip install crested ``` -3. If you plan on doing motif analysis using the tf-modisco (lite) inside CREsted, you will need to run the following additional install: +3. If you plan on doing motif analysis using tf-modisco (lite) inside CREsted, you will need to run the following additional install: ```bash pip install "modisco-lite>=2.2.1" @@ -79,7 +80,8 @@ CREsted is build on top of keras 3.0 and can therefore be used with your deep le 3. Current Keras 3.0 is still in active development and some features (mainly multi GPU training and weights and biases logging) are currently only supported with the Tensorflow backend. If you plan on using these features, you should choose Tensorflow. We will implement these features in a backend agnostic way as soon as Keras 3.0 has done so (it is on their roadmap). [issue-tracker]: https://github.com/aertslab/CREsted/issues -[changelog]: https://crested.readthedocs.io/en/latest/changelog.html +[changelog]: https://crested.readthedocs.io/en/stable/changelog.html [link-docs]: https://crested.readthedocs.io -[link-tutorials]: https://crested.readthedocs.io/en/latest/tutorials/index.html -[link-api]: https://crested.readthedocs.io/en/latest/api/index.html +[link-tutorials]: https://crested.readthedocs.io/en/stable/tutorials/index.html +[link-api]: https://crested.readthedocs.io/en/stable/index.html +[link-api-latest]: https://crested.readthedocs.io/en/latest/index.html diff --git a/docs/installation.md b/docs/installation.md index 7f5294c..5547d8d 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -21,13 +21,13 @@ pip install torch pip install crested ``` -3. If you plan on using the tf-modisco (lite) functionality inside CREsted, you will need to run the following additional install: +3. If you plan on doing motif analysis using tf-modisco (lite) inside CREsted, you will need to run the following additional install: ```bash -pip install crested[tfmodisco] +pip install "modisco-lite>=2.2.1" ``` -This requires a cmake installation on your system. If you don't have it, you can install it with: +Modiscolite may require a cmake installation on your system. If you don't have it, you can install it with: ```bash pip install cmake From 6b6646f8392f0981059a97def28d7844c1ba9c81 Mon Sep 17 00:00:00 2001 From: LukasMahieu Date: Fri, 15 Nov 2024 15:47:25 +0100 Subject: [PATCH 2/2] update doc links to stable version --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 8482572..3e96756 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,6 @@ Please refer to the [documentation][link-docs]. In particular, the - [Tutorials][link-tutorials] - [API documentation][link-api] -- [API documentation dev][link-api-latest] ## Installation