1
0
Fork 0

fix(docs): add usage instructions to pre-converted models

This commit is contained in:
Sean Sube 2023-12-21 22:09:42 -06:00
parent 99161c42de
commit 1f778abd69
Signed by: ssube
GPG Key ID: 3EED7B957D362AF1
1 changed files with 38 additions and 8 deletions

View File

@ -1,13 +1,43 @@
# MODEL TITLE # MODEL TITLE
This is a copy of MODEL TITLE converted to the ONNX format for use with tools that use ONNX models, This is a copy of MODEL TITLE converted to the ONNX format for use with tools that use ONNX models, such as
such as https://github.com/ssube/onnx-web. If you have questions about using this model, please see https://github.com/ssube/onnx-web. If you have questions about using this model, please see
https://github.com/ssube/onnx-web/blob/main/docs/user-guide.md#pre-converted-models. https://github.com/ssube/onnx-web/blob/main/docs/user-guide.md#pre-converted-models.
As a derivative of MODEL TITLE, the model files that came with this README are licensed under the As a derivative of MODEL TITLE, the model files that came with this README are licensed under the terms of TODO. A copy
terms of TODO. A copy of the license was included in the archive. Please make sure to read and follow of the license was included in the archive. Please make sure to read and follow the terms before you use this model or
the terms before you use this model or redistribute these files. redistribute these files.
If you are the author of this model and have questions about ONNX models or would like to have If you are the author of this model and have questions about ONNX models or would like to have this model removed from
this model removed from distribution or moved to another site, please contact ssube on distribution or moved to another site, please contact ssube on https://github.com/ssube/onnx-web/issues or
https://github.com/ssube/onnx-web/issues or https://discord.gg/7CdQmutGuw. https://discord.gg/7CdQmutGuw.
## Folder structure
- cnet
- UNet model with ControlNet layers
- LICENSE.txt
- the original model's license
- model_index.json
- links the other models together
- README.txt
- this readme
- scheduler
- scheduler config
- text_encoder
- text encoder model
- tokenizer
- tokenizer config
- unet
- UNet model
- vae_decoder
- VAE decoder model
- vae_encoder
- VAE encoder model
## Adding models
Extract the entire ZIP archive into the models folder of your onnx-web installation and restart the server or click the
Restart Workers button in the web UI and then refresh the page.
Please see https://github.com/ssube/onnx-web/blob/main/docs/user-guide.md#adding-your-own-models for more details.