Skip to content

Commit

Permalink
multi line table (#3034)
Browse files Browse the repository at this point in the history
  • Loading branch information
SYangster authored Oct 11, 2024
1 parent 552bb36 commit a5a6353
Showing 1 changed file with 22 additions and 7 deletions.
29 changes: 22 additions & 7 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -210,13 +210,28 @@ Using non-HA, secure, local mode (all clients and server running on the same hos

Which mode should I choose for running NVFLARE? (Note: the same jobs can be run in any of the modes, and the same project.yml deployment options can be run in both POC mode and production.)

.. csv-table::
:header: Mode,Link,Description
:widths: 15, 15, 30

Simulator,:ref:`fl_simulator`,The FL Simulator is a light weight simulation where the job run is automated on a single system. Useful for quickly running a job or experimenting with research or FL algorithms.
POC,:ref:`poc_command`,POC mode establishes and connects distinct server and client "systems" which can then be orchestrated using the FLARE Console all from a single machine. Users can also experiment with various deployment options (project.yml) which can directly be used in production modes.
Production,:ref:`provisioned_setup`,"Real world production mode involves a distributed deployment with generated startup kits from the provisioning process. Provides provisioning tool, dashboard, and various deployment options."
.. list-table:: NVIDIA FLARE Modes
:header-rows: 1

* - **Mode**
- **Documentation**
- **Description**
* - Simulator
- :ref:`fl_simulator`
- | The FL Simulator is a light weight simulation where the job run is automated on a
| single system. Useful for quickly running a job or experimenting with research
| or FL algorithms.
* - POC
- :ref:`poc_command`
- | POC mode establishes and connects distinct server and client "systems" which can
| then be orchestrated using the FLARE Console all from a single machine. Users can
| also experiment with various deployment options (project.yml), which can be used
| in production modes.
* - Production
- :ref:`provisioned_setup`
- | Real world production mode involves a distributed deployment with generated startup
| kits from the provisioning process. Provides provisioning tool, dashboard, and
| various deployment options.
.. _starting_fl_simulator:

Expand Down

0 comments on commit a5a6353

Please sign in to comment.