Skip to content

Add SongBloom as a library #1571

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions packages/tasks/src/model-libraries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1147,6 +1147,13 @@ export const MODEL_LIBRARIES_UI_ELEMENTS = {
countDownloads: `path:"model_vae_fp16.pt"`,
snippets: snippets.threedtopia_xl,
},
songbloom: {
prettyLabel: "SongBloom",
repoName: "SongBloom",
repoUrl: "https://github.com/Cypress-Yang/SongBloom",
filter: false,
countDownloads: `path_extension:"ckpt" OR path_extension:"pt"`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
countDownloads: `path_extension:"ckpt" OR path_extension:"pt"`,
countDownloads: `path:"songbloom_full_150s.pt",

Let's count downloads on a single file to avoid duplicate counting (otherwise, downloading the repo would count a 2 downloads).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We plan to add other versions of the model into the repo, so maybe it should be path_extension:"pt"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We plan to add other versions of the model into the repo, so maybe it should be path_extension:"pt"

If you have several variants of a model, it is highly recommended to upload them as 1 variant == 1 repo. Doing this has several benefits: per-variant download count (to gauge interest for each variation), better discoverability for users, per-variant community tab (for variant-specific questions), easier to document the differences between the models with 1 model card for model, etc. If you have 1 model == 1 repo, it's also recommended to use the same naming convention across repos => if a user fine-tunes one of your model, they can share it in their own repo and follow the same structure. The lineage between models is therefore easier to track (if documented in model cards).

All of this to say, I strongly recommend having 1 file pattern and count downloads based on that one - with 1 model == 1 repo. Note, that this is not a hard constraint and if you feel strongly about it, it's possible to do as you planned (but you loose some benefits listed above)

},
} satisfies Record<string, LibraryUiElement>;

export type ModelLibraryKey = keyof typeof MODEL_LIBRARIES_UI_ELEMENTS;
Expand Down