From 51fa6648c11bc4ce5b071a1661f96780888b4ca8 Mon Sep 17 00:00:00 2001 From: Honghao Date: Tue, 19 Nov 2024 10:06:05 +0100 Subject: [PATCH] readme: mention repo size in the instruction. (#68) --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d422848..319c4b4 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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).