Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow web UI to be ran fully offline #10324

Merged
merged 4 commits into from
May 13, 2023

Conversation

catboxanon
Copy link
Collaborator

@catboxanon catboxanon commented May 12, 2023

Describe what this pull request is trying to achieve.

Closes #10024

This PR allows the web UI to be ran fully offline via two one change.

The 1st change blocks an initial phone-home request that Gradio makes on first import, something that cannot be blocked by setting GRADIO_ANALYTICS_ENABLED to False, and was mentioned here but hasn't been taken care of until now. The text-generation-webui employs this same technique. https://github.com/oobabooga/text-generation-webui/blob/c746a5bd00c39776bec0091a570f3348aa785caa/server.py#L12
Removed per suggestion. Expected to be resolved upstream by gradio-app/gradio#4194

The 2nd change removes the requirement of pulling fonts from Google Fonts, by manually specifying the font list to use for the default Gradio theme, and importing in the font via the frontend CSS from Google Fonts. When attempting to run offline without this modification, in my tests this causes the web UI to hang and never finish loading.

Additional notes and description of your changes

In regards to the frontend: Gradio currently has a hardcoded JS import for iFrame Resizer, something that is was in the works to be removed for Gradio 3.0, but in an offline environment will not cause the UI to hang if it's not loaded, nor does it hamper the UI in any way, as I believe the only purpose this serves is for some workaround on Huggingface Spaces. There is also a hardcoded preconnect for fonts.googleapis.com but that is again something that doesn't prevent the UI from being used offline, only the backend code causes that. While neither of these have a simple method of removal from the code, everything mentioned in this paragraph can easily be blocked by something like uBlock Origin if the user would like to prevent all outbound connections on the webpage itself (assuming there is an active Internet connection).

Environment this was tested in

  • OS: Windows 11
  • Browser: Firefox, Chrome
  • Graphics card: n/a

This request is sent regardless of Gradio analytics being
enabled or not via the env var.
Idea from text-generation-webui.
Allows web UI to (almost) be ran fully offline.
The web UI will hang on load if offline when
these fonts are not manually defined, as it will attempt (and fail)
to pull from Google Fonts.
@akx
Copy link
Collaborator

akx commented May 12, 2023

Ugh, Gradio doing forced telemetry is pretty shitty. I'll try and raise an issue/PR about that (to follow up on gradio-app/gradio#3956)...

EDIT: there we go... gradio-app/gradio#4194

@elcotek
Copy link

elcotek commented May 12, 2023

This is very usefull, i have to thank you!

@Sakura-Luna Sakura-Luna linked an issue May 13, 2023 that may be closed by this pull request
1 task
@AUTOMATIC1111
Copy link
Owner

the font change is painful

firefox_uoz68b5Coq

firefox_hIJ0MhIx6Z

@AUTOMATIC1111
Copy link
Owner

Also the webui.py change does not seem to be necessary to run offline.

@AUTOMATIC1111
Copy link
Owner

I've got it to run offline with bad fonts and online with good fonts by using this code:

    default_theme_args = dict(
        font=["Source Sans Pro", 'ui-sans-serif', 'system-ui', 'sans-serif'],
        font_mono=['IBM Plex Mono', 'ui-monospace', 'Consolas', 'monospace'],
    )

    if theme_name == "Default":
        gradio_theme = gr.themes.Default(**default_theme_args)
    else:
        try:
            gradio_theme = gr.themes.ThemeClass.from_hub(theme_name)
        except Exception as e:
            errors.display(e, "changing gradio theme")
            gradio_theme = gr.themes.Default(**default_theme_args)

And it requires this addition to css:

@import url('https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600&display=swap');

I would merge that into the repo, but not the webui.py change since that does not seem to be needed to make it run offline and redirecting every gradio request to localhost:80 seems barbaric.

@akx
Copy link
Collaborator

akx commented May 13, 2023

I think it'd be better to vendor in the Source Sans Pro font instead of relying on Google Fonts.

@AUTOMATIC1111
Copy link
Owner

Yeah, I thought about it, but ultimately I think this is temporary until gradio fixes the inability to start offline, and adding fonts increases the size of git history by 500kb forever.

webui.py Outdated
Comment on lines 31 to 39
import requests
def gradio_get(url, **kwargs):
kwargs.setdefault('allow_redirects', True)
return requests.api.request('get', 'http://127.0.0.1/', **kwargs)

