8000 refactor/chore: Removing dataset/benchmark upload functions from Python client by danielpeng1 · Pull Request #289 · polaris-hub/polaris · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

danielpeng1
Copy link
@danielpeng1 danielpeng1 commented May 13, 2025

Changelogs

This PR removes the ability to upload datasets and benchmarks directly from the Python client.

  • Removed from polaris/hub/client.py:
    • upload_dataset method
    • _upload_v1_dataset helper method
    • _upload_v2_dataset helper method
    • upload_benchmark method
    • _upload_v1_benchmark helper method
    • _upload_v2_benchmark helper method
  • Removed fro 8000 m polaris/dataset/_base.py:
    • Abstract method declaration for upload_to_hub
  • Removed documentation regarding dataset/benchmark upload functionality.

Checklist:

  • Was this PR discussed in an issue? It is recommended to first discuss a new feature into a GitHub issue before opening a PR.
  • Add tests to cover the fixed bug(s) or the newly introduced feature(s) (if appropriate).
  • Update documentation if a new function is added, or an existing one is deleted.
  • Write concise and explanatory changelogs above.
  • If possible, assign one of the following labels to the PR: feature, fix, chore, documentation or test (or ask a maintainer to do it for you).

@danielpeng1 danielpeng1 self-assigned this May 13, 2025
@danielpeng1 danielpeng1 requested a review from cwognum as a code owner May 13, 2025 14:41
@danielpeng1 danielpeng1 added documentation Improvements or additions to documentation chore labels May 13, 2025
Copy link
@j279li j279li left a comment

Choose a reason for hiding this comment

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

Looks good

Copy link
Contributor
@jstlaurent jstlaurent left a 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(
Copy link
Contributor

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.

Copy link
Author

Choose a reason for hiding this comment

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

Noted, thanks! Will do.

Copy link
Contributor
@Andrewq11 Andrewq11 left a 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.

@@ -167,30 +164,6 @@ def _get_subset(self, indices, hide_targets=True, featurization_fn=None) -> Subs
featurization_fn=featurization_fn,
)

def upload_to_hub(
Copy link
Contributor
@Andrewq11 Andrewq11 May 14, 2025

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
0