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

Clarify "Load Model" SafeTensors documentation #3028

Merged
merged 1 commit into from
Sep 23, 2024

Conversation

JeremyRand
Copy link
Contributor

The "Load Model" node description inaccurately implied that SafeTensors wasn't supported. This was presumably because the documentation in question was split between two files, and only one was updated.

This PR consolidates the supported file type documentation in one file, so that this bug is less likely to happen again. This also avoids making the description tooltip unwieldily verbose, as would have happened if I had instead edited the description in-place.

Also note in the documentation that SafeTensors should be used for better security, since it's not really reasonable to expect users to read the Spandrel GitHub README to find that.

The "Load Model" node description inaccurately implied that SafeTensors
wasn't supported. This was presumably because the documentation in
question was split between two files, and only one was updated.

This commit consolidates the supported file type documentation in one
file, so that this bug is less likely to happen again. This also avoids
making the description tooltip unwieldily verbose, as would have
happened if I had instead edited the description in-place.

Also note in the documentation that SafeTensors should be used for
better security, since it's not really reasonable to expect users to
read the Spandrel GitHub README to find that.
Copy link
Member

@joeyballentine joeyballentine left a comment

Choose a reason for hiding this comment

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

Great change, thank you for this

@joeyballentine joeyballentine merged commit c859a6a into chaiNNer-org:main Sep 23, 2024
14 checks passed
@JeremyRand JeremyRand deleted the safetensors branch September 23, 2024 14:56
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.

2 participants