showlab / showlab/ActionMap

Release ActionMap checkpoints and dataset on Hugging Face

Open
#1 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Hi @yangpei-comp 🤗

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 in your repository that the full code and weights for ActionMap are "coming soon". It'd be great to make the checkpoints (such as the ActionMap-equipped versions of OpenVLA or $\pi_{0.5}$) and any collected datasets (like the Franka demonstrations mentioned in the paper) available on the 🤗 hub, to improve their discoverability/visibility.
We can add tags (like the robotics tag) 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

If you plan to release the demonstration data, it 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-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!

Cheers,

Niels
ML Engineer @ HF 🤗

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the repository's planned ActionMap checkpoints and collected Franka demonstrations, which the issue says are currently coming soon. Use the Hugging Face model-uploading and dataset-loading guides to determine what artifacts are ready; done means the relevant checkpoints and datasets are published on the Hub and can be downloaded or loaded there.

Written by the indexing model from the issue text.

Assessment

Tech stack
huggingface, python, pytorch
Domain
data, machine-learning, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.