guide: detailed plots spec for x and y fields
#4188
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Link Check ReportThere were no links to check! |
shcheklein
approved these changes
Dec 16, 2022
|
Thanks @dberenbaum ! |
jorgeorpinel
added
A: docs
jorgeorpinel
changed the title
x and y fields
|
|
||
| - Plot outputs: column/field name found in the source plots file. | ||
| - **Plot outputs** (_string_): one column/field name. |
| template: confusion | ||
| ``` | ||
|
|
||
| - **Plot outputs** (_string_): one column/field name. |
Comment on lines
+106
to
+119
| If plot ID is an arbitrary string, `x` may either be one column/field name, | ||
| or a dictionary of file paths each mapped to one column/field name (the | ||
| number of column/field names must match the number in `y`). | ||
|
|
||
| ```yaml | ||
| plots: | ||
| - train_val_test: # single x | ||
| y: | ||
| train.csv: [train_acc, val_acc] | ||
| test.csv: test_acc | ||
| x: epoch | ||
| - roc_vs_prc: # x dict | ||
| y: | ||
| precision_recall.json: precision |
There was a problem hiding this comment.
This example is pretty long. Maybe we can summarize? And/or collapse the entire Plots/Available fields section (with <details>). For now
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #4173