Release O3D-SIM artifacts (models, dataset) on Hugging Face

[NielsRogge]

Hi @kumaradityag 🤗

Niels here from the open-source team at Hugging Face. I discovered your work on Arxiv and was wondering whether you would like to submit it to hf.co/papers to improve its discoverability.If you are one of the authors, you can submit it at https://huggingface.co/papers/submit.

The paper page lets people discuss about your paper and lets them find artifacts about it (your models, datasets or demo for instance), you can also claim
the paper as yours which will show up on your public profile at HF, add Github and project page URLs.

I saw on your GitHub repository (https://github.com/Smart-Wheelchair-RRC/o3d-sim) that the instructions to run the code for O3D-SIM will be added soon. That's great news! Once your code and artifacts are ready, it'd be great to make the checkpoints and any generated 3D semantic instance maps 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 any O3D-SIM generated 3D maps or related datasets available on 🤗 , so that people can do:

from datasets import load_dataset

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

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

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 once your code and artifacts are publicly available!

Cheers,

Niels
ML Engineer @ HF 🤗