Skip to content
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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Hugging Face Hub Upgrades #4231

Merged
merged 10 commits into from
Apr 5, 2024
Merged

Hugging Face Hub Upgrades #4231

merged 10 commits into from
Apr 5, 2024

Conversation

jacobmarks
Copy link
Contributor

@jacobmarks jacobmarks commented Apr 4, 2024 •
edited
Loading

  • Adds preview_path arg to push_to_hub(), allowing for passing a screenshot or video to the dataset card
  • Makes FiftyOne version req optional
  • Improves dataset name resolution
  • Only downloads necessary media files for FiftyOneDataset formatted datasets

How is this patch tested? If it is not, please explain why.

(Details)

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release
    notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

  • App: FiftyOne application changes
  • Build: Build and test infrastructure changes
  • Core: Core fiftyone Python library changes
  • Documentation: FiftyOne documentation changes
  • Other

@jacobmarks jacobmarks requested a review from brimoor April 4, 2024 19:56
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 4, 2024

Important

Auto Review Skipped

Auto reviews are disabled on base/target branches other than the default branch. Please add the base/target branch pattern to the list of additional branches to be reviewed in the settings.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

brimoor
brimoor requested changes Apr 4, 2024
View reviewed changes
Copy link
Contributor

@brimoor brimoor left a comment

Choose a reason for hiding this comment

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

@jacobmarks generally LGTM, just a couple small comments before merging

fiftyone/utils/huggingface.py Show resolved Hide resolved
fiftyone/utils/huggingface.py Outdated
"tags": tags,
}

if min_fiftyone_version is not None:
if not _validate_fiftyone_version(min_fiftyone_version):
Copy link
Contributor

Choose a reason for hiding this comment

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

I would recommend removing this validation as version numbers could actually contain letters and stuff (not usual, but could, eg release candidates).

How about just providing an example in the docstring?

        min_fiftyone_version (None): the minimum version of FiftyOne required,
            if applicable. For example ``"0.23"``

@jacobmarks jacobmarks requested a review from brimoor April 4, 2024 22:12
brimoor
brimoor approved these changes Apr 5, 2024
View reviewed changes
Copy link
Contributor

@brimoor brimoor left a comment

Choose a reason for hiding this comment

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

Very nice! Left one comment for your consideration 😄

fiftyone/utils/huggingface.py Outdated

dataset_type_name = config._format.strip()

if dataset_type_name == "FiftyOneDataset":
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it make sense to download the images separately only if max_samples was provided?

I'm wondering if this might be less efficient:

hfh.snapshot_download(**init_download_kwargs, allow_patterns=[very, long, list, of patterns])

than this:

hfh.snapshot_download(**init_download_kwargs)

@jacobmarks jacobmarks merged commit 1179d9a into hf-hub-integration-v2 Apr 5, 2024
@jacobmarks jacobmarks deleted the hf-hub-upgrades branch April 5, 2024 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brimoor brimoor brimoor approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jacobmarks @brimoor