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

Update watch.md #1090

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update watch.md #1090

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 @@

| 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") |

Check failure on line 27 in content/ref/python/watch.md

View workflow job for this annotation

GitHub Actions / Vale check 

[vale] reported by reviewdog 🐶
[Google.Quotes] Commas and periods go inside quotation marks.

Raw Output:
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "content/ref/python/watch.md", "range": {"start": {"line": 27, "column": 35}}}, "severity": "ERROR"}

Check failure on line 27 in content/ref/python/watch.md

View workflow job for this annotation

GitHub Actions / Vale check 

[vale] reported by reviewdog 🐶
[Google.Quotes] Commas and periods go inside quotation marks.

Raw Output:
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "content/ref/python/watch.md", "range": {"start": {"line": 27, "column": 48}}}, "severity": "ERROR"}

Check failure on line 27 in content/ref/python/watch.md

View workflow job for this annotation

GitHub Actions / Vale check 

[vale] reported by reviewdog 🐶
[Google.Quotes] Commas and periods go inside quotation marks.

Raw Output:
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "content/ref/python/watch.md", "range": {"start": {"line": 27, "column": 65}}}, "severity": "ERROR"}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|`log `| Specifies whether to log "gradients", "parameters", or "all". Set to None to disable logging. (default="gradients") |
|`log `| Specifies whether to log `gradients`, `parameters`, or `all`. Set to `None` to disable logging. (default="gradients") |

|`log_freq `|: Frequency (in batches) to log gradients and parameters. (default=1000)|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm doing a little research about what this option is about. The description is confusing me.

|`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