Skip to content

Commit

Permalink
Fix the table format in watch.md (#1090)
Browse files Browse the repository at this point in the history
---------

Co-authored-by: Matt Linville <[email protected]>
Co-authored-by: Matt Linville <[email protected]>
  • Loading branch information
3 people authored Feb 13, 2025
1 parent 2f9fa2c commit 41ad41c
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion content/ref/python/watch.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,12 @@ extended to support arbitrary machine learning models in the future.

| Args | |
| :--- | :--- |
| models (Union[torch.nn.Module, Sequence[torch.nn.Module]]): A single model or a sequence of models to be monitored. criterion (Optional[torch.F]): The loss function being optimized (optional). log (Optional[Literal["gradients", "parameters", "all"]]): Specifies whether to log "gradients", "parameters", or "all". Set to None to disable logging. (default="gradients") log_freq (int): Frequency (in batches) to log gradients and parameters. (default=1000) idx (Optional[int]): Index used when tracking multiple models with `wandb.watch`. (default=None) log_graph (bool): Whether to log the model's computational graph. (default=False) |
| `models` | A single model or a sequence of models to be monitored. |
|`criterion `| The loss function being optimized (optional). |
|`log `| Specifies whether to log `gradients`, `parameters`, or `all`. Set to `None` to disable logging. (default="gradients") |
|`log_freq `|: How frequently to log gradients and parameters, expressed in batches. (default=1000)|
|`idx `| Index used when tracking multiple models with `wandb.watch`. (default=None)|
|`log_graph `| Whether to log the model's computational graph. (default=False) |

| Raises | |
| :--- | :--- |
Expand Down

0 comments on commit 41ad41c

Please sign in to comment.