From 268e85c280faa1e4a091f3044263a0a1bdf3ded0 Mon Sep 17 00:00:00 2001 From: jeandut Date: Tue, 19 Nov 2024 10:25:19 +0100 Subject: [PATCH] Update README.md --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 51717ce..1e7e8da 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ To install the package, create an env with python `3.9` with conda conda create -n fedeca python=3.9 conda activate fedeca ``` -Creating the conda environment should take under 20 seconds on a modern computer with a reasonably good internet connexion (see below for details). +Creating the conda environment should take under 20 seconds on a modern computer with a reasonably good internet connexion (see top of the section for details). Within the environment, install the package by running: ``` @@ -40,11 +40,10 @@ 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. +Please note, however, that the repo contains artefacts of experiments' results, +which allow for the reproduction of figures contained in the article without having to rerun +corresponding experiments. The size of the repo is therefore not negligeable (~88M), and +the actual time spent on cloning may vary depending on the internet bandwidth. If you plan on developing, you should also install the pre-commit hooks