update doc

pull/64/head
butaixianran 2023-03-15 22:33:21 +08:00
parent ca5d2f80e3
commit 66861dc10a
1 changed files with 14 additions and 13 deletions

View File

@ -1,7 +1,6 @@
### Language
[中文](README.cn.md)
[日本語(非公式)](https://economylife.net/civitai-helper-webui-install/)
[日本語(非公式)](https://economylife.net/civitai-helper-webui-install/)
# Notice
After install or update to new version, you need to shutdown SD webui and re-launch. Just Reload UI won't work!
@ -62,14 +61,14 @@ If a model info file already exists, it will be skipped. If a model cannot be fo
When you have some new models, just click scan button again, to get new model's information and preview images. It won't scan the same model twice.
## Model Card
**(Use this only after scanning finished)**
**(Use this only after scanning finished)**
Open SD webui's build-in "Extra Network" tab, to show model cards.
![](img/extra_network.jpg)
Move your mouse on to the bottom of a model card. It will show 4 icon buttons:
- 🖼: Modified "replace preview" text into this icon
- 🖼: Replace preview (a build-in button, modified from text to icon)
- 🌐: Open this model's Civitai url in a new tab
- 💡: Add this model's trigger words to prompt
- 🏷: Use this model's preview image's prompt
@ -93,34 +92,36 @@ To download a model by Civitai Model Page's Url, you need 3 steps:
* Click download.
![](img/download_model.jpg)
Detail will be displayed on console log, with a progress bar.
Downloading can resume from break-point, so no fear for large file.
Detail will be displayed on console log, with a progress bar.
Downloading can resume from break-point, so no fear for large file.
## Checking Model's New Version
You can checking your local model's new version from civitai by model types. You can select multiple model types.
![](img/check_model_new_version.jpg)
The checking process has a "1 second delay" after each model's new version checking request. So it is a little slow.
The checking process has a "1 second delay" after each model's new version checking request. So it is a little slow.
This is to protect Civitai from facing issue like DDos from this extension. Some cloud service provider has a rule as "no more than 1 API request in a second for free user". Civitai doesn't have this rule yet, but we still need to protect it. There is no good for us if it is down.
This is to protect Civitai from issue like DDos from this extension. Some cloud service provider has a rule as "no more than 1 API request in a second for free user". Civitai doesn't have this rule yet, but we still need to protect it. There is no good for us if it is down.
**After checking process done**, it will display all new version's information on UI.
There are 3 urls for each new version.
* First one is model's page.
* First one is model's civitai page.
* Second one is new version's download url.
* Third one is a button to download it into your SD's model folder with python.
With this one, output information is on "Download Model" section's log and console log. One task at a time.
With this one, output information is on "Download Model" section's log and console log. **One task at a time**.
![](img/check_model_new_version_output.jpg)
## Get Model Info By Url
This is used to force a local model link to a Civitai model. For example, you convert a model's format or pruned it, or converted a checkpoint model into a lora. Then it can not be found on civitai when scanning.
This is used to force a local model links to a Civitai model. For example, you converted a model's format or pruned it. Then it can not be found on civitai when scanning.
If a model's SHA256 can not be found in civitai, but you still want to link it to a civitai model. You can use this funcion, choose this model from list, then offer a civitai model page's url you want to link.
In that case, if you still want to link it to a civitai model. You can use this funcion.
After clicking button, extension will download that civitai model's model info for this local model file you picked.
Choose this model from list, then offer a civitai model page's url.
After clicking button, extension will download that civitai model's info and preview image for the local file you picked.
![](img/get_one_model_info.jpg)