From 7e6a4fea0a28670c2e758c8afb1afa842e5e4b83 Mon Sep 17 00:00:00 2001 From: nvkevlu <55759229+nvkevlu@users.noreply.github.com> Date: Wed, 16 Mar 2022 18:37:14 -0400 Subject: [PATCH] Add information about the usage of name vs path in configurations for components in the documentation (#313) --- docs/user_guide/application.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/user_guide/application.rst b/docs/user_guide/application.rst index a1ca909e82..018fef4bdd 100644 --- a/docs/user_guide/application.rst +++ b/docs/user_guide/application.rst @@ -92,9 +92,11 @@ the client config should have the following in order to configure it as an Execu .. note:: - Configuration of Executor Tasks is ignored here. - -Please follow :ref:`quickstart:Quickstart` to learn more. + In some examples, "name" is used to identify the class of a component instead of "path". When a component is + specified by "name", the system will scan the ``nvflare`` package for the class name, so this notation may be + simpler than using the entire path to the class for the component if it is inside the ``nvflare`` package. If the + component you are using is not in the ``nvflare`` package, please use "path" and make sure that the path is + accessible with the configured PYTHONPATH. .. _troubleshooting_byoc: