diff --git a/docs/ref/python/wandb_workspaces/reports.md b/docs/ref/python/wandb_workspaces/reports.md index ade8a2b47..99ef5bea5 100644 --- a/docs/ref/python/wandb_workspaces/reports.md +++ b/docs/ref/python/wandb_workspaces/reports.md @@ -1,8 +1,12 @@ +import { CTAButtons } from '@site/src/components/CTAButtons/CTAButtons.tsx' + # Reports + + - + # module `wandb_workspaces.reports.v2` Python library for programmatically working with W&B Reports API. @@ -14,7 +18,7 @@ import wandb_workspaces.reports.v2 --- - + ## class `BarPlot` A panel object that shows a 2D bar plot. @@ -47,23 +51,8 @@ A panel object that shows a 2D bar plot. --- - - -## class `Block` - - - - - - - - ---- - - - ## class `BlockQuote` A block of quoted text. @@ -81,7 +70,7 @@ A block of quoted text. --- - + ## class `CalloutBlock` A block of callout text. @@ -100,7 +89,7 @@ A block of callout text. --- - + ## class `CheckedList` A list of items with checkboxes. Add one or more `CheckedListItem` within `CheckedList`. @@ -119,7 +108,7 @@ A list of items with checkboxes. Add one or more `CheckedListItem` within `Check --- - + ## class `CheckedListItem` A list item with a checkbox. Add one or more `CheckedListItem` within `CheckedList`. @@ -139,7 +128,7 @@ A list item with a checkbox. Add one or more `CheckedListItem` within `CheckedLi --- - + ## class `CodeBlock` A block of code. @@ -159,7 +148,7 @@ A block of code. --- - + ## class `CodeComparer` A panel object that compares the code between two different runs. @@ -178,7 +167,7 @@ A panel object that compares the code between two different runs. --- - + ## class `Config` Metrics logged to a run's config object. Config objects are commonly logged using `run.config[name] = ...` or passing a config as a dictionary of key-value pairs, where the key is the name of the metric and the value is the value of that metric. @@ -197,7 +186,7 @@ Metrics logged to a run's config object. Config objects are commonly logged usin --- - + ## class `CustomChart` A panel that shows a custom chart. The chart is defined by a weave query. @@ -216,7 +205,7 @@ A panel that shows a custom chart. The chart is defined by a weave query. --- - + ### classmethod `from_table` @@ -243,7 +232,7 @@ Create a custom chart from a table. --- - + ## class `Gallery` A block that renders a gallery of reports and URLs. @@ -262,7 +251,7 @@ A block that renders a gallery of reports and URLs. --- - + ## class `GalleryReport` A reference to a report in the gallery. @@ -281,7 +270,7 @@ A reference to a report in the gallery. --- - + ## class `GalleryURL` A URL to an external resource. @@ -303,7 +292,7 @@ A URL to an external resource. --- - + ## class `GradientPoint` A point in a gradient. @@ -323,7 +312,7 @@ A point in a gradient. --- - + ## class `H1` An H1 heading with the text specified. @@ -343,7 +332,7 @@ An H1 heading with the text specified. --- - + ## class `H2` An H2 heading with the text specified. @@ -363,7 +352,7 @@ An H2 heading with the text specified. --- - + ## class `H3` An H3 heading with the text specified. @@ -383,7 +372,7 @@ An H3 heading with the text specified. --- - + ## class `Heading` @@ -398,7 +387,7 @@ An H3 heading with the text specified. --- - + ## class `HorizontalRule` HTML horizontal line. @@ -411,7 +400,7 @@ HTML horizontal line. --- - + ## class `Image` A block that renders an image. @@ -431,7 +420,7 @@ A block that renders an image. --- - + ## class `InlineCode` Inline code. Does not add newline character after code. @@ -450,7 +439,7 @@ Inline code. Does not add newline character after code. --- - + ## class `InlineLatex` Inline LaTeX markdown. Does not add newline character after the LaTeX markdown. @@ -469,7 +458,7 @@ Inline LaTeX markdown. Does not add newline character after the LaTeX markdown. --- - + ## class `LatexBlock` A block of LaTeX text. @@ -488,7 +477,7 @@ A block of LaTeX text. --- - + ## class `Layout` The layout of a panel in a report. Adjusts the size and position of the panel. @@ -510,7 +499,7 @@ The layout of a panel in a report. Adjusts the size and position of the panel. --- - + ## class `LinePlot` A panel object with 2D line plots. @@ -553,7 +542,7 @@ A panel object with 2D line plots. --- - + ## class `Link` A link to a URL. @@ -573,38 +562,8 @@ A link to a URL. --- - - -## class `List` - - - - - - - - - - ---- - - - -## class `ListItem` - - - - - - - - ---- - - - ## class `MarkdownBlock` A block of markdown text. Useful if you want to write text that uses common markdown syntax. @@ -622,7 +581,7 @@ A block of markdown text. Useful if you want to write text that uses common mark --- - + ## class `MarkdownPanel` A panel that renders markdown. @@ -641,7 +600,7 @@ A panel that renders markdown. --- - + ## class `MediaBrowser` A panel that displays media files in a grid layout. @@ -661,7 +620,7 @@ A panel that displays media files in a grid layout. --- - + ## class `Metric` A metric to display in a report that is logged in your project. @@ -680,7 +639,7 @@ A metric to display in a report that is logged in your project. --- - + ## class `OrderBy` A metric to order by. @@ -700,7 +659,7 @@ A metric to order by. --- - + ## class `OrderedList` A list of items in a numbered list. @@ -719,7 +678,7 @@ A list of items in a numbered list. --- - + ## class `OrderedListItem` A list item in an ordered list. @@ -738,7 +697,7 @@ A list item in an ordered list. --- - + ## class `P` A paragraph of text. @@ -757,7 +716,7 @@ A paragraph of text. --- - + ## class `Panel` A panel that displays a visualization in a panel grid. @@ -776,7 +735,7 @@ A panel that displays a visualization in a panel grid. --- - + ## class `PanelGrid` A grid that consists of runsets and panels. Add runsets and panels with `Runset` and `Panel` objects, respectively. @@ -802,7 +761,7 @@ Available panels include: `LinePlot`, `ScatterPlot`, `BarPlot`, `ScalarChart`, ` --- - + ## class `ParallelCoordinatesPlot` A panel object that shows a parallel coordinates plot. @@ -824,7 +783,7 @@ A panel object that shows a parallel coordinates plot. --- - + ## class `ParallelCoordinatesPlotColumn` A column within a parallel coordinates plot. The order of `metric`s specified determine the order of the parallel axis (x-axis) in the parallel coordinates plot. @@ -846,7 +805,7 @@ A column within a parallel coordinates plot. The order of `metric`s specified d --- - + ## class `ParameterImportancePlot` A panel that shows how important each hyperparameter is in predicting the chosen metric. @@ -865,7 +824,7 @@ A panel that shows how important each hyperparameter is in predicting the chosen --- - + ## class `Report` An object that represents a W&B Report. Use the returned object's `blocks` attribute to customize your report. Report objects do not automatically save. Use the `save()` method to persists changes. @@ -892,7 +851,7 @@ The URL where the report is hosted. The report URL consists of `https://wandb.ai --- - + ### classmethod `from_url` @@ -911,7 +870,7 @@ Load in the report into current environment. Pass in the URL where the report is --- - + ### method `save` @@ -923,7 +882,7 @@ Persists changes made to a report object. --- - + ### method `to_html` @@ -942,7 +901,7 @@ Generate HTML containing an iframe displaying this report. Commonly used to with --- - + ## class `RunComparer` A panel that compares metrics across different runs from the project the report pulls information from. @@ -961,7 +920,7 @@ A panel that compares metrics across different runs from the project the report --- - + ## class `Runset` A set of runs to display in a panel grid. @@ -987,7 +946,7 @@ A set of runs to display in a panel grid. --- - + ## class `RunsetGroup` UI element that shows a group of runsets. @@ -1007,7 +966,7 @@ UI element that shows a group of runsets. --- - + ## class `RunsetGroupKey` Groups runsets by a metric type and value. Part of a `RunsetGroup`. Specify the metric type and value to group by as key-value pairs. @@ -1027,7 +986,7 @@ Groups runsets by a metric type and value. Part of a `RunsetGroup`. Specify the --- - + ## class `ScalarChart` A panel object that shows a scalar chart. @@ -1052,7 +1011,7 @@ A panel object that shows a scalar chart. --- - + ## class `ScatterPlot` A panel object that shows a 2D or 3D scatter plot. @@ -1086,7 +1045,7 @@ A panel object that shows a 2D or 3D scatter plot. --- - + ## class `SoundCloud` A block that renders a SoundCloud player. @@ -1105,7 +1064,7 @@ A block that renders a SoundCloud player. --- - + ## class `Spotify` A block that renders a Spotify player. @@ -1124,7 +1083,7 @@ A block that renders a Spotify player. --- - + ## class `SummaryMetric` A summary metric to display in a report. @@ -1143,7 +1102,7 @@ A summary metric to display in a report. --- - + ## class `TableOfContents` A block that contains a list of sections and subsections using H1, H2, and H3 HTML blocks specified in a report. @@ -1156,7 +1115,7 @@ A block that contains a list of sections and subsections using H1, H2, and H3 HT --- - + ## class `TextWithInlineComments` A block of text with inline comments. @@ -1175,7 +1134,7 @@ A block of text with inline comments. --- - + ## class `Twitter` A block that displays a Twitter feed. @@ -1194,38 +1153,8 @@ A block that displays a Twitter feed. --- - - -## class `UnknownBlock` - - - - - - - - ---- - - - -## class `UnknownPanel` - - - - - - - - - - ---- - - - ## class `UnorderedList` A list of items in a bulleted list. @@ -1243,7 +1172,7 @@ A list of items in a bulleted list. --- - + ## class `UnorderedListItem` A list item in an unordered list. @@ -1262,7 +1191,7 @@ A list item in an unordered list. --- - + ## class `Video` A block that renders a video. @@ -1281,23 +1210,8 @@ A block that renders a video. --- - - -## class `WeaveBlock` - - - - - - - - ---- - - - ## class `WeaveBlockArtifact` A block that shows an artifact logged to W&B. The query takes the form of @@ -1324,7 +1238,7 @@ The term "Weave" in the API name does not refer to the W&B Weave toolkit used fo --- - + ## class `WeaveBlockArtifactVersionedFile` A block that shows a versioned file logged to a W&B artifact. The query takes the form of @@ -1353,7 +1267,7 @@ The term "Weave" in the API name does not refer to the W&B Weave toolkit used fo --- - + ## class `WeaveBlockSummaryTable` A block that shows a W&B Table, pandas DataFrame, plot, or other value logged to W&B. The query takes the form of @@ -1380,7 +1294,7 @@ The term "Weave" in the API name does not refer to the W&B Weave toolkit used fo --- - + ## class `WeavePanel` An empty query panel that can be used to display custom content using queries. @@ -1395,7 +1309,7 @@ The term "Weave" in the API name does not refer to the W&B Weave toolkit used fo --- - + ## class `WeavePanelArtifact` A panel that shows an artifact logged to W&B. @@ -1417,7 +1331,7 @@ The term "Weave" in the API name does not refer to the W&B Weave toolkit used fo --- - + ## class `WeavePanelArtifactVersionedFile` A panel that shows a versioned file logged to a W&B artifact. @@ -1444,7 +1358,7 @@ The term "Weave" in the API name does not refer to the W&B Weave toolkit used fo --- - + ## class `WeavePanelSummaryTable` A panel that shows a W&B Table, pandas DataFrame, plot, or other value logged to W&B. The query takes the form of diff --git a/docs/ref/python/wandb_workspaces/workspaces.md b/docs/ref/python/wandb_workspaces/workspaces.md index 0922e13d3..c088ca9fd 100644 --- a/docs/ref/python/wandb_workspaces/workspaces.md +++ b/docs/ref/python/wandb_workspaces/workspaces.md @@ -1,11 +1,15 @@ +import { CTAButtons } from '@site/src/components/CTAButtons/CTAButtons.tsx' + # Workspaces + + - + # module `wandb_workspaces.workspaces` -Python library for programmatically working with Weights & Biases Workspace API. +Python library for programmatically working with W&B Workspace API. ```python # How to import @@ -14,7 +18,7 @@ import wandb_workspaces.workspaces --- - + ## class `RunSettings` Settings for a run in a runset (left hand bar). @@ -34,7 +38,7 @@ Settings for a run in a runset (left hand bar). --- - + ## class `RunsetSettings` Settings for the runset (the left bar containing runs) in a workspace. @@ -58,7 +62,7 @@ Settings for the runset (the left bar containing runs) in a workspace. --- - + ## class `Section` Represents a section in a workspace. @@ -81,7 +85,7 @@ Represents a section in a workspace. --- - + ## class `SectionLayoutSettings` Panel layout settings for a section, typically seen at the top right of the section of the W&B App Workspace UI. @@ -102,7 +106,7 @@ Panel layout settings for a section, typically seen at the top right of the sect --- - + ## class `SectionPanelSettings` Panel settings for a section, similar to `WorkspaceSettings` for a section. @@ -127,7 +131,7 @@ Settings applied here can be overrided by more granular Panel settings in this p --- - + ## class `Workspace` Represents a W&B workspace, including sections, settings, and config for run sets. @@ -154,7 +158,7 @@ The URL to the workspace in the W&B app. --- - + ### classmethod `from_url` @@ -166,7 +170,7 @@ Get a workspace from a URL. --- - + ### method `save` @@ -184,7 +188,7 @@ Save the current workspace to W&B. --- - + ### method `save_as_new_view` @@ -202,7 +206,7 @@ Save the current workspace as a new view to W&B. --- - + ## class `WorkspaceSettings` Settings for the workspace, typically seen at the top of the workspace in the UI.