Skip to content

Commit 6e84306

Browse files
authored
Merge pull request #359 from LabeliaLabs/release_pypi
Release Pypi 0.4
2 parents b3fe85a + 8893f84 commit 6e84306

File tree

3 files changed

+22
-20
lines changed

3 files changed

+22
-20
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
[![Build Status](https://github.com/SubstraFoundation/distributed-learning-contributivity/workflows/Build/badge.svg)](https://github.com/SubstraFoundation/distributed-learning-contributivity/actions?query=branch%3Amaster)
2-
[![Code Coverage](https://codecov.io/gh/SubstraFoundation/distributed-learning-contributivity/branch/master/graphs/badge.svg)](https://codecov.io/gh/SubstraFoundation/distributed-learning-contributivity)
3-
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/SubstraFoundation/distributed-learning-contributivity/blob/master/run_experiment_on_google_collab.ipynb)
4-
[![Discuss on Slack](https://img.shields.io/badge/chat-on%20slack-orange)](https://substra.us18.list-manage.com/track/click?e=2effed55c9&id=fa49875322&u=385fa3f9736ea94a1fcca969f)
1+
[![Build Status](https://github.com/LabeliaLabs/distributed-learning-contributivity/workflows/Build/badge.svg)](https://github.com/LabeliaLabs/distributed-learning-contributivity/actions?query=branch%3Amaster)
2+
[![Code Coverage](https://codecov.io/gh/LabeliaLabs/distributed-learning-contributivity/branch/master/graphs/badge.svg)](https://codecov.io/gh/LabeliaLabs/distributed-learning-contributivity)
3+
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/LabeliaLabs/distributed-learning-contributivity/blob/master/run_experiment_on_google_collab.ipynb)
4+
[![Discuss on Slack](https://img.shields.io/badge/chat-on%20slack-orange)](https://labelia.slack.com/messages/workgroup-mpl-contributivity)
55

66
# MPLC: Multi-Partner Learning and Contributivity
77

@@ -50,7 +50,7 @@ It depends in what capacity you are interested! For example:
5050

5151
- If you'd like to experiment right now by yourself multi-partner learning approaches and contributivity measurement methods, jump to section **[Run an experiment](#run-an-experiment)**.
5252
- If you'd like to get in touch with active members of the workgroup, jump to section **[Contacts, contributions, collaborations](#contacts-contributions-collaborations)**. If you are a student or a teacher, we are used to discuss student projects related to the `mplc` library.
53-
- If you are already familiar with this type of projects, you can either have a look at section **[Ongoing work and improvement plan](#ongoing-work-and-improvement-plan)** or head towards [issues](https://github.com/SubstraFoundation/distributed-learning-contributivity/issues) and [PRs](https://github.com/SubstraFoundation/distributed-learning-contributivity/pulls) to see what's going on these days. We use the `help wanted` tag to flag issues on which help is particularly wanted, but other open issues would also very much welcome contributions. There is also a [`CONTRIBUTING.md`](./CONTRIBUTING.md) with indications and best practices we recommend.
53+
- If you are already familiar with this type of projects, you can either have a look at section **[Ongoing work and improvement plan](#ongoing-work-and-improvement-plan)** or head towards [issues](https://github.com/LabeliaLabs/distributed-learning-contributivity/issues) and [PRs](https://github.com/LabeliaLabs/distributed-learning-contributivity/pulls) to see what's going on these days. We use the `help wanted` tag to flag issues on which help is particularly wanted, but other open issues would also very much welcome contributions. There is also a [`CONTRIBUTING.md`](./CONTRIBUTING.md) with indications and best practices we recommend.
5454

5555
Should you have any question, don't hesitate [reach out](#contacts-contributions-collaborations), we'll be happy to discuss how we could help.
5656

@@ -72,7 +72,7 @@ This library can be schematically broken down into 3 blocks:
7272

7373
#### Scenarios
7474

75-
A key capability is to easily define and simulate different multi-partner settings to be able to experiment on them. For that, the library enables to configure scenarios by specifying the number of partners, how the dataset is partitioned among them, etc. See the [first tutorial](https://github.com/SubstraFoundation/distributed-learning-contributivity/blob/master/notebooks/tutorials/Tutorial-1_Run_your_first_scenario.ipynb), and the related documentation's section [Definition of collaborative scenarios](mplc/doc/documentation.md#definition-of-collaborative-scenarios) for all available parameters.
75+
A key capability is to easily define and simulate different multi-partner settings to be able to experiment on them. For that, the library enables to configure scenarios by specifying the number of partners, how the dataset is partitioned among them, etc. See the [first tutorial](https://github.com/LabeliaLabs/distributed-learning-contributivity/blob/master/notebooks/tutorials/Tutorial-1_Run_your_first_scenario.ipynb), and the related documentation's section [Definition of collaborative scenarios](mplc/doc/documentation.md#definition-of-collaborative-scenarios) for all available parameters.
7676

7777
#### Multi-partner learning approaches
7878

@@ -99,7 +99,7 @@ If you want to install mplc from the repository, make sure that you got the late
9999
Then clone the repository, and trigger the installation from local sources.
100100

101101
```sh
102-
git clone https://github.com/SubstraFoundation/distributed-learning-contributivity.git
102+
git clone https://github.com/LabeliaLabs/distributed-learning-contributivity.git
103103
cd distributed-learning-contributivity
104104
pip install -e .
105105
```
@@ -217,12 +217,12 @@ Results of experiments and benchmarks of multi-partner learning approaches and c
217217

218218
The current work focuses on the following 4 priorities:
219219

220-
1. Design and implement new **[multi-partner learning approaches](https://github.com/SubstraFoundation/distributed-learning-contributivity/projects/4)**
221-
1. Design and implement new **[contributivity measurement methods](https://github.com/SubstraFoundation/distributed-learning-contributivity/projects/3)**
222-
1. Perform **[experiments](https://github.com/SubstraFoundation/distributed-learning-contributivity/projects/1)** and gain experience about best-suited multi-partner learning approaches and contributivity measurement methods in different situations
223-
1. Make the library **[agnostic/compatible with other datasets and model architectures](https://github.com/SubstraFoundation/distributed-learning-contributivity/projects/2)**
220+
1. Design and implement new **[multi-partner learning approaches](https://github.com/LabeliaLabs/distributed-learning-contributivity/projects/4)**
221+
1. Design and implement new **[contributivity measurement methods](https://github.com/LabeliaLabs/distributed-learning-contributivity/projects/3)**
222+
1. Perform **[experiments](https://github.com/LabeliaLabs/distributed-learning-contributivity/projects/1)** and gain experience about best-suited multi-partner learning approaches and contributivity measurement methods in different situations
223+
1. Make the library **[agnostic/compatible with other datasets and model architectures](https://github.com/LabeliaLabs/distributed-learning-contributivity/projects/2)**
224224

225-
There is also a transverse, continuous improvement effort on **[code quality, readability, optimization](https://github.com/SubstraFoundation/distributed-learning-contributivity/projects/5)**.
225+
There is also a transverse, continuous improvement effort on **[code quality, readability, optimization](https://github.com/LabeliaLabs/distributed-learning-contributivity/projects/5)**.
226226

227227
This work is collaborative, enthusiasts are welcome to comment open issues and PRs or open new ones.
228228

@@ -231,7 +231,7 @@ This work is collaborative, enthusiasts are welcome to comment open issues and P
231231
Should you be interested in this open effort and would like to share any question, suggestion or input, you can use the following channels:
232232

233233
- This Github repository (issues or PRs)
234-
- Substra Foundation's [Slack workspace](https://substra-workspace.slack.com/join/shared_invite/zt-cpyedcab-FHYgpy08efKJ2FCadE2yCA), channel `#workgroup-mpl-contributivity`
235-
- Email: <hello@substra.org>
234+
- Labelia Labs' (ex- Substra Foundation) [Slack workspace](https://join.slack.com/t/labelia/shared_invite/zt-cpyedcab-FHYgpy08efKJ2FCadE2yCA), channel `#workgroup-mpl-contributivity`
235+
- Email: <contact@labelia.org>
236236

237-
![logo Substra Foundation](./img/substra_logo_couleur_rvb_w150px.png)
237+
![logo Labelia Labs](./img/labelia_substra_logo_rvb_w350px.png)
16.7 KB
Loading

setup.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,22 @@
2626

2727
setup(
2828
name="mplc",
29-
version='0.3.1',
30-
author="SubstraFoundation",
31-
author_email="[email protected]",
32-
description="A distributed-learning package for the study of contributivity",
29+
version='0.4.0',
30+
author="LabeliaLabs",
31+
author_email="[email protected]",
32+
description="A distributed-learning package for the study of multi-partner learning approaches "
33+
"and contributivity measurement methods",
3334
long_description=long_description,
3435
long_description_content_type="text/markdown",
35-
url="https://github.com/SubstraFoundation/distributed-learning-contributivity",
36+
url="https://github.com/LabeliaLabs/distributed-learning-contributivity.git",
3637
packages=find_packages(),
3738
classifiers=[
3839
"Programming Language :: Python :: 3",
3940
"Operating System :: OS Independent",
4041
],
4142
keywords=['library',
4243
'substra',
44+
'labelia',
4345
'machine learning',
4446
'contributivity',
4547
'multi-partner learning',

0 commit comments

Comments
 (0)