Skip to content

Remove todos and unnecessary documentation for now #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maldwg merged 1 commit into from
May 12, 2025
Merged

Remove todos and unnecessary documentation for now #82

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 7 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ docker compose -f docker/docker-compose.yml up
### Configuration

The following table lists the most important configuration parameters with their default values.
The configuration options can be set in the ![config.yaml](./config.yaml) in the root directory.
The configuration options can be set in the [config.yaml](./config.yaml) in the root directory.

| Path | Description | Default Value |
| :----------------------------------------- | :-------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------- |
Expand All @@ -90,16 +90,16 @@ The configuration options can be set in the ![config.yaml](./config.yaml) in the
| `pipeline.data_inspection.inspector.mode` | Mode of operation for the data inspector. | `univariate` (options: `multivariate`, `ensemble`) |
| `pipeline.data_inspection.inspector.ensemble.model` | Model to use when inspector mode is `ensemble`. | `WeightEnsemble` |
| `pipeline.data_inspection.inspector.ensemble.module` | Python module for the ensemble model. | `streamad.process` |
| `pipeline.data_inspection.inspector.ensemble.model_args` | Arguments for the ensemble model. | (empty by default) TODO: describe in more detail |
| `pipeline.data_inspection.inspector.models` | List of models to use for data inspection (e.g., anomaly detection). | Array of model definitions (e.g., `{"model": "ZScoreDetector", "module": "streamad.model", "model_args": {"is_global": false}}`) TODO: more details!|
| `pipeline.data_inspection.inspector.anomaly_threshold` | Threshold for classifying an observation as an anomaly. | `0.01` TODO: elaborate |
| `pipeline.data_inspection.inspector.score_threshold` | Threshold for the anomaly score. | `0.5` <TODO: elaborate> |
| `pipeline.data_inspection.inspector.ensemble.model_args` | Arguments for the ensemble model. | (empty by default) |
| `pipeline.data_inspection.inspector.models` | List of models to use for data inspection (e.g., anomaly detection). | Array of model definitions (e.g., `{"model": "ZScoreDetector", "module": "streamad.model", "model_args": {"is_global": false}}`)|
| `pipeline.data_inspection.inspector.anomaly_threshold` | Threshold for classifying an observation as an anomaly. | `0.01` |
| `pipeline.data_inspection.inspector.score_threshold` | Threshold for the anomaly score. | `0.5` |
| `pipeline.data_inspection.inspector.time_type` | Unit of time used in time range calculations. | `ms` |
| `pipeline.data_inspection.inspector.time_range` | Time range for inspection. | `20` |
| `pipeline.data_analysis.detector.model` | Model to use for data analysis (e.g., DGA detection). | `rf` (Random Forest) option: `XGBoost` |
| `pipeline.data_analysis.detector.checksum` | Checksum for the model file to ensure integrity. | `ba1f718179191348fe2abd51644d76191d42a5d967c6844feb3371b6f798bf06` TODO: elaborate |
| `pipeline.data_analysis.detector.checksum` | Checksum for the model file to ensure integrity. | `ba1f718179191348fe2abd51644d76191d42a5d967c6844feb3371b6f798bf06` |
| `pipeline.data_analysis.detector.base_url` | Base URL for downloading the model if not present locally. | `https://heibox.uni-heidelberg.de/d/0d5cbcbe16cd46a58021/` |
| `pipeline.data_analysis.detector.threshold` | Threshold for the detector's classification. | `0.5` TODO elaborate |
| `pipeline.data_analysis.detector.threshold` | Threshold for the detector's classification. | `0.5` |
| `pipeline.monitoring.clickhouse_connector.batch_size` | Batch size for sending data to ClickHouse. | `50` |
| `pipeline.monitoring.clickhouse_connector.batch_timeout` | Batch timeout (in seconds) for sending data to ClickHouse. | `2.0` |
| **environment** | Configuration for external services and infrastructure. | |
Expand Down Expand Up @@ -158,12 +158,6 @@ Currently, we are only interested in binary classification, thus, the `class` is
<p align="right">(<a href="#readme-top">back to top</a>)</p>


To retrain the existing models you can simply run:
```
echo "adapt me!"
```


### Data

> [!IMPORTANT]
Expand Down
Loading