Add API document

- Add API Docs & Example
- Refactors
pull/8/head
Haoming 2023-07-11 00:32:29 +08:00
parent 83f193dda4
commit b7ee345fe8
5 changed files with 68 additions and 26 deletions

View File

@ -1,34 +1,39 @@
## v1.3.4 - 2023 Jul.08
- Implement Metadata
### v1.3.4 - 2023 Jul.08
- Implement **Metadata**
## v1.3.3 - 2023 Jul.07
### v1.3.3 - 2023 Jul.07
- Color Wheel now works at (0, 0, 0)
- Style/Randomize/Reset now updates Color Wheel
### v1.3.2 - 2023 Jul.07
- Implement **Color Wheel**
- Finally added `changelog`
### v1.3.1 - 2023 Jul.06
- Bug Fix
## v1.3.2 - 2023 Jul.07
- Implement Color Wheel
### v1.3.0 - 2023 Jul.06
- Implement **Style Presets**
- Separate logics into different scripts
## v1.3.1 - 2023 Jul.06
- Bug Fix
## v1.3.0 - 2023 Jul.06
- Implement Style Presets
### v1.2.1 - 2023 Jul.05
- Add **Randomize** function
- Add **Reset** function
## v1.2.1 - 2023 Jul.05
- Add Reset & Randomize Functions
### v1.2.0 - 2023 Jul.03
- Implement multiple **Noise** algorithms
## v1.2.0 - 2023 Jul.03
- Implement Multiple Noise Functions
### v1.1.3 - 2023 Jun.26
- Automatically refresh outdated Sliders values
## v1.1.3 - 2023 Jun.26
- Automatically Refresh Sliders
## v1.1.2 - 2023 Jun.23
### v1.1.2 - 2023 Jun.23
- Bug Fix
## v1.1.1 - 2023 Jun.22
- Batch Support
### v1.1.1 - 2023 Jun.22
- **Batch** Support
## v1.1.0 - 2023 Jun.21
- X/Y/Z Plot Support
### v1.1.0 - 2023 Jun.21
- **X/Y/Z Plot** Support
## v1.0.0 - 2023 Jun.20
- Extension Released
### v1.0.0 - 2023 Jun.20
- Extension **Released**!

View File

@ -1,7 +1,7 @@
# SD Webui Vectorscope CC
This is an Extension for the [Automatic1111 Webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui), which performs *a kind of* **Offset Noise**[*](#offset-noise-tldr) natively.
> *This Extension is the result of my numerous trial and error[\*](#what-is-under-the-hood)*
> [Sample Images](#sample-images)
## How to Use
After installing this Extension, you will see a new section in both **txt2img** and **img2img** tabs,
@ -145,6 +145,7 @@ refer to the parameters and sample images below and play around with the values.
- You can enable this in the **Infotext** section of the **Settings** tab
- [X] Implement ~~Color Picker~~ Color Wheel
- [ ] Add Support for **Inpaint**
- [X] Add API Docs
<p align="center"><img src="samples/XYZ.jpg" width=768></p>
<p align="center"><code>X/Y/Z Plot Support</code></p>
@ -153,6 +154,12 @@ refer to the parameters and sample images below and play around with the values.
<p align="center">For <b>Randomize</b> in <code>X/Y/Z Plot</code>, the value is used as the random seed<br>
You can refer to the console to see the randomized values</p>
## API
You can use this Extension via [API](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/API) by adding an entry in the `alwayson_scripts` of your payload. An [example](api_example.json) is provided.
The `args` are the sent in the following order:
> `[Enable, Alt, Brightness, Contrast, Saturation, R, G, B, Skip, Process Hires. Fix, Noise Settings]`
## Known Issues
- Does not work with `DDIM` sampler
- Has little effect when used with certain **LoRA**s

29
api_example.json Normal file
View File

@ -0,0 +1,29 @@
{
"prompt": "(masterpiece, best quality), 1girl, solo",
"negative_prompt": "(low quality, worst quality:1.2), EasyNegative, EasyNegativeV2",
"seed": -1,
"sampler_name": "Euler a",
"sampler_index": "euler",
"batch_size": 1,
"steps": 24,
"cfg_scale": 8.5,
"width": 512,
"height": 512,
"alwayson_scripts": {
"Vectorscope CC": {
"args": [
true,
true,
-2.5,
1.25,
1.25,
0.0,
0.0,
0.0,
0.0,
false,
"Straight Abs."
]
}
}
}

View File

@ -6,13 +6,14 @@ onUiLoaded(async () => {
const container = document.getElementById('cc-colorwheel-' + mode)
container.style.height = '200px'
container.style.width = 'auto'
container.querySelector('.float').remove()
container.querySelector('.download').remove()
const wheel = container.getElementsByTagName('img')[0]
wheel.style.width = '100%'
wheel.style.height = '100%'
wheel.style.width = 'auto'
wheel.style.margin = 'auto'
const temp = document.getElementById('cc-temp-' + mode)

View File

@ -61,7 +61,7 @@ class VectorscopeCC(scripts.Script):
xyz_grid.axis_options.extend(extra_axis_options)
def title(self):
return "Vectorscope Color Correction"
return "Vectorscope CC"
def show(self, is_img2img):
return scripts.AlwaysVisible