michael/stable-diffusion-webui
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Move comments to scripts.py

Browse source
This commit is contained in:
JashoBell 2022-09-17 12:43:57 -07:00
parent d2c7ad2fec
commit 98a6644bcf
2 changed files with 19 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
modules/scripts.py
View file

@ -13,18 +13,37 @@ class Script:
args_from = None
args_to = None
# The title of the script. This is what will be displayed in the dropdown menu.
def title(self):
raise NotImplementedError()
# How the script is displayed in the UI. See https://gradio.app/docs/#components
# for the different UI components you can use and how to create them.
# Most UI components can return a value, such as a boolean for a checkbox.
# The returned values are passed to the run method as parameters.
def ui(self, is_img2img):
pass
# Determines when the script should be shown in the dropdown menu via the
# returned value. As an example:
# is_img2img is True if the current tab is img2img, and False if it is txt2img.
# Thus, return is_img2img to only show the script on the img2img tab.
def show(self, is_img2img):
return True
# This is where the additional processing is implemented. The parameters include
# self, the model object "p" (a StableDiffusionProcessing class, see
# processing.py), and the parameters returned by the ui method.
# Custom functions can be defined here, and additional libraries can be imported
# to be used in processing. The return value should be a Processed object, which is
# what is returned by the process_images method.
def run(self, *args):
raise NotImplementedError()
# The description method is currently unused.
# To add a description that appears when hovering over the title, amend the "titles"
# dict in script.js to include the script title (returned by title) as a key, and
# your description as the value.
def describe(self):
return ""

17
scripts/custom_code.py
View file

@ -4,38 +4,21 @@ import gradio as gr
from modules.processing import Processed
from modules.shared import opts, cmd_opts, state
# An example custom script that allows you to make modifications to how the model object is handled.
# These scripts appear in the lower-left dropdown menu on the txt2img and img2img tabs.
class Script(scripts.Script):
# The title of the script. This is what will be displayed in the dropdown menu.
def title(self):
return "Custom code"
# Determines when the script should be shown in the dropdown menu via the returned value.
# is_img2img is True if the current tab is img2img, and False if it is txt2img. Thus, return
# is_img2img to only show the script on the img2img tab.
def show(self, is_img2img):
return cmd_opts.allow_code
# How the script's is displayed in the UI. See https://gradio.app/docs/#components
# for the different elements you can use and how to specify them.
# Each UI element can return a value, such as a boolean for a checkbox.
# The returned values are passed to the run method as parameters.
def ui(self, is_img2img):
code = gr.Textbox(label="Python code", visible=False, lines=1)
return [code]
# This is where the additional processing is implemented. The parameters include self, the
# model object (a StableDiffusionProcessing class, see processing.py), and the parameters
# returned by the ui method.
# Custom functions can be defined here, and additional libraries can be imported to be used
# in processing. The return value should be a Processed object, which is what is returned
# by the process_images method.
def run(self, p, code):
assert cmd_opts.allow_code, '--allow-code option must be enabled'