Skip to content

Commit c43c19e

Browse files
authored
katib metrics-collector: mention supported writers
See kubeflow/katib#2467 Signed-off-by: Gary Miguel <[email protected]>
1 parent a8d15e9 commit c43c19e

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

content/en/docs/components/katib/user-guides/metrics-collector.md

+3
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,9 @@ To define the pull-based metrics collector for your Experiment:
7373

7474
- `TensorFlowEvent`: Katib collects the metrics from a directory path
7575
containing a [tf.Event](https://www.tensorflow.org/api_docs/python/tf/compat/v1/Event).
76+
These are typically written by [tensorflow.summary](https://www.tensorflow.org/api_docs/python/tf/summary).
77+
As of Katib 0.18, [torch.utils.tensorboard](https://pytorch.org/docs/stable/tensorboard.html) or
78+
[tensorboardX](https://tensorboardx.readthedocs.io/en/latest/index.html) may also be used to write.
7679
You should specify the path in the `.source.fileSystemPath.path` field. Check the
7780
[TFJob example](https://github.com/kubeflow/katib/blob/ea46a7f2b73b2d316b6b7619f99eb440ede1909b/examples/v1beta1/kubeflow-training-operator/tfjob-mnist-with-summaries.yaml#L17-L23).
7881
The default directory path is `/var/log/katib/tfevent/`.

0 commit comments

Comments
 (0)