gy65896 / OneRestore

[ECCV 2024] OneRestore: A Universal Restoration Framework for Composite Degradation
https://gy65896.github.io/projects/ECCV2024_OneRestore/index.html
80 stars 7 forks source link

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

Open NielsRogge opened 1 month ago

NielsRogge commented 1 month ago

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 🤗

NielsRogge commented 1 month ago

Hi @gy65896, any reason to close this PR?

gy65896 commented 1 month ago

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.