From dacbdc67c4558dcca8a9fa8a924f8129979e0b8d Mon Sep 17 00:00:00 2001 From: Goussault Romain Date: Tue, 14 Feb 2023 18:01:10 +0100 Subject: [PATCH] docs: update installation paragraph in landing page (#276) --- CHANGELOG.md | 1 + docs/source/index.rst | 16 +++++++++------- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 03b300cc..fa55fc7b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +- Improve installation paragraph in landing page (#276) - Rename substra SDK Algo to Function (#264) - Add contributing guide & code of conduct md files (#253) - Remove test only for datasamples in examples (#246) diff --git a/docs/source/index.rst b/docs/source/index.rst index e1fb6ddd..959b9d43 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -16,7 +16,7 @@ Substra documentation Substra is an open source federated learning (FL) software. It provides a flexible Python interface and a web app to run federated learning training at scale. -Substra's main usage is in production environments. It has already been deployed and used by hospitals and biotech companies (see the `MELLODDY `_ project for instance). Substra can also be used on a single machine on a virtually splitted dataset to perform FL simulations and debug code before launching experiments on a real network. +Substra's main usage is in production environments. It has already been deployed and used by hospitals and biotech companies (see the `MELLODDY `_ project for instance). Substra can also be used on a single machine on a virtually split dataset to perform FL simulations and debug code before launching experiments on a real network. Substra was created by `Owkin `_ and is now hosted by the `Linux Foundation for AI and Data `_. @@ -42,13 +42,15 @@ Substra has three user interfaces: Installation ^^^^^^^^^^^^ -Install substra and substrafl with the following command: +**Client side**: Install Substra and SubstraFL python libraries with the following command: ``pip install substrafl``. Substra python library is a dependency of SubstraFL, so it will be automatically installed. More information on the installation :ref:`can be found here `. -.. code-block:: console +**Server side**: There are two options to deploy the server side of Substra (backend, frontend and orchestrator): - $ pip install substrafl +* :ref:`Local deployment `: to deploy locally on a single one machine. Useful for quick tests and for development. +* :ref:`Production deployment `: for real deployments. -Substra is a dependency of SubstraFL, so it will be automatically installed. +.. note:: + You can start doing local FL experiments with Substra by installing only the **client side**. Links ^^^^^ @@ -56,9 +58,9 @@ Links Some quick links: * :ref:`MNIST federated learning example ` -* :ref:`Substrafl overview ` +* :ref:`SubstraFL overview ` * :ref:`Compatibility table ` -* :ref:`How to deploy Substra for Site Reliability Engineers ` +* :ref:`How to deploy Substra for Site Reliability Engineers ` * :ref:`Community ` * `Subscribe to our newsletter `_