Anonymizing distillation

It would be great to have a testing checklist added to the usage & contributing sections!

Introduction

Currently it is a bit hard for the user to know on which files the hashes of tuples or objectives and datasets is computed w/o going into the code.

This can cause bad surprises when submitting twice slightly different objectives/datasets/tules.

test

Facilitate transfer learning (arms, legs, heads, truncks, ...)

Introduction

Docstrings of classes are often not present in the substra SDK and docstrings of functions or methods do not list the inputs and outputs with their types.

An example of this can be found in the substra repo for the client substra/substra/sdk/client.py.

Describe the bug

Quotes/Notes written in .md sources with > ... are not rendered properly on the documentation website.

How To Reproduce

1. Go to this page and check out the first line after the article title

Expected behavior

Depending on the rendering template, his should render something like a vertical bar, maybe a different text color.

Not included in the skaffold documentation

As the permissions are not mutable when an asset is pushed to the network, it might be interesting to provide some tips about removing it (pods, etc.)

• WSL: https://docs.microsoft.com/en-us/windows/wsl/install-win10
• Vscode: https://code.visualstudio.com/docs/remote/wsl
• Install substra cli
• Docker: https://docs.docker.com/docker-for-windows/wsl/
  Thx @Fabien-GELUS for the insight!

Give the possibility to pre-process data through Substra

Regime that covers serial and parallel learning - empowering the data controller - technique and concept - data governance platform

There is a link to the Discourse forum in CONTRIBUTING.html#i-don-t-want-to-read-this-whole-thing-i-just-have-a-question

I'm on a Ubuntu VM.
I installed the Substra CLI v0.5 with
sudo pip3 install substra

I got an error when running this command :
sudo substra config http://substra-backend.node-1.com
The error :

Usage: substra config [OPTIONS] URL
Try 'substra config --help' for help.

Error: Missing option '--username' / '-u'.

However this command worked for me :
sudo substra config -u "node-1" -p 'p@$swr0d44' http://substra-backend.node-1.com
and then
sudo substra login
Could you change it in the doc ?
Thanks

test integration zap 2

See: https://github.com/SubstraFoundation/hlf-k8s/pull/82/files
To be coordinated with @AlexandrePicosson

Thank you @Fabien-GELUS !

If you get this error :

$ sudo minikube start --vm-driver=none --kubernetes-version='v1.15.4'
😄  minikube v1.9.2 on Ubuntu 20.04 (vbox/amd64)
✨  Using the none driver based on existing profile
👍  Kubernetes 1.18.0 is now available. If you would like to upgrade, specify: --kubernetes-version=1.18.0
👍  Starting control plane node  in cluster minikube
🤦  StartHost failed, but will try again: boot lock: unable to open /tmp/juju-mka00e65579c2b557a802898fd1cf03ec4ab30a1: permission denied

❌  [JUJU_LOCK_DENIED] Failed to start none bare metal machine. "minikube start" may fix it. boot lock: unable to open /tmp/juju-mka00e65579c2b557a802898fd1cf03ec4ab30a1: permission denied
💡  Suggestion: Run 'sudo sysctl fs.protected_regular=1', or try a driver which does not require root, such as '--driver=docker'
⁉️   Related issue: https://github.com/kubernetes/minikube/issues/6391

You will need to do : sudo sysctl fs.protected_regular=0

• docs/readme.md
• docs/ml_tasks.md
• examples

See: Substra/substra#177

Our current glossary is a markdown page that manually creates titles and table of contents.

We should convert it to RST and use the glossary directive instead: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#glossary

On top of better formatting, this makes all glossary terms global references in our documentation which makes linking to them very easy.

As recently updated, the config and login cli commands should look like this:

substra config --profile node-1 http://substra-backend.node-1.com    

substra login --profile node-1 --username node-1 --password 'p@$swr0d44'

Integrate contributivity works and methods into the framework.

Allow a user to have a preview of data on several samples.

• Add badges to the substra-documentation readme
• Add License badge
• Update slack url to point towards an invitation link

This method will soon be depreciated and will have to be removed from the documentation.

During the setup, i had this error when running the command sudo skaffold dev in hlf-k8s :

creating runner: creating builder: getting docker client: getting minikube env: running [minikube docker-env --shell none]
 - stdout: 
 - stderr: "* 'none' driver does not support 'minikube docker-env' command\n": exit status 64

The solution was to install skaffold 1.8 (not latest) :

curl -Lo skaffold https://storage.googleapis.com/skaffold/releases/v1.8.0/skaffold-linux-amd64

chmod +x skaffold

sudo mv skaffold /usr/local/bin

test intégration

Describe the bug

':+1::tada:' is not rendered on the Contributing page of the doc

How To Reproduce

1. Open the Contributing page of the doc in your browser
2. Check out the first line after the article title

Expected behavior

Shouldn't it render an emoji or something like that?

Facilitate "distillation" techniques (compression, anonymization): starting from an existing template then create a copy that has better properties (example: question of size, better generalization, ...)

• Introduce structure and some relevant items
• add ref to hlf charts readme
• Add add orga to system channel

When you have registered an asset (dataset or objective for instance) that has bug a in it, it would to be nice to be able to remove it from the front. I know we can not delete it but move it to "trash" somehow would be good.

I fear that after experimentation with Substra, my front page will be filled with datasets and objectives that do not work properly !

I know there is a filter option but it will be nice to automatically filter the 'trash' assets.

Breadcrumbs!

The link between this repo (/docs) and the github page repository needs to be done as soon as there is a new HEAD on master of this repository.
Problem: the github.io repo is not available to Travis.

Need update with substra 0.5

Setup feature connect to partner.

Setup differential privacy techniques inside framework

Set up a testnet of Substra

Integrate PET (Privacy Enhancing Technologies) in Substra

It would be nice to customize the style beyond the readthedoc theme!

Set up an identity card of a model

Setup secure aggregation

Setup Substra framework in the cloud with easy deployment.

cf. https://doc.substra.ai/getting_started/installation/local_install_skaffold.html#software-requirements

Package Substra deployment to ease install

https://doc.substra.ai/getting_started/usage/usage.html#

"Check this out" link is broken here: https://doc.substra.ai/getting_started/installation/local_install_skaffold.html#substra-cli-config-login-mac-ubuntu

It should be: https://doc.substra.ai/getting_started/installation/further_resources.html#python-virtual-environment

And not: https://doc.substra.ai/getting_started/installation/further_resources.md#python-virtual-environment

https://github.com/SubstraFoundation/substra/pull/176/files

Setup the possibility to give access to the data from a different node