Skip to content

Commit

Permalink
readme: mention repo size in the instruction.
Browse files Browse the repository at this point in the history
  • Loading branch information
honghaoli42 committed Nov 18, 2024
1 parent 22c2936 commit 4f61bed
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ Before using the code be sure to check our [license](./license.md) first.

## Installation instructions

In the following, all estimated runtimes of installation and computations use as
reference machine a Mac M3 Pro with 18G of RAM
and an internet connexion with a speed of 120Mbps (as measured by fast.com).

To install the package, create an env with python `3.9` with conda

```bash
Expand All @@ -33,6 +37,11 @@ pip install -e ".[all_extra]"
```
The cloning itself should take less than 5 seconds and the pip install
should take around 1 min and 30 seconds.
Please note, however, that the repo contains artefacts of results of all
experiments, which allow for the reproduction of figures contained in the
article without having to rerun all the experiments. The size of the repo is
therefore considerable (~88M), and the actual time spent on cloning may
therefore vary depending on the internet bandwidth.

If you plan on developing, you should also install the pre-commit hooks

Expand All @@ -42,9 +51,6 @@ pre-commit install

This will run all the pre-commit hooks at each commit, ensuring a clean repo.

All estimated runtimes computations use as reference machine a Mac M3 Pro with 18G of RAM
and an internet connexion with a speed of 120Mbps (as measured by fast.com).

## Quickstart

Go [here](./quickstart/quickstart.md).
Expand Down

0 comments on commit 4f61bed

Please sign in to comment.