Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve HF integration #16

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve HF integration #16

wants to merge 2 commits into from

Conversation

NielsRogge
Copy link

@NielsRogge NielsRogge commented Sep 8, 2024

Hi @feizc,

Thanks for this nice work! I see the weights are already on the hub (nice!) but things like download counts don't work.

This PR aims to improve the HF integration:

  • automatically load the model using from_pretrained (and push it using push_to_hub)
  • track download numbers for your models (similar to models in the Transformers library)
  • have nice model cards on a per-model basis along with appropriate tags (so that people find them when filtering https://huggingface.co/models?pipeline_tag=text-to-audio)
  • perhaps most importantly, leverage safetensors for the weights in favor of pickle.

It leverages the PyTorchModelHubMixin class which allows to inherits these methods.

Usage is as follows:

from model import Flux

# load from hub
model = Flux.from_pretrained("feizhengcong/FluxMusic-small")

# optionally, save locally or push to the hub
model.save_pretrained("...")
model.push_to_hub("your-hf-org-or-username/flux-small")

This means people don't need to manually download a checkpoint first in their local environment, it just loads automatically from the hub.

Would you be interested in this integration?

Kind regards,

Niels

Note

Please don't merge this PR before pushing the model to the hub :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant