Skip to content

Commit

Permalink
adding to the documentation to clarify and help users with specific c…
Browse files Browse the repository at this point in the history
…ases encountered (NVIDIA#175)
  • Loading branch information
nvkevlu authored Feb 3, 2022
1 parent 88974a7 commit b3ff784
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,11 @@ Server related questions
When restarting the FL server, you can find the previous training round number from the previous log. Then you can choose to
train from scratch or continuously using previous training model.

#. Why does my FL server keep crashing after a certain round?

Check that the amount of memory being consumed is not increasing in a way that it exceeds the available resources.
If the process consumes too much memory, the operating system may kill it.

#. Does the federated learning server need a GPU?

No, there is no need to have GPU on the server side for the FL server to deploy. However, certain handlers may require
Expand Down
18 changes: 18 additions & 0 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,22 @@ In one last terminal, start the admin:
This will launch a command prompt where you can input admin commands to control and monitor many aspects of
the FL process. Log in by entering ``admin`` for both the username and password.

Custom Code in Example Apps
===========================

There are several ways to make :ref:`custom code <custom_code>` available to clients when using NVIDIA FLARE. Most
hello-* examples use a custom folder within the FL application. Note that using a custom folder in the app needs to be
:ref:`allowed <troubleshooting_byoc>` when using secure provisioning. By default, this option is disabled in the secure
mode. POC mode, however, will work with custom code by default.

In contrast, the `CIFAR-10 <https://github.com/NVIDIA/NVFlare/tree/main/examples/cifar10>`_,
`prostate segmentation <https://github.com/NVIDIA/NVFlare/tree/main/examples/prostate>`_,
and `BraTS18 segmentation <https://github.com/NVIDIA/NVFlare/tree/main/examples/brats18>`_ examples assume that the
learner code is already installed on the client's system and
available in the PYTHONPATH. Hence, the app folders do not include the custom code there. The PYTHONPATH is
set in the ``run_poc.sh`` or ``run_secure.sh`` scripts of the example. Running these scripts as described in the README
will make the learner code available to the clients.

.. _example_apps:

Example Apps for NVIDIA FLARE
Expand All @@ -88,3 +104,5 @@ The following quickstart guides walk you through some of these examples:
examples/hello_tf2
examples/hello_cross_val
Federated Learning with CIFAR-10 <https://github.com/NVIDIA/NVFlare/tree/main/examples/cifar10>

For the complete collection of example applications, see https://github.com/NVIDIA/NVFlare/tree/main/examples.
5 changes: 5 additions & 0 deletions docs/user_guide/application.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ Example:
task_result_filters, "What filters to apply to data leaving client, :ref:`filters`"
components, All of the Components to use


.. _custom_code:

***********
Custom code
***********
Expand Down Expand Up @@ -93,6 +96,8 @@ the client config should have the following in order to configure it as an Execu

Please follow :ref:`quickstart:Quickstart` to learn more.

.. _troubleshooting_byoc:

Troubleshooting BYOC
====================
There is an ``enable_byoc`` flag for each participant that can be set at provisioning, and if that is disabled, even if
Expand Down

0 comments on commit b3ff784

Please sign in to comment.