original_get = requests.get
requests.get = gradio_get
import gradio
requests.get = original_get
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As an aside, this could probably be implemented as something like

Suggested change
import requests
def gradio_get(url, **kwargs):
kwargs.setdefault('allow_redirects', True)
return requests.api.request('get', 'http://127.0.0.1/', **kwargs)
original_get = requests.get
requests.get = gradio_get
import gradio
requests.get = original_get
import requests
from unittest.mock import patch
with patch("requests.request", side_effect=requests.ConnectionError()):
import gradio

@catboxanon
Copy link
Collaborator Author

Made the suggested changes. I'm OK with removing the webui.py change since gradio-app/gradio#4194 should eventually resolve that proper.

@AUTOMATIC1111 AUTOMATIC1111 merged commit 23b62af into AUTOMATIC1111:dev May 13, 2023
AUTOMATIC1111 added a commit that referenced this pull request May 13, 2023
Allow web UI to be ran fully offline
Antonytm added a commit to Antonytm/stable-diffusion-webui-automatic1111 that referenced this pull request Jun 4, 2023
* Autofix Ruff W (not W605) (mostly whitespace)

* Make live previews use JPEG only when the image is lorge enough

* Bump versions to avoid downgrading them

* fix --data-dir for COMMANDLINE_ARGS

move reading of COMMANDLINE_ARGS into paths_internal.py so --data-dir can be properly read

* Set PyTorch version to 2.0.1 for macOS

* launch.py: make git_tag() and commit_hash() work even when WEBUI_LAUNCH_LIVE_OUTPUT

* Get rid of check_run + run_python

* Redirect Gradio phone home request

This request is sent regardless of Gradio analytics being
enabled or not via the env var.
Idea from text-generation-webui.

* Define default fonts for Gradio theme

Allows web UI to (almost) be ran fully offline.
The web UI will hang on load if offline when
these fonts are not manually defined, as it will attempt (and fail)
to pull from Google Fonts.

* update changelog for release

* fix broken prompts from file

* update changelog for release

* Wait for DOMContentLoaded until checking whether localization should be disabled

Refs AUTOMATIC1111#9955 (comment)

* Requested changes

* minor fix

* remove command line option

* Allow bf16 in safe unpickler

* heavily simplify

* move to stable-diffusion tab

* fix for img2img

* Move localization to its own script block and load it first

* Make dump translations work again

* add an option to always refer to lora by filenames
never refer to lora by an alias if multiple loras have same alias or the alias is called none

* fix upscalers disappearing after the user reloads UI

* Merge pull request AUTOMATIC1111#10339 from catboxanon/bf16

Allow bf16 in safe unpickler

* Merge pull request AUTOMATIC1111#10324 from catboxanon/offline

Allow web UI to be ran fully offline

* update readme

* Merge pull request AUTOMATIC1111#10335 from akx/l10n-dis-take-2

Localization fixes

* update readme

* Add/modify CFG callbacks

Required by self-attn guidance extension
https://github.com/ashen-sensored/sd_webui_SAG

* Update script_callbacks.py

* remove output_altered flag from AfterCFGCallbackParams

* updates for AUTOMATIC1111#9256

* Add Tiny AE live preview

* Add live preview mode check

* set up a system to provide extra info for settings elements in python rather than js
add a bit of spacing/styling to settings elements
add link info for token merging

* allow jpeg for extra network preview

* add a bunch of descriptions and reword a lot of settings (sorry, localizers)

* remove auto live previews format option, fix slow PNG generation

* fix model loading twice in some situations

* add a possible fix for 'LatentDiffusion' object has no attribute 'lora_layer_mapping'

* update readme for release

* Add GPU device

Add GPU option to troubleshoot.

* Downgrade Gradio

* Modify pytorch command

* Update bug_report.yml

* fix xyz checkpoint

* launch.py: Don't involve shell for running Python or Git for output

Fixes Linux regression in 451d255

* Revert Gradio version

* Change to extra-index-url

* Minor changes

* Fix extra networks save preview image geninfo

* Add Python version

Many users still use unverified versions of Python and file version-specific issues, often without mentioning version information, making troubleshooting difficult.

* xyz token merging

* Show "Loading..." for extra networks when displaying for the first time

* load extensions' git metadata in parallel to loading the main program to save a ton of time during startup

* update extensions table: show branch, show date in separate column, and show version from tags if available

