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.

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
Merged

Fix the table format in watch.md #1090

merged 3 commits into from
Feb 13, 2025

Conversation

A-mess
Copy link
Contributor

@A-mess A-mess commented Feb 9, 2025

{Description of the change}

Fix table format

Fix format
@A-mess A-mess requested a review from a team as a code owner February 9, 2025 08:23
Copy link
Contributor

@mdlinville mdlinville left a comment

Choose a reason for hiding this comment

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

Thank you so much! I have some small suggestions, and I'm looking into log_freq so we can hopefully improve its description a bit.

content/ref/python/watch.md Outdated Show resolved Hide resolved
| `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 `|: 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.

@mdlinville mdlinville changed the title Update watch.md Fix the table format in watch.md Feb 13, 2025
@mdlinville mdlinville enabled auto-merge (squash) February 13, 2025 21:34
@mdlinville mdlinville merged commit 41ad41c into wandb:main Feb 13, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants