Skip to content

Commit e05939f

Browse files
author
Jaime Céspedes Sisniega
authored
Merge pull request #207 from IFCA/fix-documentation
Fix documentation
2 parents e8be7c1 + 0775351 commit e05939f

File tree

3 files changed

+3
-213
lines changed

3 files changed

+3
-213
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Frouros is an open-source project. Anyone with an interest in the project can jo
77
Recommended steps for first time contributors:
88

99
1. Fork repository on GitHub.
10-
2. Set up develop environment (it is not mandatory, but we highly recommend the use of a [virtual environment](https://docs.python.org/3.9/library/venv.html)):
10+
2. Set up develop environment (it is not mandatory, but we highly recommend the use of a [virtual environment](https://docs.python.org/3.11/library/venv.html)):
1111
```bash
1212
python3 -m venv .venv
1313
source .venv/bin/activate

docs/source/api_reference/detectors_old.md

Lines changed: 0 additions & 210 deletions
This file was deleted.

docs/source/concepts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,13 @@ Drift detection methods can be classified according to the type of drift they ca
4949

5050
Their main objective is to **detect concept drift**. They are closely related to data stream mining, online and incremental learning.
5151

52-
At the time of writing this, Frouros only implements *concept drift* detectors that work in a streaming manner. This means that the detector can only be updated with a single sample each time.
52+
At the time of writing this, Frouros only implements *concept drift* detectors that work in a {doc}`streaming </api_reference/detectors/concept_drift/streaming>` manner. This means that the detector can only be updated with a single sample each time.
5353

5454
### Data drift
5555

5656
On the other hand, there are problems where it is very costly or even impossible to obtain labels in a reasonable amount of time (see [verification latency](#verification-latency-or-delay)). In this case, is not possible to directly check if *concept drift* is occurring, so **detect data drift** becomes the main objective of these type of methods.
5757

58-
Al the time of writing this, Frouros implements detectors that are capable to work in {ref}`batch <batch>` or {ref}`streaming <streaming>` mode. In addition, we can difference between univariate and multivariate data drift detectors, according to the type of feature/covariate distributions used.
58+
At the time of writing this, Frouros implements detectors that are capable to work in {doc}`batch </api_reference/detectors/data_drift/batch>` or {doc}`streaming </api_reference/detectors/data_drift/streaming>` mode. In addition, we can difference between univariate and multivariate data drift detectors, according to the type of feature/covariate distributions used.
5959
```{bibliography}
6060
:filter: docname in docnames
6161
```

0 commit comments

Comments
 (0)