feature: upload additional files in run object#1446
Open
uddhavphatak wants to merge 2 commits intoopenml:mainfrom
Open
feature: upload additional files in run object#1446uddhavphatak wants to merge 2 commits intoopenml:mainfrom
uddhavphatak wants to merge 2 commits intoopenml:mainfrom
Conversation
Author
|
Hi, This is my first PR to this repo, should I write test cases as well to support this enhancement addition? |
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
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.
Metadata
Details
What does this PR implement/fix? Explain your changes.
This PR adds first-class support for attaching arbitrary additional files (e.g., ONNX models, binary representations, logs, custom metadata) to an OpenMLRun object and having them uploaded to the OpenML server when the run is published.
The PR introduces:
A new internal storage container:
A public method:
Updated _get_file_elements() so that these files are included in the upload payload sent via _perform_api_call().
This matches the API design discussed in issue #1332 and the extension use-case described in openml-tensorflow@259f356.
Why is this change necessary? What is the problem it solves?
OpenML extensions (e.g., openml-tensorflow, ONNX flow exporters, model provenance modules) need a standard mechanism to attach arbitrary files to a run.
Until now:
-There was no generic user-facing API to upload additional artifacts.
-Extensions had to patch _get_file_elements() or depend on private methods.
This PR introduces a clean, extensible, documented mechanism for extensions and users to attach files to a run without modifying low-level upload code.