Skip to content

Commit

Permalink
docs: update installation paragraph in landing page (#276)
Browse files Browse the repository at this point in the history
  • Loading branch information
RomainGoussault authored Feb 14, 2023
1 parent 6f69caa commit dacbdc6
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
16 changes: 9 additions & 7 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.melloddy.eu/>`_ 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 <https://www.melloddy.eu/>`_ 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 <https://owkin.com/>`_ and is now hosted by the `Linux Foundation for AI and Data <https://lfaidata.foundation/>`_.

Expand All @@ -42,23 +42,25 @@ 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 <substrafl_doc/substrafl_overview:Installation>`.

.. 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 <contributing/local-deployment:Local deployment>`: to deploy locally on a single one machine. Useful for quick tests and for development.
* :ref:`Production deployment <operations/Overview:Overview>`: 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
^^^^^

Some quick links:

* :ref:`MNIST federated learning example <substrafl_doc/examples/get_started/run_mnist_torch:Using Torch FedAvg on MNIST dataset>`
* :ref:`Substrafl overview <substrafl_doc/substrafl_overview:Overview>`
* :ref:`SubstraFL overview <substrafl_doc/substrafl_overview:Overview>`
* :ref:`Compatibility table <additional/release:Compatibility table>`
* :ref:`How to deploy Substra for Site Reliability Engineers <operations/howto:How-To>`
* :ref:`How to deploy Substra for Site Reliability Engineers <operations/Overview:Overview>`
* :ref:`Community <additional/community:Community>`
* `Subscribe to our newsletter <https://lists.lfaidata.foundation/g/substra-announce/join>`_

Expand Down

0 comments on commit dacbdc6

Please sign in to comment.