feat: swanlab.save() file uploader

[Nexisato]

Description

• add swanlab.save() api for file upload

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! 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 introduces a significant new feature: the swanlab.save() API, which empowers users to manage and persist important files associated with their experiments. It provides flexible policies for when and how files are saved, from immediate uploads to continuous monitoring of changes. This enhancement improves data integrity and accessibility for experiment artifacts, making it easier to track and reproduce results.

Highlights

• New swanlab.save() API: Introduced a new swanlab.save() API that allows users to save files to their SwanLab runs with configurable policies: 'now' (immediate upload), 'end' (upload at run completion), and 'live' (continuous monitoring and upload).
• File Upload and Monitoring Managers: Implemented FileUploadManager and DirWatcher to handle the complexities of file saving. The FileUploadManager manages file uploads (single-part and multipart) to cloud storage or local copying, while DirWatcher monitors specified files for changes in 'live' policy mode.
• Robust Path Resolution and Validation: Added utilities for resolving glob patterns and base paths, ensuring that files are correctly identified and their relative paths are preserved. Path validation prevents issues with files outside the specified base directory.

🧠 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.

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. ↩

[gemini-code-assist]

Code Review

This pull request introduces a new file saving API, swanlab.save(), which provides a comprehensive mechanism for uploading files associated with an experiment. The implementation is well-structured, featuring support for different saving policies ('now', 'end', 'live'), multipart uploads for large files, and background processing using threads for both uploads and file watching. The code is logically organized into new modules like file_service and save_manager. Overall, this is a solid feature addition. I have identified one high-severity issue concerning memory usage during single-part file uploads, which should be addressed.

[Nexisato]

/gemini review

[gemini-code-assist]

Code Review

This pull request introduces a new swanlab.save() API, enabling users to upload files to the SwanLab backend with support for immediate, end-of-run, or live-monitoring policies. The implementation features a FileUploadManager for handling single and multipart uploads, a DirWatcher for tracking file modifications, and new API endpoints for managing the upload lifecycle. Review feedback suggests enhancing error handling in multipart uploads to ensure consistent state reporting, adding type hints to utility functions, simplifying redundant attribute checks on response objects, and improving logging for failed upload attempts.

[gemini-code-assist]

For better error handling and consistency with _upload_single, consider wrapping the logic of _upload_multipart in a try...except block. Currently, if any part of the multipart upload fails, the exception is caught higher up, but the file is not explicitly marked as FAILED on the backend, unlike in _upload_single. This could lead to an inconsistent state for the file.