Release research artifacts (dataset, checkpoints) on Hugging Face

[NielsRogge]

Hi @jeffacce,

Niels here from the open-source team at Hugging Face. I discovered your work as it got featured on AK's daily papers: https://huggingface.co/papers/2409.12192. The paper page lets people discuss the paper, and discover its artifacts (such as models, dataset, a demo in the form of a 🤗 Space).

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

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 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 🤗

[jeffacce]

Hi Niels,

Sounds great! I'll look at this and let you know if I have any questions. Thanks!

Best,
Jeff