Skip to content

feat(openapi): get exp summary #978

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
Merged
merged 1 commit into from
May 14, 2025
Merged

feat(openapi): get exp summary #978

merged 1 commit into from
May 14, 2025

Conversation

kites262
Copy link
Member

Description

Add OpenAPI endpoint: Get experiment summary

This OpenAPI provides a summary of metrics for a given experiment, including the maximum and minimum values observed during training when tracked with SwanLab.

e.g:

Get the min value

my_api.get_exp_summary(project=project, exp_cuid=cuid).data.get("loss").get("min").get("value")
"""
0.1745886406861026
"""

Get the max info

my_api.get_exp_summary(project=project, exp_cuid=cuid).data.get("loss").get("max")
"""
"max": {
  "step": 0,
  "value": 0.7108771095136294
}
"""

Related PR: #969

@kites262 kites262 requested a review from SAKURA-CAT May 14, 2025 10:46
@kites262 kites262 force-pushed the feature/openapi-exp-summary branch from 2faf604 to 8d274cf Compare May 14, 2025 10:57
@kites262 kites262 self-assigned this May 14, 2025
@kites262 kites262 mentioned this pull request May 14, 2025
Merged
@Zeyi-Lin
Copy link
Member

Zeyi-Lin commented May 14, 2025 •
edited
Loading

Tested and there were no issues.
BTW, there is a type of interaction to consider whether it is feasible.

import swanlab

my_api = swanlab.OpenApi()
project1 = my_api.get_project(...)
exp1 = project1.get_experiment(...)
exp1.get_metadata()
exp1.get_summary()

@SAKURA-CAT SAKURA-CAT merged commit 8494cef into main May 14, 2025
5 checks passed
@SAKURA-CAT SAKURA-CAT deleted the feature/openapi-exp-summary branch May 14, 2025 14:46
@SAKURA-CAT SAKURA-CAT added the 💪 enhancement New feature or request label May 14, 2025
@kites262
Copy link
Member Author

kites262 commented May 14, 2025 •
edited
Loading

Tested and there were no issues. BTW, there is a type of interaction to consider whether it is feasible.

import swanlab

my_api = swanlab.OpenApi()
project1 = my_api.get_project(...)
exp1 = project1.get_experiment(...)
exp1.get_metadata()
exp1.get_summary()

Feasible, but it may require significant refactoring / architectural discussion.
A ISSUE will be created to consider how to add this feature in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SAKURA-CAT SAKURA-CAT SAKURA-CAT approved these changes

Assignees

@kites262 kites262

Labels
💪 enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kites262 @Zeyi-Lin @SAKURA-CAT