Skip to content

Commit

Permalink
added default value to custom_collector field
Browse files Browse the repository at this point in the history
Signed-off-by: Prakhar Singhal <[email protected]>
  • Loading branch information
prakhar479 committed Aug 13, 2024
1 parent 6c85385 commit b746da0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions sdk/python/v1beta1/kubeflow/katib/api/katib_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ def tune(
retain_trials: bool = False,
packages_to_install: List[str] = None,
pip_index_url: str = "https://pypi.org/simple",
metrics_collector_config: Dict[str, Any] = {"kind": "StdOut"},
metrics_collector_config: Dict[str, Any] = {"kind": "StdOut", "custom_collector": None},
):
"""Create HyperParameter Tuning Katib Experiment from the objective function.
Expand Down Expand Up @@ -252,7 +252,7 @@ def tune(
metrics_collector_config: Specify the config of metrics collector,
for example, `metrics_collector_config = {"kind": "Push"}`.
for using custom metric collectors use "custom_collector" key,
for example, `metrics_collector_config = {"custom_collector": "prometheus "}`.
for example, `metrics_collector_config = {"custom_collector": "prometheus"}`.
Raises:
ValueError: Function arguments have incorrect type or value.
TimeoutError: Timeout to create Katib Experiment.
Expand Down

0 comments on commit b746da0

Please sign in to comment.