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.

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

Release artifacts (models, datasets) on Hugging Face #9

Closed
NielsRogge opened this issue Sep 28, 2024 · 5 comments
Closed

Release artifacts (models, datasets) on Hugging Face #9

NielsRogge opened this issue Sep 28, 2024 · 5 comments

Comments

@NielsRogge
Copy link

Hi @gy65896,

Niels here from the open-source team at Hugging Face. I discovered your work through ECCV, I indexed your paper: https://huggingface.co/papers/2407.04621. Congrats on getting it accepted! I work together with AK on improving the visibility of researchers' work on the hub.

It'd be great to make the checkpoints and data available on the 🤗 hub, rather than Github, to improve their discoverability/visibility. We can add tags so that people find them when filtering https://huggingface.co/models.

We can then add tags such as "image-to-image" so that people find them at https://huggingface.co/models?pipeline_tag=image-to-image&sort=trending.

Uploading models

See here for a guide: https://huggingface.co/docs/hub/models-uploading.

In this case, we could leverage the PyTorchModelHubMixin class which adds from_pretrained and push_to_hub to any custom nn.Module. Alternatively, one can leverages the hf_hub_download one-liner to download a checkpoint from the hub.

We encourage researchers to push each model checkpoint to a separate model repository, so that things like download stats also work. We can then also link the checkpoints to the paper page.

Uploading dataset

Would be awesome to make the training dataset available on 🤗 , so that people can do:

from datasets import load_dataset

dataset = load_dataset("your-hf-org/your-dataset")

See here for a guide: https://huggingface.co/docs/datasets/image_dataset

Besides that, there's the dataset viewer which allows people to quickly explore the first few rows of the data in the browser.

Let me know if you're interested/need any help regarding this!

Cheers,

Niels
ML Engineer @ HF 🤗

@gy65896 gy65896 closed this as completed Oct 12, 2024
@NielsRogge
Copy link
Author

Hi @gy65896, any reason to close this PR?

@gy65896
Copy link
Owner

gy65896 commented Oct 12, 2024

Thank you for your suggestion. Indeed, I have uplaoded my code in hugging face and I will consider to upload my dataset to this platform.

@gy65896 gy65896 reopened this Oct 12, 2024
@gy65896
Copy link
Owner

gy65896 commented Dec 10, 2024

Hi @gy65896, any reason to close this PR?

Hi @NielsRogge, our demo, code, checkpoints, and datasets are released on hugging face. Thanks for your suggestions.

@gy65896 gy65896 closed this as completed Dec 10, 2024
@NielsRogge
Copy link
Author

Congrats, that's amazing!

Some notes:

This method could also be used inside this Github repo to download checkpoints :)

@NielsRogge
Copy link
Author

I've opened #14 as I've got a suggestion for improvement :)

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

No branches or pull requests

2 participants