Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding runtimes and "pinning" versions #67

Merged
merged 5 commits into from
Nov 18, 2024
Merged

Adding runtimes and "pinning" versions #67

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a081126
adding runtimes and pinning versions
jeandut Nov 18, 2024
22afb17
Update README.md
jeandut Nov 18, 2024
23a5e31
Update README.md
jeandut Nov 18, 2024
1e0ba09
Update README.md
jeandut Nov 18, 2024
a0c7edc
Update README.md
jeandut Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,16 @@ To install the package, create an env with python `3.9` with conda
conda create -n fedeca python=3.9
conda activate fedeca
```

This should take under 20 seconds with a reasonably good connexion.
jeandut marked this conversation as resolved.
Show resolved Hide resolved
Within the environment, install the package by running:

```
git clone https://github.com/owkin/fedeca.git
cd fedeca
pip install -e ".[all_extra]"
```
The cloning should take less than 5 seconds and the pip install
jeandut marked this conversation as resolved.
Show resolved Hide resolved
should take around 1 min and 30 seconds.

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

Expand All @@ -40,10 +42,16 @@ 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 at 120Mbps as measured by fast.com.
jeandut marked this conversation as resolved.
Show resolved Hide resolved

## Quickstart

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

Copy-pasting all cells of the tutorial into a regular python script gives a runtime of approximately 1 minute,
with less than 2 seconds spent on each run of the FedECA algorithm in-RAM.
jeandut marked this conversation as resolved.
Show resolved Hide resolved

## <a name="citation"></a>Citing FedECA

```
Expand Down
24 changes: 13 additions & 11 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,22 +31,24 @@
install_requires=[
# We cannot use the git+https / git+ssh syntax here because of docker
# build issues related to git not being installed
# Commented pinned versions are only there as references but should
# not matter as long as the versions are compatible with the ones
# uncommented.
"substrafl==0.46.0",
"argparse",
"numpy==1.26.4",
"pandas",
"pre-commit",
"scipy",
"seaborn",
"opacus",
"lifelines",
"git-python",
"build",
"pandas",#==2.2.3
"pre-commit",#==4.0.1
"scipy",#==1.13.1
"seaborn",#==0.13.2
"opacus",#==1.4.0
"lifelines",#==0.29.0
"git-python",#==1.0.3
"build",#==1.2.2.post1
"torch==1.13.1",
"scikit-learn==1.2.1",
"pydantic", # Need to be updated to > 2.0 to use latest Substra
"pydantic", #==2.23.4
"indcomp==0.2.1",
"hydra-core",
"hydra-core",#==1.3.2
],
extras_require={
"all_extra": all_extra,
Expand Down
Loading