From 1eae849db8486fef14b5fb7304d2bea8b71e9a3b Mon Sep 17 00:00:00 2001
From: Paul Andrey <paul.andrey@inria.fr>
Date: Wed, 10 May 2023 15:05:22 +0200
Subject: [PATCH] Improve some documentation formatting.
---
declearn/dataset/_split_data.py | 3 ++-
declearn/model/haiku/_vector.py | 8 ++++----
declearn/model/tensorflow/_vector.py | 8 ++++----
declearn/model/torch/_vector.py | 8 ++++----
docs/quickstart.md | 4 ++--
5 files changed, 16 insertions(+), 15 deletions(-)
diff --git a/declearn/dataset/_split_data.py b/declearn/dataset/_split_data.py
index 017c9c08..1729c2dd 100644
--- a/declearn/dataset/_split_data.py
+++ b/declearn/dataset/_split_data.py
@@ -144,7 +144,8 @@ def split_data(
) -> None:
"""Randomly split a dataset into shards.
- The resulting folder structure is :
+ The resulting folder structure is:
+
folder/
└─── data*/
└─── client*/
diff --git a/declearn/model/haiku/_vector.py b/declearn/model/haiku/_vector.py
index e1f106f1..7797ee62 100644
--- a/declearn/model/haiku/_vector.py
+++ b/declearn/model/haiku/_vector.py
@@ -53,10 +53,10 @@ class JaxNumpyVector(Vector):
Notes
-----
- A `JaxnumpyVector` can be operated with either a:
- - scalar value
- - `NumpyVector` that has similar specifications
- - `JaxNumpyVector` that has similar specifications
- => resulting in a `JaxNumpyVector` in each of these cases.
+ - scalar value
+ - `NumpyVector` that has similar specifications
+ - `JaxNumpyVector` that has similar specifications
+ - => resulting in a `JaxNumpyVector` in each of these cases.
- The wrapped arrays may be placed on any device (CPU, GPU...)
and may not be all on the same device.
- The device-placement of the initial `JaxNumpyVector`'s data
diff --git a/declearn/model/tensorflow/_vector.py b/declearn/model/tensorflow/_vector.py
index 401bbb06..079aa170 100644
--- a/declearn/model/tensorflow/_vector.py
+++ b/declearn/model/tensorflow/_vector.py
@@ -96,10 +96,10 @@ class TensorflowVector(Vector):
Notes
-----
- A `TensorflowVector` can be operated with either a:
- - scalar value
- - `NumpyVector` that has similar specifications
- - `TensorflowVector` that has similar specifications
- => resulting in a `TensorflowVector` in each of these cases.
+ - scalar value
+ - `NumpyVector` that has similar specifications
+ - `TensorflowVector` that has similar specifications
+ - => resulting in a `TensorflowVector` in each of these cases.
- The wrapped tensors may be placed on any device (CPU, GPU...)
and may not be all on the same device.
- The device-placement of the initial `TensorflowVector`'s data
diff --git a/declearn/model/torch/_vector.py b/declearn/model/torch/_vector.py
index 662aaa10..91d93be3 100644
--- a/declearn/model/torch/_vector.py
+++ b/declearn/model/torch/_vector.py
@@ -48,10 +48,10 @@ class TorchVector(Vector):
Notes
-----
- A `TorchVector` can be operated with either a:
- - scalar value
- - `NumpyVector` that has similar specifications
- - `TorchVector` that has similar specifications
- => resulting in a `TorchVector` in each of these cases.
+ - scalar value
+ - `NumpyVector` that has similar specifications
+ - `TorchVector` that has similar specifications
+ - => resulting in a `TorchVector` in each of these cases.
- The wrapped tensors may be placed on any device (CPU, GPU...)
and may not be all on the same device.
- The device-placement of the initial `TorchVector`'s data
diff --git a/docs/quickstart.md b/docs/quickstart.md
index be711050..f2c4d8f6 100644
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -52,8 +52,8 @@ declearn-quickrun --config "examples/mnist_quickrun/config.toml"
**To better understand the details** of what happens under the hood you can
look at what the key element of the declearn process are in
-[section 1.2.](#12-python-script). To understand how to use the quickrun mode
-in practice, see [section 2.1.](#21-quickrun-on-your-problem).
+[section 1.2](#12-python-script). To understand how to use the quickrun mode
+in practice, see [section 2.1](#21-quickrun-on-your-problem).
### 1.2. Python script
--
GitLab