Skip to main content

References & Milestones

when looking at results, it is important to compare them to a reference. It could to a previous version, results from a benchmark

Comparing versus a reference​

In results pages, QA-Board always compares the commit you selected (labeled new) versus a reference (ref):

A run card of the facade photo: PSNR, SSIM and runtime with their changes against the reference, preset regions of interest, and the new and reference images side by side, zoomed on a window.
The new commit's bar on top, the reference's below; each run is shown against its reference run.

The reference is by default the latest commit from the project's reference branch:

qaboard.yaml
project:
    reference_branch: master
note

Set reference_branch explicitly: when it's missing, the web application uses develop, while the qa CLI (e.g. qa check-bit-accuracy) uses master.

To change the selected new or ref commit, you can edit the commit ID field in the navbar. Hovering Change gives you a menu with other options:

The reference commit's Change menu: a project box, Switch new/reference, Also Select as New, Remove from comparison, then the reference branch main and the shared milestones kd-1.3 and kd-1.2 with their commits.
Switch new and reference, or pick the reference branch's latest commit or a milestone.
tip

Clicking on the branch name in the navbar will select the latest commit on the branch.

Project References​

You can also list in qaboard.yaml other versions as milestones.

qaboard.yaml
project:
    reference_branch: master
    milestones:
    - release/v1.0.0      # tag
    - feature/better-perf # branch
    - e45123a3565         # commit id

Defining Milestones from QA-Board​

Every user can save milestones with the “star” icon in each commit navbar. If needed, you can give them a name and leave notes:

The milestone dialog of the kd-1.3 release commit, opened from the crown next to its hash: Shared on, the label kd-1.3, the notes "int8, per-channel, recalibrated", and the Delete and Save buttons.
A release saved as a shared milestone, with its label and notes.

You'll now be able to select them in the Change menu, and in the sidebar's Milestones menu:

The sidebar's Milestones menu on the detector's commits: the shared milestones kd-1.3 and kd-1.2, each with its branch, commit and author, then a private milestone, entropy-try, on the quant/entropy branch.
Shared milestones for the releases, and a private one.
tip

Milestones can be shared with everybody - or kept private.

  • Shared milestones are saved on the server, and you must be logged-in to create, edit or delete them. Whoever saves a shared milestone becomes one of its owners: after that, only its owners can edit or delete it.
  • Private milestones are saved in your browser.
  • In the milestones menus, you can filter milestones by label, branch, owner or committer.
  • Milestones are kept by the cleanup of old results, and the web application won't delete all the runs of a milestone's batch.

See the user guide on milestones.