* add visual progress for extension installation from URL

* suppress ENSD infotext for samplers that don't use it

* add second_order field to sampler config

* restore nqsp in footer that was lost during linting

* add info link for Negative Guidance minimum sigma

* Minor change

* Use ngrok-py library

* Remove max width for model dropdown
Removing the max width for the model dropdown allows the user to see the full name of a model especially when it is long.
Model names are getting more complex and longer and the current width almost always cuts off model names.
If a user leverages folders than it pretty much always cuts off the name...

* Fix remove `textual inversion` prompt

* not clear checkpoints cache when config changes

* add credits

* return live preview defaults to how they were
only download TAESD model when it's needed
return calculations in single_sample_to_image to just if/elif/elif blocks
keep taesd model in its own directory

* Replace state.need_restart with state.server_command + replace poll loop with signal

* Add option for /_stop route (for graceful shutdown)

* Copy s_min_uncond to Processed

Should fix AUTOMATIC1111#10416

* Bump pytorch for AMD Users

So apparently it works now? Before you would get "Pytorch cant use the GPU" but not anymore.

* Fixing webui.sh

If only i proofread what i wrote

* TAESD fix

* simplify single_sample_to_image

* Add basic ESLint configuration for formatting

This doesn't enable any of ESLint's actual possible-issue linting,
but just style normalization based on the Prettier configuration (but without line length limits).

* Add ESLint to CI

* Run `eslint --fix` (and normalize tabs to spaces)

* fix inability to run with --freeze-settings

* Fixed: AUTOMATIC1111#10460

* use a local variable instead of dictionary entry for sd_merge_models in merge model metadata code

* when adding tooltips, do not scan whole document and instead only scan added elements

* Fix typo in syntax

* move some settings to the new Optimization page
add slider for token merging for img2img
rework StableDiffusionProcessing to have the token_merging_ratio field
fix a bug with applying png optimizations for live previews when they shouldn't be applied

* isn't there something you forgot, AUTOMATIC1111#10483?

* use a single function for saving images with metadata both in extra networks and main mode for AUTOMATIC1111#10395

* add options to show/hide hidden files and dirs, and to not list models/files in hidden directories

* add /sdapi/v1/script-info api

* alternative solution to fix styles load when edited by human AUTOMATIC1111#9765 as suggested by akx

* simplify name pattern setting tooltips

* add option to reorder tabs
fix Reload UI not working

* remove some code duplication from AUTOMATIC1111#9348

* option to specify editor height for img2img

* rework AUTOMATIC1111#8863 to work with all img2img tabs

* Error Improvement for install torch

* extend eslint config

* eslint related file edits

* eslint the merged code

* keep old option for ngrok

* python linter fixes

* add --gradio-allowed-path commandline option

* Modify xformers instead of pytorch

* if sd_model is None, do not always try to load it

* add messages about Loras that failed to load to UI

* .change -> .release for hires input

Improves overall UI responsiveness.

