Skip to content

Commit

Permalink
[README.md] - docs: update installation instructions with alternatives
Browse files Browse the repository at this point in the history
 - Include collapsible sections for using `uv` and `requirements.txt` for dependency installation
 - Provide an option to install dependencies via `uv` as well as directly using `requirements.txt`
  • Loading branch information
Jules committed Oct 27, 2024
1 parent c8e64c1 commit 1fedd0f
Showing 1 changed file with 26 additions and 4 deletions.
30 changes: 26 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
<details>

<summary>Use [uv](https://docs.astral.sh/uv/)</summary>

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
```

</details>

<details>
<summary>Install directly from `requirements.txt`</summary>

```shell
pip install -r requirements.txt
```

</details>

## Usage

The project uses [Hydra](https://hydra.cc/docs/intro/) as a configuration parser. You can simply change the parameters
Expand Down

0 comments on commit 1fedd0f

Please sign in to comment.