From e95ece2ee68e98a570539c1f3eac4d68d83e571e Mon Sep 17 00:00:00 2001
From: Paul Andrey <paul.andrey@inria.fr>
Date: Wed, 10 May 2023 14:48:56 +0200
Subject: [PATCH] Fix 'declearn.model' main module docstring.
---
declearn/model/__init__.py | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/declearn/model/__init__.py b/declearn/model/__init__.py
index 71b604e8..927518ed 100644
--- a/declearn/model/__init__.py
+++ b/declearn/model/__init__.py
@@ -42,10 +42,13 @@ The automatically-imported submodules implemented here are:
Optional Submodules
-------------------
The optional-dependency-based submodules that may be manually imported are:
-* haiku: jax- and haiku-interfacing tools
- - HaikuModel: Model to wrap a haiku-transformable model function.
- - JaxNumpyVector: Vector for jax array data structures.
+* [haiku][declearn.model.haiku]:
+ Jax- and Haiku-interfacing tools.
+ - [HaikuModel][declearn.model.haiku.HaikuModel]:
+ Model to wrap a haiku-transformable model function.
+ - [JaxNumpyVector][declearn.model.haiku.JaxNumpyVector]:
+ Vector for jax array data structures.
* [tensorflow][declearn.model.tensorflow]:
TensorFlow-interfacing tools
- [TensorflowModel][declearn.model.tensorflow.TensorflowModel]:
@@ -68,7 +71,7 @@ from . import api
from . import sklearn
OPTIONAL_MODULES = [
- "jax",
+ "haiku",
"tensorflow",
"torch",
]
--
GitLab