Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use multi-line table #3034

Merged
merged 1 commit into from
Oct 11, 2024
Merged

Use multi-line table #3034

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions docs/quickstart.rst
View file
Open in desktop
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
Loading