File tree Expand file tree Collapse file tree 4 files changed +17
-53
lines changed
docs/source/api_reference
frouros/detectors/data_drift Expand file tree Collapse file tree 4 files changed +17
-53
lines changed Original file line number Diff line number Diff line change 11# Utils
22
3- ``` {eval-rst}
4- .. automodule:: frouros.utils
5- :no-members:
6- :no-inherited-members:
7- ```
3+ The {mod}` frouros.utils ` module contains auxiliary classes or functions.
84
9- ``` {currentmodule} frouros.utils
10- ```
5+ ``` {toctree}
6+ :maxdepth: 2
117
12- ## Data structures
13-
14- ``` {eval-rst}
15- .. automodule:: frouros.utils.data_structures
16- :no-members:
17- :no-inherited-members:
18- ```
19-
20- ``` {eval-rst}
21- .. autosummary::
22- :toctree: auto_generated/
23- :template: class.md
24-
25- EmptyQueueError
26- CircularQueue
27- AccuracyQueue
28- ```
29-
30- ## Stats
31-
32- ``` {eval-rst}
33- .. automodule:: frouros.utils.stats
34- :no-members:
35- :no-inherited-members:
36- ```
37-
38- ``` {eval-rst}
39- .. autosummary::
40- :toctree: auto_generated/
41- :template: class.md
42-
43- IncrementalStat
44- Mean
45- EWMA
46- ```
47-
48- ``` {eval-rst}
49- .. autosummary::
50- :toctree: auto_generated/
51- :template: function.md
52-
53- permutation
8+ utils/kernels
549```
Original file line number Diff line number Diff line change 1+ # Kernels
2+
3+ The {mod}` frouros.utils.kernels ` module contains auxiliary kernel functions.
4+
5+ ``` {eval-rst}
6+ .. automodule:: frouros.utils.kernels
7+ :members:
8+ :no-inherited-members:
9+ ```
Original file line number Diff line number Diff line change 1919class MMD (BaseDistanceBased ):
2020 """MMD (Maximum Mean Discrepancy) [gretton2012kernel]_ detector.
2121
22- :param kernel: kernel function, defaults to rbf_kernel
22+ :param kernel: kernel function, defaults to :func:` rbf_kernel() <frouros.utils.kernels.rbf_kernel>`
2323 :type kernel: Callable
2424 :param chunk_size: chunk size value, defaults to None
2525 :type chunk_size: Optional[int]
@@ -45,7 +45,7 @@ class MMD(BaseDistanceBased):
4545 >>> _ = detector.fit(X=X)
4646 >>> detector.compare(X=Y)[0]
4747 DistanceResult(distance=0.02146955300299802)
48- """
48+ """ # noqa: E501 # pylint: disable=line-too-long
4949
5050 def __init__ ( # noqa: D107
5151 self ,
Original file line number Diff line number Diff line change @@ -20,7 +20,7 @@ class MMD(BaseDistanceBased):
2020
2121 :param window_size: window size value
2222 :type window_size: int
23- :param kernel: kernel function, defaults to rbf_kernel
23+ :param kernel: kernel function, defaults to :func:` rbf_kernel() <frouros.utils.kernels.rbf_kernel>`
2424 :type kernel: Callable
2525 :param chunk_size: chunk size value, defaults to None
2626 :type chunk_size: Optional[int]
@@ -49,7 +49,7 @@ class MMD(BaseDistanceBased):
4949 ... distance, _ = detector.update(value=sample)
5050 ... if distance is not None:
5151 ... print(distance)
52- """
52+ """ # noqa: E501 # pylint: disable=line-too-long
5353
5454 def __init__ ( # noqa: D107
5555 self ,
You can’t perform that action at this time.
0 commit comments