-
Notifications
You must be signed in to change notification settings - Fork 9
refactor/chore: Removing dataset/benchmark upload functions from Python client #289
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.
By clicking “Sign up for GitHub”, you agree to our terms 8000 of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…hub' functions from Python client
…hmark upload function removals
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added one comment, about some last minute changes to the package. Otherwise, looks good!
@@ -535,335 +528,6 @@ def upload_results( | |||
f"[green]Your result has been successfully uploaded to the Hub. View it here: {result_url}" | |||
) | |||
|
|||
def upload_dataset( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comment
There were some last minute discussions in Notion on that subject. My apologies, I should have updated the package.
To signal these have been deprecated, we want to keep this method (and upload_benchmark
below), but have them raise a new DeprecatedException
.
Removing the version-specific underlying methods is fine, though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noted, thanks! Will do.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks again @danielpeng1! Left one comment about the deprecation warning.
polaris/benchmark/_base.py
Outdated
@@ -167,30 +164,6 @@ def _get_subset(self, indices, hide_targets=True, featurization_fn=None) -> Subs | |||
featurization_fn=featurization_fn, | |||
) | |||
|
|||
def upload_to_hub( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In line with @jstlaurent's point about raising a deprecation warning until we decide to (fully) break backwards compatibility, we should leave the artifact-specific upload_to_hub
functions until we remove the underlying upload_dataset
and upload_benchmark
functions.
The deprecation warning will be raised when/if they are called and we can remove them all together in a later version.
…recatedError for client.py upload_to_hub functions
Changelogs
This PR removes the ability to upload datasets and benchmarks directly from the Python client.
polaris/hub/client.py
:upload_dataset
method_upload_v1_dataset
helper method_upload_v2_dataset
helper methodupload_benchmark
method_upload_v1_benchmark
helper method_upload_v2_benchmark
helper methodpolaris/dataset/_base.py
:upload_to_hub
Checklist:
feature
,fix
,chore
,documentation
ortest
(or ask a maintainer to do it for you).