Skip to content

Commit

Permalink
[docs] Convert weights (#345)
Browse files Browse the repository at this point in the history
* Create convert-weights.md

* Update _toctree.yml

* convert space option only
  • Loading branch information
stevhliu authored Sep 6, 2023
1 parent 5af8cba commit cc5d941
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/source/_toctree.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
title: Tensor Sharing in Pytorch
- local: metadata_parsing
title: Metadata Parsing
- local: convert-weights
title: Convert weights to safetensors
title: Getting started
- sections:
- local: api/torch
Expand Down
13 changes: 13 additions & 0 deletions docs/source/convert-weights.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Convert weights to safetensors

PyTorch model weights are commonly saved and stored as `.bin` files with Python's [`pickle`](https://docs.python.org/3/library/pickle.html) utility. To save and store your model weights in the more secure `safetensor` format, we recommend converting your weights to `.safetensors`.

The easiest way to convert your model weights is to use the [Convert Space](https://huggingface.co/spaces/diffusers/convert), given your model weights are already stored on the Hub. The Convert Space downloads the pickled weights, converts them, and opens a Pull Request to upload the newly converted `.safetensors` file to your repository.

<Tip warning={true}>

For larger models, the Space may be a bit slower because its resources are tied up in converting other models. You can also try running the [convert.py](https://github.com/huggingface/safetensors/blob/main/bindings/python/convert.py) script (this is what the Space is running) locally to convert your weights.

Feel free to ping [@Narsil](https://huggingface.co/Narsil) for any issues with the Space.

</Tip>

0 comments on commit cc5d941

Please sign in to comment.