forked from Hyperfoil/Horreum
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added documentation for comparing Datasets. Added content to the Horr…
…eum glossary of terms.
- Loading branch information
1 parent
54a3834
commit befcf30
Showing
7 changed files
with
75 additions
and
1 deletion.
There are no files selected for viewing
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
Binary file added
BIN
+22.1 KB
docs/site/content/en/docs/Tasks/experiment-evaluation/dataset_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+161 KB
docs/site/content/en/docs/Tasks/experiment-evaluation/dataset_selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions
42
docs/site/content/en/docs/Tasks/experiment-evaluation/index.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
title: Dataset Experiment Evaluation | ||
description: Document explaining the use of Experiment Evaluation function in Horreum UI | ||
date: 2024-01-18 | ||
weight: 5 | ||
--- | ||
|
||
## Using the Dataset Experiment Evaluation View | ||
|
||
Using the Experiment evaluation window you can quickly see the values and the relative difference of a Run. | ||
Start by initially loading the Test. Then click the `Dataset list` button. | ||
|
||
{{% imgproc dataset_list Fit "1200x900" %}} Dataset List {{% /imgproc %}} | ||
|
||
Then select the individual Test Run you want to compare with it's Baseline. | ||
|
||
By navigating to the uploaded run Dataset view page you will see a button “Evaluate experiment”. Clicking this button opens a window revealing the comparison result for the current Run and the Baseline Run.. | ||
|
||
{{% imgproc individual_evaluation Fit "1200x900" %}} Individual Evaluation {{% /imgproc %}} | ||
|
||
Results show the values then the percentage difference. | ||
|
||
|
||
## Datasets Comparison View | ||
|
||
Horreum provides multiple Run comparisons in the Dataset Comparison View. We can filter based on the Filter labels defined in the Schema. | ||
|
||
Start by initially loading the Dataset list. Then click the button “Select for comparison”. | ||
|
||
{{% imgproc select_for_comparison Fit "1200x900" %}} Select for comparison {{% /imgproc %}} | ||
|
||
Next the Comparison view is displayed. This is where filters are set. | ||
|
||
{{% imgproc dataset_selection Fit "1200x900" %}} Dataset selection {{% /imgproc %}} | ||
|
||
Select a number of Runs to be compared using the “Add to comparison” button. Then click the “Compare labels”. Displayed next is the Labels Comparison view. | ||
|
||
{{% imgproc multiple_dataset_comparison Fit "1200x900" %}} Multiple Dataset comparison {{% /imgproc %}} | ||
|
||
Displayed here are multiple Datasets. Schema Labels can be expanded to display a bar graph representing each Run. | ||
|
||
In this guide two things were shown. How to compare an individual Dataset. Followed by comparing multiple Datasets. |
Binary file added
BIN
+115 KB
docs/site/content/en/docs/Tasks/experiment-evaluation/individual_evaluation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+95.8 KB
...ite/content/en/docs/Tasks/experiment-evaluation/multiple_dataset_comparison.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+20.9 KB
docs/site/content/en/docs/Tasks/experiment-evaluation/select_for_comparison.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.