* rework hires prompts/sampler code to among other things support different extra networks in first/second pass
rework quoting for infotext items that have commas in them to use json (should be backwards compatible except for cases where it didn't work previously)
add some locals from processing function into the Processing class as fields

* bump gradio

* Reorder variable assignment

* Revert "Merge pull request AUTOMATIC1111#10440 from grimatoma/increaseModelPickerWidth"

This reverts commit 4b07f2f, reversing
changes made to 4071fa4.

* Fix blinking text of hr and scale res

goodbye

* make it possible for scripts to add cross attention optimizations
add UI selection for cross attention optimization

* rework AUTOMATIC1111#10519

* Use name instead of hash in xyz_grid

X/Y/Z grid was still using the old hash, prone to collisions. This changes it to use the name instead.

Should fix AUTOMATIC1111#10521.

* set Navigate image viewer with gamepad option to false by default, by request

* update CHANGELOG

* fix linter issues

* Added the refresh-loras post request

* rewrite uiElementIsVisible

rewrite visibility checking to be more generic/cleaner as well as add functionality to check if the element is scrolled on screen for more intuitive paste-target selection

* Spel chek changelog some

* make links to http://<...>.git git extensions work in the extension tab

* change upscalers to download models into user-specified directory (from commandline args) rather than the default models/<...>

* Apply suggestions from code review

Co-authored-by: Aarni Koskela <[email protected]>

* split visibility method and sort instead

split out the visibility method for pasting and use a sort inside the paste handler to prioritize on-screen fields rather than targeting ONLY on screen fields

* linter fixes

* make it actually work after suggestions

* Add .git-blame-ignore-revs

* Fix ruff lint

* eslintrc: Sort eslint rules

* eslintrc: Use a file-local `global` comment for module

* eslintrc: mark most globals read-only

* eslintrc: enable no-redeclare but with builtinGlobals: false

* Replace args_to_array (and facsimiles) with Array.from

* get_tab_index(): use a for loop with early-exit for performance

* Fix typo "intialize"

* Deduplicate default extra network registration

* Simplify CORS middleware configuration

* Make load_scripts create new runners (removes reload_scripts)

* Refactor validate_tls_options out, fix typo (keyfile was there twice)

* Refactor configure_sigint_handler out

* Refactor configure opts_onchange out

* Note pending PR for app_kwargs

* Refactor gradio auth

* Deduplicate webui.py initial-load/reload code

* Overhaul tests to use py.test

* simplify PR page

* change width/heights slider steps to 64 from 8

* allow hiding buttons in ui-config.json

* calculate hashes for Lora
add lora hashes to infotext
when pasting infotext, use infotext's lora hashes to find local loras for <lora:xxx:1> entries whose hashes match loras the user has

* Use Optional[] to preserve Python 3.9 compatability

* preserve declarations

* extensions clone depth 1

* Update keyboard shortcut instructions for MacOS users in text selection guidance

* Support edit attn shortcut in hires fix prompts

* hiresfix prompt: add classes, update css sel

* Add a couple `from __future__ import annotations`es for Py3.9 compat

* add DPM-Solver++(2M) SDE from new k-diffusion

* Discard penultimate sigma for dpmpp_2m_sde

* --filter=blob:none

Co-Authored-By: Aarni Koskela <[email protected]>
Co-Authored-By: catboxanon <[email protected]>

* revert git describe --always --tags for extensions because it seems to be causing issues

* reworking launch.py: rename

* reworking launch.py: add references to renamed file

* Revert "change width/heights slider steps to 64 from 8"

This reverts commit 9a86932.

* update readme

* fix bad styling for thumbs view in extra networks AUTOMATIC1111#10639

* possible fix for empty list of optimizations AUTOMATIC1111#10605

* update the changelog to mention 1.3.0 version

* fix serving images that have already been saved without temp files function that broke after updating gradio

* fix linter issue for 1.3.0

* add quoting for infotext values that have a colon in them

* Merge pull request AUTOMATIC1111#10785 from nyqui/fix-hires.fix

fix "hires. fix" prompt sharing same labels with txt2img_prompt

* Merge pull request AUTOMATIC1111#10804 from AUTOMATIC1111/fix-xyz-clip

Fix get_conds_with_caching()

* Merge pull request AUTOMATIC1111#10808 from AUTOMATIC1111/fix-disable-png-info

fix disable png info

* fix [Bug]: LoRA don't apply on dropdown list sd_lora AUTOMATIC1111#10880

* add changelog

* assign devices.dtype early because it's needed before the model is loaded

* update readme

* revert default cross attention optimization to Doggettx
make --disable-opt-split-attention command line option work again

* update readme

---------

Co-authored-by: Aarni Koskela <[email protected]>
Co-authored-by: AUTOMATIC1111 <[email protected]>
Co-authored-by: papuSpartan <[email protected]>
Co-authored-by: w-e-w <[email protected]>
Co-authored-by: brkirch <[email protected]>
Co-authored-by: catboxanon <[email protected]>
Co-authored-by: Sakura-Luna <[email protected]>
Co-authored-by: Keith <[email protected]>
Co-authored-by: bobzilladev <[email protected]>
Co-authored-by: grimatoma <[email protected]>
Co-authored-by: Weiming <[email protected]>
Co-authored-by: dennissheng <[email protected]>
Co-authored-by: Baptiste Rajaut <[email protected]>
Co-authored-by: Iheuzio <[email protected]>
Co-authored-by: Kamil Krzyżanowski <[email protected]>
Co-authored-by: ryankashi <[email protected]>
Co-authored-by: Thottyottyotty <[email protected]>
Co-authored-by: anonCantCode <[email protected]>
Co-authored-by: shinshin86 <[email protected]>
@catboxanon catboxanon deleted the offline branch March 4, 2024 23:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Gradio not starting offline, needs external CSS to start webUI
4 participants