Skip to content

Conversation

@Bainianzzz
Copy link
Collaborator

Description

获取实验数据和用户管理功能

获取实验数据:

  • 获取项目中实验的元信息
  • 通过expid定位具体实验
  • 根据条件筛选实验
  • 获取实验指标数据

用户管理:

  • 获取用户所有的api_keys
  • 创建一个新的api_key
  • 删除指定的api_key

其他:

  • 恢复了旧版本的OpenApi,以供平滑过渡

@Bainianzzz Bainianzzz requested a review from SAKURA-CAT January 4, 2026 08:49
@Bainianzzz Bainianzzz self-assigned this Jan 4, 2026
@Bainianzzz Bainianzzz added 💪 enhancement New feature or request 🔌 api SwanLab OpenAPI labels Jan 4, 2026
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @Bainianzzz, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly refines the SwanLab API client by introducing a modern Api class, centralizing and expanding functionalities for both experiment data retrieval and user API key management. It provides a more robust and intuitive way for users to programmatically interact with the SwanLab platform, while also ensuring a smooth transition from the older OpenApi by marking it for deprecation.

Highlights

  • New Api Class Introduction: A new swanlab.Api class has been introduced as the primary interface for interacting with the SwanLab API, offering a more structured and powerful set of functionalities.
  • Comprehensive Experiment Data Management: Enhanced capabilities are now available to fetch experiment metadata, locate specific experiments by ID, filter experiments based on various conditions, and retrieve detailed metric data, including historical data with optional pandas DataFrame output.
  • User API Key Management: New functionalities empower users to manage their API keys directly, including listing all existing keys, generating new ones, and deleting specified keys.
  • Deprecation of Old OpenApi: The previous OpenApi implementation has been moved to a separate open_api subpackage and is now marked for deprecation, with a warning issued upon its use to guide users towards the new Api class for a smooth transition.
  • Concurrent Metric Data Fetching: A HistoryPool has been implemented to enable concurrent fetching of experiment metric data, which is expected to improve performance when retrieving large datasets.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a significant refactoring of the SwanLab OpenAPI, deprecating the old OpenApi class and introducing a new, more modular Api class. The new Api class provides enhanced functionalities for managing projects, experiments (runs), and user API keys, including methods to list projects, retrieve individual experiments, and fetch detailed experiment history with concurrent metric data fetching. The changes involve creating new ApiUser, Experiment, and Experiments classes, along with utility functions for data processing and concurrent requests. Review comments highlighted several areas for improvement: the generate_api_key method in ApiUser needed a null check to prevent TypeError if API key creation failed; the delete_api_key method required ensuring the API keys list was always up-to-date to function correctly; the run method's logic for fetching single experiments was identified as inefficient and prone to IndexError if no data was returned, suggesting a check for empty data; and the history method's column renaming logic was deemed overly complex and had a bug when x_axis was None, with a suggestion to simplify it and prevent duplicate keys when x_axis is specified.

- get latest api_keys when user delete api_key
- add return type for the backend interfaces
- simplified get_experiment_metrics() and handle the csv inside HistoryPool
@Bainianzzz Bainianzzz requested a review from SAKURA-CAT January 4, 2026 15:11
@Bainianzzz Bainianzzz requested a review from SAKURA-CAT January 5, 2026 06:58
@Bainianzzz Bainianzzz requested a review from Zeyi-Lin January 5, 2026 13:31
@Bainianzzz Bainianzzz requested a review from SAKURA-CAT January 8, 2026 13:17
Moved the Api class implementation from swanlab/api/api.py to swanlab/api/__init__.py and deleted the redundant api.py file. Updated imports and references accordingly. Minor docstring and comment improvements, and fixed a message in thread.py to reference 'Api' instead of 'OpenApi'.
Combined the import of OpenApi and Api from .api to prevent circular import issues and simplify the export process.
@SAKURA-CAT SAKURA-CAT merged commit e84f819 into feature/open-api Jan 9, 2026
5 checks passed
@SAKURA-CAT SAKURA-CAT deleted the feat/api-runs-user branch January 9, 2026 02:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🔌 api SwanLab OpenAPI 💪 enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants