From 8db1f16f2580daae2027e297ba6df400317512b0 Mon Sep 17 00:00:00 2001 From: Edward Oakes Date: Mon, 7 Sep 2020 18:31:50 -0500 Subject: [PATCH] [tune] wandb - api_key_file clarification (#10614) Co-authored-by: Richard Liaw --- python/ray/tune/integration/wandb.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/python/ray/tune/integration/wandb.py b/python/ray/tune/integration/wandb.py index 1fb5ae538..e2da1e924 100644 --- a/python/ray/tune/integration/wandb.py +++ b/python/ray/tune/integration/wandb.py @@ -47,7 +47,8 @@ def wandb_mixin(func): are used to configure the ``WandbTrainableMixin`` itself: Args: - api_key_file (str): Path to file containing the Wandb API KEY. + api_key_file (str): Path to file containing the Wandb API KEY. This + file must be on all nodes if using the `wandb_mixin`. api_key (str): Wandb API Key. Alternative to setting `api_key_file`. Wandb's ``group``, ``run_id`` and ``run_name`` are automatically selected @@ -186,7 +187,9 @@ class WandbLogger(Logger): are used to configure the WandbLogger itself: Args: - api_key_file (str): Path to file containing the Wandb API KEY. + api_key_file (str): Path to file containing the Wandb API KEY. This + file only needs to be present on the node running the Tune script + if using the WandbLogger. api_key (str): Wandb API Key. Alternative to setting ``api_key_file``. excludes (list): List of metrics that should be excluded from the log.