Skip to content

Commit 5c01290

Browse files
committed
remove type hints from docstrings
1 parent caab338 commit 5c01290

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/lightning/pytorch/loggers/comet.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -172,20 +172,20 @@ def __init__(self, *args, **kwarg):
172172
- `Comet Documentation <https://www.comet.com/docs/v2/integrations/ml-frameworks/pytorch-lightning/>`__
173173
174174
Args:
175-
api_key (str, optional): Comet API key. It's recommended to configure the API Key with `comet login`.
176-
workspace (str, optional): Comet workspace name. If not provided, uses the default workspace.
177-
project (str, optional): Comet project name. Defaults to `Uncategorized`.
178-
experiment_key (str, optional): The Experiment identifier to be used for logging. This is used either to append
175+
api_key: Comet API key. It's recommended to configure the API Key with `comet login`.
176+
workspace: Comet workspace name. If not provided, uses the default workspace.
177+
project: Comet project name. Defaults to `Uncategorized`.
178+
experiment_key: The Experiment identifier to be used for logging. This is used either to append
179179
data to an Existing Experiment or to control the key of new experiments (for example to match another
180180
identifier). Must be an alphanumeric string whose length is between 32 and 50 characters.
181-
mode (str, optional): Control how the Comet experiment is started.
181+
mode: Control how the Comet experiment is started.
182182
* ``"get_or_create"``: Starts a fresh experiment if required, or persists logging to an existing one.
183183
* ``"get"``: Continue logging to an existing experiment identified by the ``experiment_key`` value.
184184
* ``"create"``: Always creates of a new experiment, useful for HPO sweeps.
185-
online (boolean, optional): If True, the data will be logged to Comet server, otherwise it will be stored
185+
online: If True, the data will be logged to Comet server, otherwise it will be stored
186186
locally in an offline experiment. Default is ``True``.
187-
prefix (str, optional): The prefix to add to names of the logged metrics.
188-
example: prefix=`exp1`, then metric name will be `exp1_metric_name`
187+
prefix: The prefix to add to names of the logged metrics.
188+
example: prefix=`exp1`, then metric name will be logged as `exp1_metric_name`
189189
**kwargs: Additional arguments like `name`, `log_code`, `offline_directory` etc. used by
190190
:class:`CometExperiment` can be passed as keyword arguments in this logger.
191191

0 commit comments

Comments
 (0)