[DOCS-1254] Update docs for Run Comparer#1232
Conversation
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 36.8%, saving 12.36 KB.
437 images did not require optimisation. |
Deploying docs with
|
| Latest commit: |
8cce94f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://ebe52bf8.docodile.pages.dev |
| Branch Preview URL: | https://docs-1254.docodile.pages.dev |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 36.8%, saving 12.36 KB.
437 images did not require optimisation. |
|
updated content looks good to me! i clicked on the preview link though, and saw the old gif, and couldn't see the new image - is that expected? i haven't used this docs preview before 😅 |
I believe I may have fixed this now. What is happening is that in the preview, it is using |
ericakdiaz
left a comment
ericakdiaz
left a comment
There was a problem hiding this comment.
looks good now! thanks for fixing :)
|
@johndmulhausen Can you help figure out why the image still is not working in the preview? It is pointing to |
- Update Hugo config to preview images in PRs correctly
mdlinville
requested review from
ngrayluna
and removed request for
johndmulhausen
| - To copy any configuration or metric's value, hover your mouse over the value, then click the copy button. The entire value is copied, even if it is too long to display on the screen. | ||
|
|
||
| {{% alert %}} | ||
| Run Comparer does not differentiate runs by type. This means that it is possible to compare runs that are not really comparable, like comparing an image run to an audio run. Search, filter, group, or sort the list of runs to limit it to the runs you want to analyze. |
There was a problem hiding this comment.
Runs don't have "types". You can, however, specify a "job_type" when you create a run. See "job_type" in https://docs.wandb.ai/ref/python/init/
| {{% /alert %}} | ||
|
|
||
| Toggle the **diff only** option to hide rows where the values are the same across runs. | ||
| This image compares three image runs with **Diff only** enabled, and filters for configurations that match the string `run`. |
There was a problem hiding this comment.
I don't think we should show this image, example. I think this confuses run names with filtering runs by what they do. For a couple of reasons:
- Run names are normally used for describing the step in the ML. E.g. "training-image
- Normally you wouldn't create runs with the same name. At a minimum, you'd append the run.id to differentiate between runs.
- You can sort runs based on the "job_type" specified when you create a run.
| @@ -1,4 +1,4 @@ | |||
| baseURL: https://docs.wandb.ai | |||
There was a problem hiding this comment.
Please move this to a separate PR for review.
There was a problem hiding this comment.
This was in this PR to work around the broken image in the PR preview. If I were not removing the image based on your feedback, it would make sense to keep it together.
| hugo mod get -u | ||
| rm -rf public | ||
| hugo | ||
| hugo -b $CF_PAGES_URL |
There was a problem hiding this comment.
Please move this to a separate PR for review.
There was a problem hiding this comment.
Ditto here, I'll make that change since I am also removing the image here.
Co-authored-by: Noah Luna <15202580+ngrayluna@users.noreply.github.com>
Moved from #1232 This change updates production.sh to call hugo differently in Cloudflare environments than otherwise. - In Cloudflare, the variable $CF_PAGES_URL tracks the base URL of a PR build or the production deploy and needs to be part of the hugo command. - Locally, this variable is not set so don't try to use it. To help with debugging, log the environment we are building in. ## Tests - [x] Local build works, image shows up correctly - [x] PR build works, image shows up correctly
3 participants
DOCS-1254 Update docs for Run Comparer
Ready for technical review.
Preview: https://docs-1254.docodile.pages.dev/guides/app/features/panels/run-comparer/