Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adding launchpad page #191

Merged
merged 1 commit into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/model-sections/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
"position": 4,
"link": {
"type": "generated-index",
"description": "Each created models has three main sections: Overview, Reference, and Current. In this document we are thoroughly explaining each of them."
"description": "Each created model includes three main sectionsOverview, Reference, and Current — as well as a summary section called the Launchpad. This document provides an in-depth explanation of each section."
}
}
2 changes: 1 addition & 1 deletion docs/docs/model-sections/current.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 4
---

# Current
Expand Down
25 changes: 25 additions & 0 deletions docs/docs/model-sections/launchpad.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 1
---

# Launchpad
The launchpad provides a dedicated space for summarising existing models.

![Alt text](/img/launchpad/launchpad.png "Launchpad")

It offers a quick overview of key aspects:

- **Data Quality Percentage:** This metric reflects the proportion of columns without anomalies across the current datasets. Anomalies are identified using the Interquartile Range (IQR) method, and the final percentage displayed is the average of each Current’s anomaly-free ratio.
- **Model Quality Percentage:** This metric is calculated using a Bootstrap Test, based on historical metrics (the same grouped by Timestamp) from the Model Quality page for the current dataset. By grouping metrics over time (e.g., Accuracy), we generate multiple instances of the same metric, forming a statistical population. The Bootstrap Test then compares this population with the metric calculated for the Reference dataset, checking if it falls outside the 95% confidence interval. If so, the metric is flagged as “significantly different” between Reference and Current datasets. This process is repeated for each model metric, and the percentage of metrics that pass the test is returned.
- **Drift Detection Percentage:** This percentage represents the ratio of features without drift over the total number of features.

> NOTE: if a metric cannot be computed, the placeholder `--` will be used.

The general **pie chart** represents the averages of each computed percentage across all models.


Additional information appears on the right side:
- **Work in Progress:** This section provides real-time updates on model activities, including ongoing and failed jobs.
- **Alerts:** Here, you’ll find any alerts triggered by the percentages above. When an issue lowers a metric from its ideal 100%, the alert identifies the affected model and component. Clicking the alert takes you to the relevant page for more details.


2 changes: 1 addition & 1 deletion docs/docs/model-sections/overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 1
sidebar_position: 2
---

# Overview
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/model-sections/reference.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 2
sidebar_position: 3
---

# Reference
Expand Down
Binary file added docs/static/img/launchpad/launchpad.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading