update doc

pull/39/head
butaixianran 2023-03-10 17:46:25 +08:00
parent eacdbcd897
commit 67d89cb791
5 changed files with 58 additions and 23 deletions

View File

@ -1,11 +1,12 @@
# Stable-Diffusion-Webui-Civitai-Helper # Stable-Diffusion-Webui-Civitai-Helper
Stable Diffusion Webui 扩展Civitai助手用于更轻松的管理和使用Civitai模型。 Stable Diffusion Webui 扩展Civitai助手用于更轻松的管理和使用Civitai模型。
## 关于版本 [Civitai Url](https://civitai.com/models/16768/civitai-helper-sd-webui-civitai-extension)
最新版本功能更强大但是是实验性质的。如果碰到问题可以去Civitai下载1.2.1老版本: [Civitai Url](https://civitai.com/models/16768/civitai-helper-sd-webui-civitai-extension)
# 功能 # 功能
* 扫描所有模型从Civitai下载模型信息和预览图 * 扫描所有模型从Civitai下载模型信息和预览图
* 通过civitai模型的页面url连接一个本地模型和civitai模型的信息
* 批量检查本地模型在civitai上的新版本
* 修改了内置的"Extra Network"模型卡片,每个卡片增加了如下功能按钮: * 修改了内置的"Extra Network"模型卡片,每个卡片增加了如下功能按钮:
- 🖼: 修改文字"replace preview"为这个图标 - 🖼: 修改文字"replace preview"为这个图标
- 🌐: 在新标签页打开这个模型的Civitai页面 - 🌐: 在新标签页打开这个模型的Civitai页面
@ -20,7 +21,7 @@ Stable Diffusion Webui 扩展Civitai助手用于更轻松的管理和使用Ci
# 使用方法 # 使用方法
## 更新你的SD webui ## 更新你的SD webui
本扩展需要取到 Extra Network的卡片列表id。**这个是2023-02-06才添加到SD webui里面的。** 本扩展需要取到 Extra Network的卡片列表id。**这个是2023-02-06才添加到SD webui里面的。**
所以如果你用的版本比这个早你就需要先更新你的SD Webui 所以如果你用的版本比这个早你就需要先更新你的SD Webui
@ -62,6 +63,29 @@ Stable Diffusion Webui 扩展Civitai助手用于更轻松的管理和使用Ci
每次当Extra Network刷新他都会删除掉额外的修改我们的按钮就会消失。这时你就需要点击`Refresh Civitai Helper`把这些功能添加回去。 每次当Extra Network刷新他都会删除掉额外的修改我们的按钮就会消失。这时你就需要点击`Refresh Civitai Helper`把这些功能添加回去。
## 根据URL获取1个模型信息
如果无法在civitai上找到你的模型的SHA256但你还是希望能把你的模型连接到一个civitai模型你可以在本扩展页面从列表中选择你的模型并提供一个civitai模型页面的url。
点击按钮之后扩展就会下载那个civitai模型的信息作为你这个本地模型的信息使用。
![](img/get_one_model_info.jpg)
## 批量检查模型新版本
你可以按照模型类型批量检查你的本地模型在civitai上的新版本。你可以选择多个模型类型。
![](img/check_model_new_version.jpg)
检查新版本的时候每检查完一个模型都会有一个1秒的延迟所以速度有点慢。
这是为了保护Civitai避免因为本插件而短暂陷入类似DDos的局面。有些云服务商有类似“免费用户每秒API请求不能超过1次”的保护机制。Civitai还没有这种设置。但我们还是得自觉保护它。因为如果它挂了对大家都没有好处。
**检查完毕之后**就会如下图在UI上显示所有找到的新版本的信息。
每个模型新版本都有2个链接。第一个是这个模型的网页。第二个是这个新版本的下载地址。
![](img/check_model_new_version_output.jpg)
## 预览图 ## 预览图
Extra Network支持两种预览图命名`model_name.png` 和 `model_name.preview.png`。其中,`model_name.png`优先级较高。 Extra Network支持两种预览图命名`model_name.png` 和 `model_name.preview.png`。其中,`model_name.png`优先级较高。
@ -87,10 +111,6 @@ civitai不是每个图片都有关键词一个模型中也不是所有预
这些情况下你可以在插件上通过提供模型页面的url来获取模型信息文件。v1.3新功能) 这些情况下你可以在插件上通过提供模型页面的url来获取模型信息文件。v1.3新功能)
## 检查模型新版本
在每一个检查模型新版本的请求之后都会有一个1秒的延迟所以速度有点慢。
这是为了保护Civitai避免因为本插件而短暂陷入类似DDos的局面。有些云服务商有类似“免费用户每秒的API请求不能超过1次”的保护机制。Civitai还没有这种设置。但我们还是得自觉保护它的服务器。因为如果它挂了对大家都没有好处。
## Civitai本身挂掉 ## Civitai本身挂掉

View File

@ -4,21 +4,18 @@
# Stable-Diffusion-Webui-Civitai-Helper # Stable-Diffusion-Webui-Civitai-Helper
Stable Diffusion Webui Extension for Civitai, to handle your models much more easily. Stable Diffusion Webui Extension for Civitai, to handle your models much more easily.
## Notice Civitai: [Civitai Url](https://civitai.com/models/16768/civitai-helper-sd-webui-civitai-extension)
From today(2023-02-10), Civitai is redirecting its API request to Cloudflare's real human checking page. Which makes this extension can not get any information back from civitai.
If you have this issue. You have to wait for civitai updating their API usage. If you don't have this issue, you are luckier than me.
## About Version
Latest version is powerful but experimental. If you have issue, you can go back to 1.2.1 by download old version from Civitai: [Civitai Url](https://civitai.com/models/16768/civitai-helper-sd-webui-civitai-extension)
# Features # Features
* Scans all models to download model information and preview images from Civitai. * Scans all models to download model information and preview images from Civitai.
* Link 1 model to a civitai model by civitai model's url
* Checking all your local model's new version from civitai
* Modified Built-in "Extra Network" cards, to add the following buttons on each card: * Modified Built-in "Extra Network" cards, to add the following buttons on each card:
- 🖼: Modified "replace preview" text into this icon - 🖼: Modified "replace preview" text into this icon
- 🌐: Open this model's Civitai url in a new tab - 🌐: Open this model's Civitai url in a new tab
- 💡: Add this model's trigger words to prompt - 💡: Add this model's trigger words to prompt
- 🏷: Use this model's preview image's prompt - 🏷: Use this model's preview image's prompt
# Install # Install
Go to SD webui's extension tab, go to `Install from url` sub-tab. Go to SD webui's extension tab, go to `Install from url` sub-tab.
@ -55,7 +52,7 @@ 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. 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 ## Model Card
**(Use this only after you scanned your models!)** **(Use this only after scanning finished)**
Open SD webui's build-in "Extra Network" tab, to show model cards. Open SD webui's build-in "Extra Network" tab, to show model cards.
![](img/extra_network.jpg) ![](img/extra_network.jpg)
@ -69,11 +66,34 @@ Move your mouse on to the bottom of a model card. It will show 4 icon buttons:
![](img/model_card.jpg) ![](img/model_card.jpg)
If these additional buttons are not there, click the `Refresh Civitai Helper` button to bring them back. **If these additional buttons are not there**, click the `Refresh Civitai Helper` button to bring them back.
![](img/refresh_ch.jpg) ![](img/refresh_ch.jpg)
Everytime after Extra Network tab refreshed, it will remove all these additional buttons. So, you need to click `Refresh Civitai Helper` button to bring them back. Everytime after Extra Network tab refreshed, it will remove all these additional buttons. So, you need to click `Refresh Civitai Helper` button to bring them back.
## Get 1 Model Info By Url
If a model's SHA256 can not be found in civitai, but you still want to link it to a civitai model. You can choose this model from list, then offer a civitai model page's url you want to link.
After clicking button, extension will download that civitai model's model info for this local model file you picked.
![](img/get_one_model_info.jpg)
## 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.
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.
**After checking process done**, it will display all new version's information on UI.
There are 2 urls for each new version. First one is model's page. Second one is this version's download url.
![](img/check_model_new_version_output.jpg)
## Preview Image ## Preview Image
Extra network uses both `model_file.png` and `model_file.preview.png` as preview image. But `model_file.png` has higher priority, because it is created by yourself. Extra network uses both `model_file.png` and `model_file.preview.png` as preview image. But `model_file.png` has higher priority, because it is created by yourself.
@ -93,18 +113,13 @@ There are 2 cases this hash code can not find the model on civitai:
* Some old models, which do not have SHA256 code on civitai. * Some old models, which do not have SHA256 code on civitai.
* The model's owner changed file on civitai, but does not change version number and description. So, the file on civitai is actually not the one on your manchine. * The model's owner changed file on civitai, but does not change version number and description. So, the file on civitai is actually not the one on your manchine.
In these cases, you can always link a model to civitai by filling its URL in this extension from v1.3. In these cases, you can always link a model to civitai by filling its URL in this extension.
## Checking Model's New Version
It has 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 it yet, but we still need to protect its server. If it is down, then this extension is no good for you anyway.
## Civitai down ## Civitai down
When Civitai is facing some issue like DDos, it gonna put civitai under Cloudflare's protection, which gonna re-direct our API request to a real human checking page. Then this extension can not get any information back. When Civitai is facing some issue like DDos, it gonna put civitai under Cloudflare's protection, which gonna re-direct our API request to a real human checking page. Then this extension can not get any information back.
In that case, juse wait for civitai's recovering. It cloud take 6-8 hours. In that case, juse wait for civitai's recovering. It could take 6-8 hours.
Enjoy! Enjoy!

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 110 KiB

BIN
img/get_one_model_info.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB