Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the table format in watch.md #1090

Merged
merged 3 commits into from
Feb 13, 2025
+6 −1
Merged

Fix the table format in watch.md #1090

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8987947
Update watch.md
A-mess Feb 9, 2025
406eada
Apply suggestions from code review
mdlinville Feb 13, 2025
c08f88c
Merge branch 'main' into patch-1
mdlinville Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion content/ref/python/watch.md
View file
Open in desktop
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