diff --git a/README.md b/README.md index 844a11e..7783a16 100644 --- a/README.md +++ b/README.md @@ -20,14 +20,36 @@ To clone the repository please run: git clone https://github.com/JulesBelveze/time-series-autoencoder.git ``` -To install all the required dependencies please run: +
+Use [uv](https://docs.astral.sh/uv/) + +Then install `uv` +```shell +# install uv +curl -LsSf https://astral.sh/uv/install.sh | sh # linux/mac +# or +brew install uv # mac with homebrew ``` -python3 -m venv .venv/tsa -source .venv/tsa/bin/activate -poetry install + +# setup environment and install dependencies +```bash +cd time-series-autoencoder +uv venv +uv pip sync pyproject.toml ``` +
+ +
+Install directly from `requirements.txt` + +```shell +pip install -r requirements.txt +``` + +
+ ## Usage The project uses [Hydra](https://hydra.cc/docs/intro/) as a configuration parser. You can simply change the parameters