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.

Sign up for GitHub

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

Jump to bottom

Add examples for the different types of performance metrics #378

Merged
merged 1 commit into from
Jul 10, 2024
Merged

Add examples for the different types of performance metrics #378

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 20 additions & 0 deletions rest_api/static/rest_api/openapi/openapi-schema.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,11 +498,31 @@ components:
class_acc:
type: array
description: "List of Classification Metric data"
example: [
{
"name_long": 'Area Under the Receiver-Operating Characteristic Curve',
"name_short": 'AUROC',
"estimate": 0.63,
"ci_lower": null,
"ci_upper": null,
"se": null
}
]
items:
$ref: '#/components/schemas/Metric'
othermetrics:
type: array
description: "Metrics that do not fit into the Effect Size or Classification Metric categories. e.g. R² (proportion of the variance explained), or reclassification metrics."
example: [
{
"name_long": 'Proportion of the variance explained',
"name_short": 'R2',
"estimate": 0.0011,
"ci_lower": null,
"ci_upper": null,
"se": null
}
]
items:
$ref: '#/components/schemas/Metric'
covariates:
Expand Down
Loading