diff --git a/docs/source/_toctree.yml b/docs/source/_toctree.yml index c41db63b..ce40108c 100644 --- a/docs/source/_toctree.yml +++ b/docs/source/_toctree.yml @@ -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 diff --git a/docs/source/convert-weights.md b/docs/source/convert-weights.md new file mode 100644 index 00000000..65c42f0d --- /dev/null +++ b/docs/source/convert-weights.md @@ -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. + + + +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. + +