Skip to content

Commit 7db5d2c

Browse files
luarssvvbandeira
andauthored
[Docs] dashboard and ci docs (#1384)
* dashboard and ci docs --------- Signed-off-by: luarss <[email protected]> Signed-off-by: Vitor Bandeira <[email protected]> Co-authored-by: Vitor Bandeira <[email protected]>
1 parent 845d65e commit 7db5d2c

File tree

6 files changed

+62
-1
lines changed

6 files changed

+62
-1
lines changed

docs/images/comparison.webp

20.2 KB
Loading

docs/images/trends.webp

48.3 KB
Loading

docs/toc.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,18 @@ entries:
3737
- file: user/FAQS.md
3838
title: FAQs
3939

40-
4140
- file: tutorials/TutorialHome
4241
title: Tutorials
4342
entries:
4443
- file: tutorials/FlowTutorial
4544
title: Flow Tutorial
4645
- file: tutorials/Notebooks
4746
title: Running the OpenROAD Flow in Google Colab
47+
48+
- file: user/Flow_QoR_CI.md
49+
title: Flow QoR and CI Metrics
50+
entries:
51+
- file: user/QoRDashboard.md
52+
title: Using the OpenROAD Dashboard to track and analyze QoR
53+
- file: user/Jenkins.md
54+
title: Exploring CI Metrics with Jenkins

docs/user/Flow_QoR_CI.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# OpenROAD QoR and CI Metrics
2+
3+
## OpenROAD Dashboard
4+
5+
The [OpenROAD Dashboard](QoRDashboard.md) provides an easy way to explore
6+
Quality-of-Results (QoR) over time and describes flow-QoR metrics, such as timing, area, power, etc.
7+
8+
## Jenkins CI
9+
10+
We use Jenkins as our continuous integration (CI) tool.
11+
You may use it to find out metrics regarding regression tests.
12+
See more about accessing and taking advantage of our CI [here](Jenkins.md).

docs/user/Jenkins.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Jenkins Continuous Integration
2+
3+
The Jenkins website is at [https://jenkins.openroad.tools/](https://jenkins.openroad.tools/).
4+
For an in-depth tutorial on how to access the CI metrics, please see
5+
the [link](https://docs.google.com/presentation/d/1kWHLjUBFcd0stnDaPNi_pt9WFrrsR7tQ95BGhT1yOvw/)
6+
7+
```{Note}
8+
This document is not static is constantly being updated due to changes
9+
in the functionality of Jenkins.
10+
```

docs/user/QoRDashboard.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Using the OpenROAD Dashboard to track and analyze Quality of Results
2+
3+
The metrics dashboard [(https://dashboard.theopenroadproject.org/)](https://dashboard.theopenroadproject.org/)
4+
is tailored for RTL-to-GDS flow stages, targeting different designs across
5+
various platforms. The dashboard comprises two main pages: the trends
6+
page and the comparison page.
7+
8+
## Trends
9+
10+
The trends page allows users to visualize metric trends through
11+
interactive graphs, enabling the selection of platforms, designs,
12+
and metrics for each platform. This feature aids in tracking the
13+
fluctuations of metrics over time.
14+
15+
![Trends](../images/trends.webp)
16+
17+
## Comparison
18+
19+
The comparison page lets users compare metrics between branches
20+
or commits for a specific platform and its designs. The comparison is
21+
shown as a table showcasing the differences between the
22+
base source and the test source. This page also offers deeper insights,
23+
like the platform summary table that presents statistical trends for
24+
different designs within a platform and a summary table that
25+
provides insights for the set of selected designs, with added
26+
functionality for filtering.
27+
28+
![Comparison](../images/comparison.webp)
29+
30+
These pages combine to create a comprehensive dashboard facilitating
31+
data-driven decision-making and performance optimization in the
32+
design flow.

0 commit comments

Comments
 (0)