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

[Do no merge] Lazydocs SDK DataTypes doc preview. #1104

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ngrayluna
Copy link
Contributor

@ngrayluna ngrayluna commented Feb 19, 2025

This PR is for previewing modifications made to wandb/wandb/sdk/data_types/*.py created from this PR: https://github.com/wandb/wandb/pull/9220/files

To generate these files I used ngrayluna/generate-wandb-python-reference. As discussed here, there are some methods, etc. that are public even though they should be hidden by preprending an underscore (_) to said methods. Changing these methods today would require updating CI tests (which was/is not advices by SDK Team). The work around is to add this string <!-- lazydoc-ignore: internal --> within each method's, etc. docstring that is exposed, but shouldn't be.

Doc Team: Do not review (yet).

SDK Team: For this first pass, can ya'll comment on:
[ ] Methods, Classes etc. that should not be shown.
[ ] Whether or not the descriptions I added as placeholders (e.g. for from_json) are OK.
[ ] Anything else that looks off?
[ ] BoundingBoxes2D and WBTraceTree is currently in our live docs, but it is not in __init__template.pyi (where/how I make my list for lazydocs to pull APIs from), should they be?

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

content/ref/python-library/actions/Artifact.md|212 col 48| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Artifact.md|212 col 64| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Artifact.md|274 col 9| [Google.Spacing] 'b.W' should have one space.
content/ref/python-library/actions/Artifact.md|317 col 27| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Artifact.md|353 col 34| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Artifact.md|353 col 55| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Artifact.md|353 col 150| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Artifact.md|388 col 3| [Google.OptionalPlurals] Don't use plurals in parentheses such as in 'http(s)'.
content/ref/python-library/actions/Artifact.md|402 col 48| [Google.OptionalPlurals] Don't use plurals in parentheses such as in 'resource(s)'.
content/ref/python-library/actions/Artifact.md|455 col 33| [Google.Latin] Use 'that is' instead of 'i.e.'.
content/ref/python-library/actions/Artifact.md|461 col 88| [Google.Spacing] 't. O' should have one space.
content/ref/python-library/actions/Artifact.md|461 col 164| [Google.Spacing] 's. T' should have one space.
content/ref/python-library/actions/Artifact.md|461 col 221| [Google.Latin] Use 'that is' instead of 'i.e.'.
content/ref/python-library/actions/Artifact.md|702 col 61| [Google.Spacing] 't. T' should have one space.
content/ref/python-library/actions/Artifact.md|848 col 50| [Google.Latin] Use 'that is' instead of 'i.e.'.
content/ref/python-library/actions/unwatch.md|24 col 18| [Google.Spacing] 'n.M' should have one space.
content/ref/python-library/actions/unwatch.md|24 col 45| [Google.Spacing] 'n.M' should have one space.
content/ref/python-library/actions/use_model.md|23 col 105| [Google.Spacing] 't. M' should have one space.
content/ref/python-library/actions/use_artifact.md|30 col 58| [Google.Spacing] 'e. M' should have one space.
content/ref/python-library/actions/use_artifact.md|30 col 190| [Google.Spacing] 'd. V' should have one space.
content/ref/python-library/actions/use_artifact.md|35 col 99| [Google.Spacing] 'h. W' should have one space.
content/ref/python-library/data_types/Graph.md|21 col 18| [Google.Spacing] 'b.N' should have one space.
content/ref/python-library/data_types/Graph.md|23 col 19| [Google.Spacing] 'b.N' should have one space.
content/ref/python-library/data_types/Graph.md|23 col 31| [Google.Spacing] 'b.N' should have one space.
content/ref/python-library/data_types/Graph.md|25 col 16| [Google.Spacing] 'b.N' should have one space.
content/ref/python-library/data_types/Html.md|19 col 49| [Google.Spacing] 't. I' should have one space.
content/ref/python-library/actions/watch.md|24 col 30| [Google.OptionalPlurals] Don't use plurals in parentheses such as in 'model(s)'.
content/ref/python-library/actions/watch.md|31 col 24| [Google.Spacing] 'n.M' should have one space.
content/ref/python-library/actions/watch.md|31 col 50| [Google.Spacing] 'n.M' should have one space.
content/ref/python-library/actions/watch.md|31 col 145| [Google.Spacing] 'h.F' should have one space.
content/ref/python-library/actions/watch.md|31 col 222| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/watch.md|31 col 235| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/watch.md|31 col 285| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/watch.md|31 col 298| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/watch.md|31 col 315| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Histogram.md|24 col 48| [Google.Spacing] 'm. T' should have one space.
content/ref/python-library/data_types/Image.md|20 col 69| [Google.Spacing] 'e. T' should have one space.
content/ref/python-library/data_types/Image.md|21 col 56| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Image.md|21 col 61| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Image.md|21 col 68| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Video.md|18 col 105| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Video.md|18 col 112| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Video.md|18 col 129| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Video.md|18 col 189| [Google.Spacing] 't. V' should have one space.
content/ref/python-library/data_types/Video.md|18 col 236| [Google.Spacing] 'r. T' should have one space.
content/ref/python-library/data_types/Video.md|18 col 301| [Google.Spacing] 'l. C' should have one space.
content/ref/python-library/data_types/Video.md|20 col 63| [Google.Spacing] 's. D' should have one space.
content/ref/python-library/actions/Api.md|101 col 153| [Google.Spacing] 'd. V' should have one space.
content/ref/python-library/actions/Api.md|160 col 70| [Google.Spacing] 't. I' should have one space.
content/ref/python-library/actions/Api.md|160 col 169| [Google.Spacing] 'd. O' should have one space.
content/ref/python-library/actions/Api.md|160 col 257| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|188 col 59| [Google.Spacing] 'n. N' should have one space.
content/ref/python-library/actions/Api.md|188 col 92| [Google.Spacing] 'e. U' should have one space.
content/ref/python-library/actions/Api.md|209 col 59| [Google.Spacing] 't. I' should have one space.
content/ref/python-library/actions/Api.md|209 col 158| [Google.Spacing] 'd. O' should have one space.
content/ref/python-library/actions/Api.md|209 col 246| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|296 col 59| [Google.Spacing] 'n. N' should have one space.
content/ref/python-library/actions/Api.md|296 col 92| [Google.Spacing] 'e. U' should have one space.
content/ref/python-library/actions/Api.md|339 col 55| [Google.Spacing] 'n. T' should have one space.
content/ref/python-library/actions/Api.md|370 col 57| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|370 col 76| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|370 col 93| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|370 col 107| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|377 col 4| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|377 col 14| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|391 col 42| [Google.Spacing] 'b.E' should have one space.
content/ref/python-library/actions/Api.md|522 col 35| [Google.OptionalPlurals] Don't use plurals in parentheses such as in 'job(s)'.
content/ref/python-library/actions/Api.md|523 col 37| [Google.OptionalPlurals] Don't use plurals in parentheses such as in 'job(s)'.
content/ref/python-library/actions/Api.md|545 col 36| [Google.Spacing] 'd. I' should have one space.
content/ref/python-library/actions/Api.md|569 col 36| [Google.Spacing] 'd. I' should have one space.
content/ref/python-library/actions/Api.md|570 col 49| [Google.Spacing] 'n. N' should have one space.
content/ref/python-library/actions/Api.md|570 col 82| [Google.Spacing] 'e. U' should have one space.
content/ref/python-library/actions/Api.md|618 col 49| [Google.Spacing] 'n. N' should have one space.
content/ref/python-library/actions/Api.md|618 col 82| [Google.Spacing] 'e. U' should have one space.
content/ref/python-library/actions/Api.md|717 col 80| [Google.Spacing] 'e. Y' should have one space.
content/ref/python-library/actions/Api.md|720 col 153| [Google.Spacing] 'g. I' should have one space.
content/ref/python-library/actions/Api.md|743 col 77| [Google.Spacing] 'd. I' should have one space.
content/ref/python-library/actions/Api.md|806 col 78| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|806 col 97| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|806 col 114| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|806 col 128| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|810 col 16| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|810 col 26| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|827 col 54| [Google.Spacing] 'b.E' should have one space.
content/ref/python-library/data_types/Table.md|22 col 60| [Google.Spacing] 'e. D' should have one space.
content/ref/python-library/data_types/Table.md|22 col 77| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Table.md|22 col 86| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Table.md|24 col 22| [Google.Spacing] 's.D' should have one space.
content/ref/python-library/data_types/Table.md|24 col 77| [Google.Spacing] 'e. W' should have one space.
content/ref/python-library/data_types/Table.md|124 col 115| [Google.Spacing] 'b.I' should have one space.
content/ref/python-library/data_types/Table.md|124 col 130| [Google.Spacing] 'b.C' should have one space.
content/ref/python-library/data_types/Table.md|131 col 52| [Google.Spacing] 's.T' should have one space.

- `step_metric`: The name of another metric to serve as the X-axis for this metric in automatically generated charts.
- `step_sync`: Automatically insert the last value of step_metric into `run.log()` if it is not provided explicitly. Defaults to True if step_metric is specified.
- `hidden`: Hide this metric from automatic plots.
- `summary`: Specify aggregate metrics added to summary. Supported aggregations include "min", "max", "mean", "last", "best", "copy" and "none". "best" is used together with the goal parameter. "none" prevents a summary from being generated. "copy" is deprecated and should not be used.
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Google.Spacing] 'y. S' should have one space.

- `step_metric`: The name of another metric to serve as the X-axis for this metric in automatically generated charts.
- `step_sync`: Automatically insert the last value of step_metric into `run.log()` if it is not provided explicitly. Defaults to True if step_metric is specified.
- `hidden`: Hide this metric from automatic plots.
- `summary`: Specify aggregate metrics added to summary. Supported aggregations include "min", "max", "mean", "last", "best", "copy" and "none". "best" is used together with the goal parameter. "none" prevents a summary from being generated. "copy" is deprecated and should not be used.
Copy link
Contributor

Choose a reason for hiding this comment

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

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

- `step_metric`: The name of another metric to serve as the X-axis for this metric in automatically generated charts.
- `step_sync`: Automatically insert the last value of step_metric into `run.log()` if it is not provided explicitly. Defaults to True if step_metric is specified.
- `hidden`: Hide this metric from automatic plots.
- `summary`: Specify aggregate metrics added to summary. Supported aggregations include "min", "max", "mean", "last", "best", "copy" and "none". "best" is used together with the goal parameter. "none" prevents a summary from being generated. "copy" is deprecated and should not be used.
Copy link
Contributor

Choose a reason for hiding this comment

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

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

- `step_metric`: The name of another metric to serve as the X-axis for this metric in automatically generated charts.
- `step_sync`: Automatically insert the last value of step_metric into `run.log()` if it is not provided explicitly. Defaults to True if step_metric is specified.
- `hidden`: Hide this metric from automatic plots.
- `summary`: Specify aggregate metrics added to summary. Supported aggregations include "min", "max", "mean", "last", "best", "copy" and "none". "best" is used together with the goal parameter. "none" prevents a summary from being generated. "copy" is deprecated and should not be used.
Copy link
Contributor

Choose a reason for hiding this comment

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

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

- `step_metric`: The name of another metric to serve as the X-axis for this metric in automatically generated charts.
- `step_sync`: Automatically insert the last value of step_metric into `run.log()` if it is not provided explicitly. Defaults to True if step_metric is specified.
- `hidden`: Hide this metric from automatic plots.
- `summary`: Specify aggregate metrics added to summary. Supported aggregations include "min", "max", "mean", "last", "best", "copy" and "none". "best" is used together with the goal parameter. "none" prevents a summary from being generated. "copy" is deprecated and should not be used.
Copy link
Contributor

Choose a reason for hiding this comment

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

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

- `data_table` (wandb.Table): A `wandb.Table` object containing the data to be visualized.
- `fields` (dict[str, Any]): A mapping between the fields in the Vega-Lite spec and the corresponding columns in the data table to be visualized.
- `string_fields` (dict[str, Any] | None): A dictionary for providing values for any string constants required by the custom visualization.
- `split_table` (bool): Whether the table should be split into a separate section in the W&B UI. If `True`, the table will be displayed in a section named "Custom Chart Tables". Default is `False`.
Copy link
Contributor

Choose a reason for hiding this comment

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

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


Relative paths are relative to the current working directory.

A Unix glob, such as "myfiles/*", is expanded at the time `save` is called regardless of the `policy`. In particular, new files are not picked up automatically.
Copy link
Contributor

Choose a reason for hiding this comment

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

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


**Args:**

- `name`: A human-readable name for the artifact. Use the name to identify a specific artifact in the W&B App UI or programmatically. You can interactively reference an artifact with the `use_artifact` Public API. A name can contain letters, numbers, underscores, hyphens, and dots. The name must be unique across a project.
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Google.Spacing] 's. T' should have one space.


### <kbd>property</kbd> Artifact.aliases

List of one or more semantically-friendly references or identifying "nicknames" assigned to an artifact version.
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Google.LyHyphens] 'semantically-friendly' doesn't need a hyphen.


### <kbd>property</kbd> Artifact.state

The status of the artifact. One of: "PENDING", "COMMITTED", or "DELETED".
Copy link
Contributor

Choose a reason for hiding this comment

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

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

@ngrayluna ngrayluna added the DO-NOT-MERGE For PRs that should not be merged yet label Feb 26, 2025
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

content/ref/python-library/actions/watch.md|31 col 285| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/watch.md|31 col 298| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/watch.md|31 col 315| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Html.md|19 col 49| [Google.Spacing] 't. I' should have one space.
content/ref/python-library/data_types/Image.md|20 col 69| [Google.Spacing] 'e. T' should have one space.
content/ref/python-library/data_types/Image.md|21 col 56| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Image.md|21 col 61| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Image.md|21 col 68| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Video.md|18 col 105| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Video.md|18 col 112| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Video.md|18 col 129| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Video.md|18 col 189| [Google.Spacing] 't. V' should have one space.
content/ref/python-library/data_types/Video.md|18 col 236| [Google.Spacing] 'r. T' should have one space.
content/ref/python-library/data_types/Video.md|18 col 301| [Google.Spacing] 'l. C' should have one space.
content/ref/python-library/data_types/Video.md|20 col 63| [Google.Spacing] 's. D' should have one space.
content/ref/python-library/data_types/Table.md|22 col 60| [Google.Spacing] 'e. D' should have one space.
content/ref/python-library/data_types/Table.md|22 col 77| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Table.md|22 col 86| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/data_types/Table.md|24 col 22| [Google.Spacing] 's.D' should have one space.
content/ref/python-library/data_types/Table.md|24 col 77| [Google.Spacing] 'e. W' should have one space.
content/ref/python-library/data_types/Table.md|124 col 115| [Google.Spacing] 'b.I' should have one space.
content/ref/python-library/data_types/Table.md|124 col 130| [Google.Spacing] 'b.C' should have one space.
content/ref/python-library/data_types/Table.md|131 col 52| [Google.Spacing] 's.T' should have one space.
content/ref/python-library/actions/Api.md|101 col 153| [Google.Spacing] 'd. V' should have one space.
content/ref/python-library/actions/Api.md|160 col 70| [Google.Spacing] 't. I' should have one space.
content/ref/python-library/actions/Api.md|160 col 169| [Google.Spacing] 'd. O' should have one space.
content/ref/python-library/actions/Api.md|160 col 257| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|188 col 59| [Google.Spacing] 'n. N' should have one space.
content/ref/python-library/actions/Api.md|188 col 92| [Google.Spacing] 'e. U' should have one space.
content/ref/python-library/actions/Api.md|209 col 59| [Google.Spacing] 't. I' should have one space.
content/ref/python-library/actions/Api.md|209 col 158| [Google.Spacing] 'd. O' should have one space.
content/ref/python-library/actions/Api.md|209 col 246| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|296 col 59| [Google.Spacing] 'n. N' should have one space.
content/ref/python-library/actions/Api.md|296 col 92| [Google.Spacing] 'e. U' should have one space.
content/ref/python-library/actions/Api.md|339 col 55| [Google.Spacing] 'n. T' should have one space.
content/ref/python-library/actions/Api.md|370 col 57| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|370 col 76| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|370 col 93| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|370 col 107| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|377 col 4| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|377 col 14| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|391 col 42| [Google.Spacing] 'b.E' should have one space.
content/ref/python-library/actions/Api.md|522 col 35| [Google.OptionalPlurals] Don't use plurals in parentheses such as in 'job(s)'.
content/ref/python-library/actions/Api.md|523 col 37| [Google.OptionalPlurals] Don't use plurals in parentheses such as in 'job(s)'.
content/ref/python-library/actions/Api.md|545 col 36| [Google.Spacing] 'd. I' should have one space.
content/ref/python-library/actions/Api.md|569 col 36| [Google.Spacing] 'd. I' should have one space.
content/ref/python-library/actions/Api.md|570 col 49| [Google.Spacing] 'n. N' should have one space.
content/ref/python-library/actions/Api.md|570 col 82| [Google.Spacing] 'e. U' should have one space.
content/ref/python-library/actions/Api.md|618 col 49| [Google.Spacing] 'n. N' should have one space.
content/ref/python-library/actions/Api.md|618 col 82| [Google.Spacing] 'e. U' should have one space.
content/ref/python-library/actions/Api.md|675 col 77| [Google.Latin] Use 'for example' instead of 'e.g.'.
content/ref/python-library/actions/Api.md|676 col 63| [Google.Latin] Use 'for example' instead of 'e.g.'.
content/ref/python-library/actions/Api.md|681 col 46| [Google.Latin] Use 'for example' instead of 'e.g.'.
content/ref/python-library/actions/Api.md|764 col 80| [Google.Spacing] 'e. Y' should have one space.
content/ref/python-library/actions/Api.md|766 col 153| [Google.Spacing] 'g. I' should have one space.
content/ref/python-library/actions/Api.md|789 col 77| [Google.Spacing] 'd. I' should have one space.
content/ref/python-library/actions/Api.md|852 col 78| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|852 col 97| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|852 col 114| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|852 col 128| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|856 col 16| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|856 col 26| [Google.Quotes] Commas and periods go inside quotation marks.
content/ref/python-library/actions/Api.md|873 col 54| [Google.Spacing] 'b.E' should have one space.



**Args:**
models (torch.nn.Module | Sequence[torch.nn.Module]): Optional list of pytorch models that have had watch called on them
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Google.Spacing] 'n.M' should have one space.



**Args:**
models (torch.nn.Module | Sequence[torch.nn.Module]): Optional list of pytorch models that have had watch called on them
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Google.Spacing] 'n.M' should have one space.


**Args:**

- `name`: (str) A model artifact name. 'name' must match the name of an existing logged model artifact. May be prefixed with entity/project/. Valid names can be in the following forms:
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Google.Spacing] 't. M' should have one space.


**Args:**

- `artifact_or_name`: (str or Artifact) An artifact name. May be prefixed with project/ or entity/project/. If no entity is specified in the name, the Run or API setting's entity is used. Valid names can be in the following forms:
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Google.Spacing] 'e. M' should have one space.


**Args:**

- `artifact_or_name`: (str or Artifact) An artifact name. May be prefixed with project/ or entity/project/. If no entity is specified in the name, the Run or API setting's entity is used. Valid names can be in the following forms:
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Google.Spacing] 'd. V' should have one space.



**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)
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Google.Spacing] 'n.M' should have one space.



**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)
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Google.Spacing] 'n.M' should have one space.



**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)
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Google.Spacing] 'h.F' should have one space.



**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)
Copy link
Contributor

Choose a reason for hiding this comment

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

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



**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)
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: d8c9f41
Status: ✅  Deploy successful!
Preview URL: https://09d3b609.docodile.pages.dev
Branch Preview URL: https://lazydocs-datatypes-preview.docodile.pages.dev

View logs

@wandb wandb deleted a comment from github-actions bot Mar 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DO-NOT-MERGE For PRs that should not be merged yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant