[tune] wandb - api_key_file clarification (#10614)

Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
This commit is contained in:
Edward Oakes
2020-09-07 18:31:50 -05:00
committed by GitHub
parent 088f8ebb69
commit 8db1f16f25
+5 -2
View File
@@ -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.