Make sure Hugging Face download stats work, better discoverability

[NielsRogge]

Dear authors,

Thanks for this nice work! I saw the checkpoints are already pushed to the 🤗 hub which is great: https://huggingface.co/ICTNLP/StreamSpeech_Models/tree/main, however there are a few things that could be improved which will help in making more people discover your models.

• we usually recommend to create a single repository per checkpoint on the hub, this would mean that the streamspeech.offline.de-en.pt checkpoint for instance can be in one repo, then another repo can be created for streamspeech.offline.es-en.pt and so on (all part of your organization on the hub which is https://huggingface.co/ICTNLP).
• the model card is currently empty: https://huggingface.co/ICTNLP/StreamSpeech_Models => we could add appropriate tags to the README like "speech-translation", "speech-to-speech" which enables people to discover your models more easily
• download metrics aren't working so far, since there's no integration with a library yet.

To make download stats work for your models, there are a few options.

• in case your models are regular nn.Module classes, one can leverage the PyTorchModelHubMixin which automatically adds push_to_hub and from_pretrained to your custom PyTorch models, ensuring download stats will work. This also uses safetensors by default rather than pickle to store weights, which is considered safer.
• alternatively, you can also follow this guide to make download stats work: https://huggingface.co/docs/hub/models-download-stats. This allows you to specify a file extension (like *.pt) to track downloads.
• lastly, we also offer some utility methods which allow to load files using a single line of code! e.g.

Usage is as follows:

from huggingface_hub import hf_hub_download
import torch

filepath = hf_hub_download(repo_id="ICTNLP/StreamSpeech_Models", filename="streamspeech.offline.de-en.pt", repo_type="model")
state_dict = torch.load(filepath, map_location="cpu")

We also offer upload_file, upload_folder for pushing to the hub.

Let me know if you need any help!

Kind regards,

Niels
ML Engineer @ HF 🤗