feature: get experiment #964
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR introduces the ability to retrieve detailed experiment information via the OpenAPI interface while enhancing the test coverage for workspaces and experiments.
- Adds a new endpoint (get_experiment) and corresponding tests in both the main API and experiment module.
- Adjusts type checks for optional values in tests and updates parameter type annotations.
- Updates the Group API and base API implementations for better response handling and API consistency.
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| test/unit/api/openapi/test_group.py | Updated type validation for workspace names |
| test/unit/api/openapi/test_experiment.py | Added tests for fetching experiment details |
| swanlab/api/openapi/main.py | Introduced get_experiment method and adjusted username assignment |
| swanlab/api/openapi/group.py | Refactored list_workspaces to check response type |
| swanlab/api/openapi/experiment.py | Added get_experiment method to extract required fields |
| swanlab/api/openapi/base.py | Modified post method signature |
kites262
approved these changes
May 8, 2025
SAKURA-CAT
added a commit
that referenced
this pull request
May 12, 2025
* feat(openapi): list workspaces (#961) * feat(openapi): list workspaces * refa(openapi): login logic * docs(openapi): revise * fix(test): no cloud * feat(openapi): auto catch ApiError * Add `get_exp_state` for OpenAPI Add `get_exp_state` for OpenAPI (#963) --------- Co-authored-by: kites262 <kites262@qq.com> * feat(openapi): get experiment (#964) * feature: get experiment * fix some * feat(openapi): get project exps * feat(openapi): types * fix: py<3.8 * refa(openapi): types for ide * feat(openapi): list projects (#966) * feat(openapi): list project * refactor(openapi): list projects with apiresponse type * refactor(openapi): rewrite list comprehension * fix: typo * refa(openapi): general fetch paginated api * fix(openapi): test & default value --------- Co-authored-by: kites262 <kites262@qq.com> * chore: fix desc & comment --------- Co-authored-by: hyYY-1024 <75209465+hyYY-1024@users.noreply.github.com> Co-authored-by: Kaikai <98205900+Kaikaikaifang@users.noreply.github.com> Co-authored-by: CaddiesNew <50736785+Nexisato@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
通过 OpenAPI 开放获取实验信息接口。