Skip to content

Commit 98709df

Browse files
Add save and load utils function to documentation
1 parent b64d8be commit 98709df

File tree

5 files changed

+25
-0
lines changed

5 files changed

+25
-0
lines changed

docs/source/api_reference/utils.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@ The {mod}`frouros.utils` module contains auxiliary classes, functions or excepti
88
utils/checks
99
utils/data_structures
1010
utils/kernels
11+
utils/persistence
1112
utils/stats
1213
```
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Persistence
2+
3+
The {mod}`frouros.utils.persistence` module contains auxiliary functions to persistence objects.
4+
5+
```{eval-rst}
6+
.. automodule:: frouros.utils.persistence
7+
:members:
8+
:no-inherited-members:
9+
```

docs/source/examples.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@
55
66
examples/concept_drift
77
examples/data_drift
8+
examples/utils
89
```

docs/source/examples/utils.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Utils
2+
3+
```{toctree}
4+
:maxdepth: 1
5+
6+
utils/save_load
7+
```

docs/source/faq.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,3 +83,10 @@ including guidelines for reporting issues, submitting feature requests, and cont
8383

8484
Frouros does not currently provide built-in visualization tools for drift detection results, but it is planned to
8585
include them in future releases.
86+
87+
## How can I persist a detector or callback for later use?
88+
89+
Frouros provides a [persistence module](./api_reference/utils/persistence.html) that allows you to persist a detector
90+
or callback for later use. It offers [save](api_reference/utils/persistence.html#frouros.utils.persistence.save) and
91+
[load](api_reference/utils/persistence.html#frouros.utils.persistence.load) methods to save and load the detector or
92+
callback to and from disk, respectively.

0 commit comments

Comments
 (0)