Skip to content

Commit 25f2145

Browse files
author
Amine Aherbil
committed
fix import sorting and update documentation examples
1 parent 038ac00 commit 25f2145

3 files changed

Lines changed: 4 additions & 14 deletions

File tree

docs/approach.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -67,21 +67,11 @@ predictor X.jsonl -e no -f 100 -w frequency_hits --online_adaptation adwin
6767
predictor X.jsonl -e no -f 100 -w frequency_hits --online_adaptation cusum
6868
predictor X.jsonl -e no -f 100 -w frequency_hits --online_adaptation ph
6969

70-
# With GUI dashboard visualization
70+
# With GUI dashboard visualization (works with any algorithm)
7171
ftio-gui # Start dashboard first in separate terminal
72-
predictor X.jsonl -e no -f 100 -w frequency_hits --gui
72+
predictor X.jsonl -e no -f 100 -w frequency_hits --online_adaptation adwin --gui
7373
```
7474

75-
### Key Flags
76-
77-
| Flag | Description |
78-
|------|-------------|
79-
| `-w frequency_hits` | Enable window adaptation based on frequency detection hits |
80-
| `--online_adaptation` | Change point detection algorithm: `adwin`, `cusum`, or `ph` |
81-
| `--gui` | Forward prediction data to the FTIO GUI dashboard |
82-
| `-e no` | Disable plot generation |
83-
| `-f` | Sampling frequency in Hz |
84-
8575
For more details on change point detection algorithms, see [Change Point Detection](change_point_detection.md).
8676

8777
<p align="right"><a href="#approach">⬆</a></p>

docs/change_point_detection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ pip install -e .[gui]
103103
ftio-gui
104104

105105
# 2. Then run predictor with --gui flag to forward data to the dashboard
106-
predictor X.jsonl -e no -f 100 -w frequency_hits --gui
106+
predictor X.jsonl -e no -f 100 -w frequency_hits --online_adaptation adwin --gui
107107
```
108108

109109
The dashboard runs on `http://localhost:8050` and displays:

ftio/cli/predictor.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
import sys
66

77
from ftio.parse.helper import print_info
8+
from ftio.prediction.online_analysis import init_socket_logger
89
from ftio.prediction.pools import predictor_with_pools
910
from ftio.prediction.processes import predictor_with_processes
1011
from ftio.prediction.processes_zmq import predictor_with_processes_zmq
1112
from ftio.prediction.shared_resources import SharedResources
12-
from ftio.prediction.online_analysis import init_socket_logger
1313

1414

1515
def main(args: list[str] = sys.argv) -> None:

0 commit comments

Comments
 (0)