Skip to content

is_safetensors_compatible refactor #2499

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.

Sign up for GitHub

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

Jump to bottom
Merged
williamberman merged 3 commits into from
Mar 1, 2023
Merged

is_safetensors_compatible refactor #2499

williamberman merged 3 commits into from
Mar 1, 2023

Conversation

@williamberman
Copy link
Contributor

@williamberman williamberman commented Feb 26, 2023

documented, tested, and refactored is_safetensors_compatible

This is my understanding of the logic from reading the function, please double check it!

@williamberman williamberman force-pushed the is_safetensors_compatible_refactor branch from aae7361 to 70e0d4d Compare February 26, 2023 03:34
@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Feb 26, 2023 •
edited
Loading

The documentation is not available anymore as the PR was closed or merged.

@williamberman williamberman force-pushed the is_safetensors_compatible_refactor branch from 70e0d4d to 2fec244 Compare February 26, 2023 05:45
sayakpaul
sayakpaul reviewed Feb 27, 2023
View reviewed changes
src/diffusers/pipelines/pipeline_utils.py
"""
Checking for safetensors compatibility:
- By default, all models are saved with the default pytorch serialization, so we use the list of default pytorch
files to know which safetensors files are needed.
Copy link
Member

@sayakpaul sayakpaul Feb 27, 2023

Choose a reason for hiding this comment

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

Needed for?

Copy link
Contributor Author

@williamberman williamberman Feb 28, 2023

Choose a reason for hiding this comment

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

needed to qualify as being safetensors compatible

sayakpaul
sayakpaul reviewed Feb 27, 2023
View reviewed changes
src/diffusers/pipelines/pipeline_utils.py Outdated
Comment on lines 136 to 137
- The model is safetensors compatible only if there is a matching safetensors file for at least one default pytorch
file.
Copy link
Member

@sayakpaul sayakpaul Feb 27, 2023

Choose a reason for hiding this comment

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

Where do we look for this mapping? If it cannot be explained in one line, no need to include it then.

Copy link
Contributor

@Narsil Narsil Feb 27, 2023

Choose a reason for hiding this comment

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

at least one

Isn't that all default pytorch files ?

sayakpaul
sayakpaul reviewed Feb 27, 2023
View reviewed changes
Copy link
Member

@sayakpaul sayakpaul left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for doing this.

Maybe @Narsil also wants to give this a look?

Narsil
Narsil reviewed Feb 27, 2023
View reviewed changes
Copy link
Contributor

@Narsil Narsil left a comment

Choose a reason for hiding this comment

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

Looks good.

I was under the assumption diffusers was only using safetensors if all files where available in SF format.

Could be wrong as this seems very deliberate.

Nice PR !

src/diffusers/pipelines/pipeline_utils.py Outdated
Comment on lines 136 to 137
- The model is safetensors compatible only if there is a matching safetensors file for at least one default pytorch
file.
Copy link
Contributor

@Narsil Narsil Feb 27, 2023

Choose a reason for hiding this comment

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

at least one

Isn't that all default pytorch files ?

pcuenca
pcuenca reviewed Feb 27, 2023
View reviewed changes
Copy link
Member

@pcuenca pcuenca left a comment

Choose a reason for hiding this comment

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

I was under the same impression as @Narsil (we only downloaded safetensors if all files were available in safetensors format). Does this PR change that, or am I just confused?

@patrickvonplaten
Copy link
Contributor

patrickvonplaten commented Feb 27, 2023

I think this PR allows combining safetensors and non-safetensors files which is not what we want IMO.

@williamberman
Copy link
Contributor Author

williamberman commented Feb 27, 2023 •
edited
Loading

@pcuenca @patrickvonplaten @Narsil yep, my mistake will fix! #2499 (comment)

@williamberman williamberman force-pushed the is_safetensors_compatible_refactor branch from 2fec244 to ffa6fbb Compare February 28, 2023 00:01
@williamberman
Copy link
Contributor Author

williamberman commented Feb 28, 2023

@pcuenca @patrickvonplaten @Narsil yep, my mistake will fix! #2499 (comment)

Fixed! Sorry for the confusion

Narsil
Narsil approved these changes Feb 28, 2023
View reviewed changes
Copy link
Contributor

@Narsil Narsil left a comment

Choose a reason for hiding this comment

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

LGTM

tests/pipelines/test_pipeline_utils.py Outdated
"safety_checker/model.safetensors",
"vae/diffusion_pytorch_model.bin",
"vae/diffusion_pytorch_model.safetensors",
"text_encoder/pytorch_model.bin" "text_encoder/model.safetensors",
Copy link
Contributor

@Narsil Narsil Feb 28, 2023

Choose a reason for hiding this comment

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

Isn't a comma missing there ?

patrickvonplaten
patrickvonplaten approved these changes Feb 28, 2023
View reviewed changes
Copy link
Contributor

@patrickvonplaten patrickvonplaten left a comment

Choose a reason for hiding this comment

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

Nice refactor, LGTM.

Same comment as Nico though regarding the comma :-)

@williamberman williamberman merged commit 856dad5 into huggingface:main Mar 1, 2023
mengfei25 pushed a commit to mengfei25/diffusers that referenced this pull request Mar 27, 2023
@williamberman @mengfei25
is_safetensors_compatible refactor (huggingface#2499)
f871ac0 
* is_safetensors_compatible refactor

* files list comma
yoonseokjin pushed a commit to yoonseokjin/diffusers that referenced this pull request Dec 25, 2023
@williamberman
is_safetensors_compatible refactor (huggingface#2499)
64a07b3 
* is_safetensors_compatible refactor

* files list comma
AmericanPresidentJimmyCarter pushed a commit to AmericanPresidentJimmyCarter/diffusers that referenced this pull request Apr 26, 2024
@williamberman
is_safetensors_compatible refactor (huggingface#2499)
4521f15 
* is_safetensors_compatible refactor

* files list comma
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sayakpaul sayakpaul sayakpaul left review comments

@patil-suraj patil-suraj Awaiting requested review from patil-suraj

@yiyixuxu yiyixuxu Awaiting requested review from yiyixuxu

@pcuenca pcuenca Awaiting requested review from pcuenca

+2 more reviewers

@Narsil Narsil Narsil approved these changes

@patrickvonplaten patrickvonplaten patrickvonplaten approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@williamberman @HuggingFaceDocBuilderDev @patrickvonplaten @Narsil @pcuenca @sayakpaul