Skip to content

Commit 26ca813

Browse files
author
Kyle van de Langemheen
committed
chore: rephrase readme
1 parent b7464fd commit 26ca813

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The `data/` directory contains two files:
2323
| `sales_df.csv` | Transaction-level sales records with customer IDs, dates, and customer category/type attributes |
2424
| `feiertage.csv` | Swiss public holiday calendar used as an external covariate |
2525

26-
> **Note:** Both files contain **anonymized synthetic data**. The data is generated to reflect the statistical properties and patterns of real sales transactions, including realistic customer ordering cadences, seasonal effects, and B2B/B2C customer mix. It does not contain any personal or commercially sensitive information.
26+
> **Note:** `sales_df` contains **synthetic data**. The data is generated to reflect the statistical properties and patterns of real sales transactions, including realistic customer ordering cadences, seasonal effects, and B2B/B2C customer mix. It does not contain any personal or commercially sensitive information.
2727
2828
---
2929

@@ -88,7 +88,14 @@ Helper code is organized under `src/sme_kt_zh_collaboration_forecasting/`:
8888

8989
## Installation
9090

91-
Install pinned development dependencies using:
91+
**Important:** The project uses [`uv`](https://github.com/astral-sh/uv) for dependency management. A `uv.lock` file is included for fully reproducible installs. To use it:
92+
>
93+
> ```bash
94+
> uv sync
95+
> ```
96+
97+
98+
Alternative installation methods follow:
9299
93100
```bash
94101
pip install -r requirements.txt
@@ -106,12 +113,6 @@ Alternatively, if you are using an existing environment, you can install the mod
106113
pip install -e .
107114
```
108115

109-
> **Important:** The project uses [`uv`](https://github.com/astral-sh/uv) for dependency management. A `uv.lock` file is included for fully reproducible installs. To use it:
110-
>
111-
> ```bash
112-
> uv sync
113-
> ```
114-
115116
---
116117

117118
## Development Tools

0 commit comments

Comments
 (0)