docs: update examples doc #1123
Conversation
docs/faq.txt
Outdated
| <https://github.com/determined-ai/determined/blob/master/examples/experimental/trial/mnist_tp_to_estimator/model_def.py>`_. | ||
|
|
||
|
|
||
| Tensorboard Support |
There was a problem hiding this comment.
"TensorBoard", here and below.
docs/faq.txt
Outdated
| Tensorboard Support | ||
| ------------------- | ||
|
|
||
| Can I log Tensorboards events in Determined? |
There was a problem hiding this comment.
I'm a little confused by how this is worded: isn't all TensorBoard metadata captured as a series of events? Is this talking about logging additional custom data to TensorBoard? I wonder if a code example would be helpful -- i.e., where should the path /tmp/tensorboard be passed to?
There was a problem hiding this comment.
I rephrased this and added a code snipped showing how this can be done for PyTorch.
docs/faq.txt
Outdated
|
|
||
| Can I use Tensorboard with PyTorch? | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| Yes! For an example of this check out the `mnist-GAN example <https://github.com/determined-ai/determined/blob/master/examples/official/trial/mnist_gan_pytorch/model_def.py>`_. |
There was a problem hiding this comment.
Would you mind also updating the TensorBoard How-To guide with this information? A little more detail would be nice, as well -- i.e., is using determined.tensorboard.metric_writers.pytorch.TorchWriter necessary? (If so, maybe we should add that to the API reference -- but we can do that later.)
There was a problem hiding this comment.
Added a bit more detail here, also added info about PyTorch to the How-To guide and a reference guide for determined.tensorboard.metric_writers.pytorch.TorchWriter.
Description
Removed outdated code from examples, and added a couple FAQ items that have come up recently in the community slack.
Test Plan
Compiled locally.