Refactoring ahead of multi-plot metrics docs #1996
Conversation
- De-duplicate line plot overview and reference - Adjust heading levels for infrastructure alerts section of overview - Light copyedits and reformatting - Move CoreWeave infrastructure alert content to the Runs page, add section-specific redirects
📚 Mintlify Preview Links📝 Changed (3 total)📄 Pages (3)
🤖 Generated automatically when Mintlify deployment succeeds |
docs.json
Outdated
| "source": "/library/init", | ||
| "destination": "/models/ref/python/functions/init" | ||
| }, | ||
| { |
There was a problem hiding this comment.
This doesn't actually do anything. Leaving it here just to show Mintlify what I tried, but I'll remove these redirects before merging this PR.
- De-duplicate line plot overview and reference - Adjust heading levels for infrastructure alerts section of overview - Light copyedits and reformatting - Move CoreWeave infrastructure alert content to the Runs page, add section-specific redirects
dbrian57
left a comment
dbrian57
left a comment
There was a problem hiding this comment.
Minor suggestions but looks good!
|
|
||
| ### Smoothing | ||
|
|
||
| Set the [smoothing coefficient](/models/support/formula_smoothing_algorithm/) between 0 and 1, where 0 is no smoothing and 1 is maximum smoothing. |
| Rescale the plot to exclude outliers from the default plot min and max scale. The setting's impact depends on the plot's sampling mode: | ||
|
|
||
| Y range default is from the smallest value of your metrics and zero to the largest value of your metrics. | ||
| * **Random sampling mode**: When enabled, only points from 5% to 95% are shown. Outliers are not formatted differently from other points when shown. |
There was a problem hiding this comment.
"Outliers are not formatted differently from other points when shown." This sentence kinda confused me. Do we need it if the setting doesn't affect the outliers?
There was a problem hiding this comment.
+1 Let's ask someone from Eng to verify.
There was a problem hiding this comment.
I updated this to be more clear. I'm not confused about how it works since I updated the docs when we revamped smoothing. PTAL
models/runs.mdx
Outdated
| <img src="/images/app_ui/cw_wb_observability.png" /> | ||
| </Frame> | ||
|
|
||
| The **All Issues** list all issues that occurs during the run in chronological order, with the most recent issue at the top. The list contains the job issue and node issue alerts. Within each issue alert is the name of the issue, the timestamp when the issue occurred, a link to the Grafana dashboard for that issue, and a brief summary that describes the issue. |
There was a problem hiding this comment.
| The **All Issues** list all issues that occurs during the run in chronological order, with the most recent issue at the top. The list contains the job issue and node issue alerts. Within each issue alert is the name of the issue, the timestamp when the issue occurred, a link to the Grafana dashboard for that issue, and a brief summary that describes the issue. | |
| **All Issues** lists all issues that occur during the run in chronological order, with the most recent issue at the top. The list contains the job issue and node issue alerts. Each issue alert includes the issue name, the timestamp of the issue, a link to the Grafana dashboard for that issue, and a brief summary. |
| </Frame> | ||
|
|
||
| You can set the x-axis of a line plot to any value that you have logged with W&B.log as long as it's always logged as a number. | ||
| Set the x-axis to any value logged with `wandb.log()` as a number. |
There was a problem hiding this comment.
What does ...as a number." mean? I think an example and/or word smithing might help.
We can rewrite this as "Set the coordinates of the x-axis to any value logged with wandb.Run.log(). Or "Set the range of the x-axis to any integer or float value you logged with wandb.Run.log(). For example, ...."
| Rescale the plot to exclude outliers from the default plot min and max scale. The setting's impact depends on the plot's sampling mode: | ||
|
|
||
| Y range default is from the smallest value of your metrics and zero to the largest value of your metrics. | ||
| * **Random sampling mode**: When enabled, only points from 5% to 95% are shown. Outliers are not formatted differently from other points when shown. |
There was a problem hiding this comment.
+1 Let's ask someone from Eng to verify.
| Example: | ||
|
|
||
| ## Ignore outliers | ||
| `${run:displayName} - ${config:dropout}` produces a legend name like `royal-sweep - 0.5`, where `royal-sweep` is the run name and `0.5` is the config parameter named `dropout`. |
There was a problem hiding this comment.
Add a sentence describing how they'd do this. As is, I have no idea where'd I add the above...
There was a problem hiding this comment.
Sure, but it's the same for all of these sections, right? This page is the reference that goes along with line-plot.mdx the task page. Would you prefer that the two pages be merged?
| Set values inside `[[ ]]` to display point-specific values in the crosshair when hovering over a chart. | ||
|
|
||
| ## Expression | ||
| Example: `[[ $x: $y ($original) ]]` displays something like "2: 3 (2.9)" |
There was a problem hiding this comment.
Same applies here. Not sure where I'd see these values..
|
|
||
| ## Edit line plot settings | ||
| <Tip> | ||
| For [runs](/models/runs) that execute on [CoreWeave](https://coreweave.com) infrastructure, [CoreWeave Mission Control](https://www.coreweave.com/mission-control) monitors your compute infrastructure. If an error occurs, W&B populates infrastructure information onto your run's plots in your project's workspace. For details, see [Visualize CoreWeave infrastructure alerts](models/runs.#visualize-coreweave-infrastructure-alerts). |
There was a problem hiding this comment.
Link models/runs.#visualize-coreweave-infrastructure-alerts gave me a 404 on the preview site. is it because the extra . ?
| </Frame> | ||
|
|
||
| ## Area plots | ||
| To use a custom x-axis, log the metric in the same call to `wandb.Run.log()` where you log the y-axis. |
There was a problem hiding this comment.
Add example code snippet showing this? or link to appropriate doc on custom x-axis?
See https://docs.wandb.ai/models/track/log/customize-logging-axes#customize-log-axes
Description
Refactoring ahead of multi-plot metrics docs
add section-specific redirectsTesting
mint dev)mint broken-links)