From c078d3a02ead14d5db69b74a0452001affe5dfb5 Mon Sep 17 00:00:00 2001 From: Robert Steiner Date: Tue, 19 Dec 2023 19:50:21 +0100 Subject: [PATCH] Fix sphinx warnings (#2721) --- ...sages.rst => contributor-how-to-create-new-messages.rst} | 0 src/py/flwr/simulation/app.py | 6 +++--- 2 files changed, 3 insertions(+), 3 deletions(-) rename doc/source/{contributor-how-create-new-messages.rst => contributor-how-to-create-new-messages.rst} (100%) diff --git a/doc/source/contributor-how-create-new-messages.rst b/doc/source/contributor-how-to-create-new-messages.rst similarity index 100% rename from doc/source/contributor-how-create-new-messages.rst rename to doc/source/contributor-how-to-create-new-messages.rst diff --git a/src/py/flwr/simulation/app.py b/src/py/flwr/simulation/app.py index 0bb9290b6911..c519f5a551f0 100644 --- a/src/py/flwr/simulation/app.py +++ b/src/py/flwr/simulation/app.py @@ -107,8 +107,8 @@ def start_simulation( List `client_id`s for each client. This is only required if `num_clients` is not set. Setting both `num_clients` and `clients_ids` with `len(clients_ids)` not equal to `num_clients` generates an error. - client_resources : Optional[Dict[str, float]] (default: `{"num_cpus": 1, - "num_gpus": 0.0}` CPU and GPU resources for a single client. Supported keys + client_resources : Optional[Dict[str, float]] (default: `{"num_cpus": 1, "num_gpus": 0.0}`) + CPU and GPU resources for a single client. Supported keys are `num_cpus` and `num_gpus`. To understand the GPU utilization caused by `num_gpus`, as well as using custom resources, please consult the Ray documentation. @@ -160,7 +160,7 @@ def start_simulation( ------- hist : flwr.server.history.History Object containing metrics from training. - """ + """ # noqa: E501 # pylint: disable-msg=too-many-locals event( EventType.START_SIMULATION_ENTER,