diff --git a/.github/workflows/mkdocs-flow.yml b/.github/workflows/mkdocs-flow.yml index b34a0c2cda..c4a6365304 100644 --- a/.github/workflows/mkdocs-flow.yml +++ b/.github/workflows/mkdocs-flow.yml @@ -3,6 +3,9 @@ on: push: branches: - main + pull_request: + branches: + - main jobs: build: name: Deploy docs to GitHub Pages diff --git a/docs/features/CHANGELOG.md b/docs/features/CHANGELOG.md index 17cf06b4dd..f50c4f11b8 100644 --- a/docs/features/CHANGELOG.md +++ b/docs/features/CHANGELOG.md @@ -2,7 +2,7 @@ title: Changelog --- -## v1.13 (in process) +## v1.13 (in process) - Supports a Google Colab notebook for a standalone server running on Google hardware [Arturo Mendivil](https://github.com/artmen1516) @@ -18,7 +18,7 @@ title: Changelog --- -## v1.12 (28 August 2022) +## v1.12 (28 August 2022) - Improved file handling, including ability to read prompts from standard input. (kudos to [Yunsaki](https://github.com/yunsaki) @@ -34,7 +34,7 @@ title: Changelog --- -## v1.11 (26 August 2022) +## v1.11 (26 August 2022) - NEW FEATURE: Support upscaling and face enhancement using the GFPGAN module. (kudos to [Oceanswave](https://github.com/Oceanswave)) @@ -52,14 +52,14 @@ title: Changelog --- -## v1.10 (25 August 2022) +## v1.10 (25 August 2022) - A barebones but fully functional interactive web server for online generation of txt2img and img2img. --- -## v1.09 (24 August 2022) +## v1.09 (24 August 2022) - A new -v option allows you to generate multiple variants of an initial image in img2img mode. (kudos to [Oceanswave](https://github.com/Oceanswave). @@ -71,7 +71,7 @@ title: Changelog --- -## v1.08 (24 August 2022) +## v1.08 (24 August 2022) - Escape single quotes on the dream> command before trying to parse. This avoids parse errors. @@ -82,7 +82,7 @@ title: Changelog --- -## v1.07 (23 August 2022) +## v1.07 (23 August 2022) - Image filenames will now never fill gaps in the sequence, but will be assigned the next higher name in the chosen directory. This ensures that the alphabetic @@ -90,7 +90,7 @@ title: Changelog --- -## v1.06 (23 August 2022) +## v1.06 (23 August 2022) - Added weighted prompt support contributed by [xraxra](https://github.com/xraxra) @@ -99,7 +99,7 @@ title: Changelog --- -## v1.05 (22 August 2022 - after the drop) +## v1.05 (22 August 2022 - after the drop) - Filenames now use the following formats: 000010.95183149.png -- Two files produced by the same command (e.g. -n2), 000010.26742632.png -- distinguished @@ -113,18 +113,18 @@ title: Changelog - You can use the "cd" and "pwd" commands at the dream> prompt to set and retrieve the path of the output directory. -## v1.04 (22 August 2022 - after the drop) +## v1.04 (22 August 2022 - after the drop) - Updated README to reflect installation of the released weights. - Suppressed very noisy and inconsequential warning when loading the frozen CLIP tokenizer. -## v1.03 (22 August 2022) +## v1.03 (22 August 2022) - The original txt2img and img2img scripts from the CompViz repository have been moved into a subfolder named "orig_scripts", to reduce confusion. -## v1.02 (21 August 2022) +## v1.02 (21 August 2022) - A copy of the prompt and all of its switches and options is now stored in the corresponding image in a tEXt metadata field named "Dream". You can read the @@ -132,7 +132,7 @@ title: Changelog explore the full metadata. **Please run "conda env update -f environment.yaml" to load the k_lms dependencies!!** -## v1.01 (21 August 2022) +## v1.01 (21 August 2022) - added k_lms sampling. **Please run "conda env update -f environment.yaml" to load the k_lms dependencies!!** diff --git a/docs/features/CLI.md b/docs/features/CLI.md index c6013d9ff8..081af3dbf4 100644 --- a/docs/features/CLI.md +++ b/docs/features/CLI.md @@ -99,8 +99,8 @@ These arguments are deprecated but still work: On Windows systems, you may run into problems when passing the dream script standard backslashed path names because the Python interpreter treats "\" as an escape. You can either double your -slashes (ick): C:\\\\path\\\\to\\\\my\\\\file, or use Linux/Mac style forward slashes (better): -C:/path/to/my/file. +slashes (ick): `C:\\\\path\\\\to\\\\my\\\\file`, or use Linux/Mac style forward slashes (better): +`C:/path/to/my/file`. ### List of prompt arguments diff --git a/docs/index.md b/docs/index.md index c7501cb471..bdde3cabd7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,6 +2,15 @@ title: Home --- + +

Stable Diffusion Dream Script

@@ -25,47 +34,33 @@ _Note: This fork is rapidly evolving. Please use the [Issues](https://github.com/lstein/stable-diffusion/issues) tab to report bugs and make feature requests. Be sure to use the provided templates. They will help aid diagnose issues faster._ -**Table of Contents** - -1. [Installation](#installation) -2. [Hardware Requirements](#hardware-requirements) -3. [Features](#features) -4. [Latest Changes](#latest-changes) -5. [Troubleshooting](#troubleshooting) -6. [Contributing](#contributing) -7. [Contributors](#contributors) -8. [Support](#support) -9. [Further Reading](#further-reading) - ## Installation This fork is supported across multiple platforms. You can find individual installation instructions below. -- ### [Linux](installation/INSTALL_LINUX.md) - -- ### [Windows](installation/INSTALL_WINDOWS.md) - -- ### [Macintosh](installation/INSTALL_MAC.md) +- [Linux](installation/INSTALL_LINUX.md) +- [Windows](installation/INSTALL_WINDOWS.md) +- [Macintosh](installation/INSTALL_MAC.md) ## Hardware Requirements -**System** +### System You wil need one of the following: - An NVIDIA-based graphics card with 4 GB or more VRAM memory. - An Apple computer with an M1 chip. -**Memory** +### Memory - At least 12 GB Main Memory RAM. -**Disk** +### Disk - At least 6 GB of free disk space for the machine learning model, Python, and all its dependencies. -**Note** +### Note If you are have a Nvidia 10xx series card (e.g. the 1080ti), please run the dream script in full-precision mode as shown below. @@ -82,67 +77,53 @@ To run in full-precision mode, start `dream.py` with the `--full_precision` flag ### Major Features -- #### [Interactive Command Line Interface](features/CLI.md) - -- #### [Image To Image](features/IMG2IMG.md) - -- #### [Inpainting Support](features/INPAINTING.md) - -- #### [GFPGAN and Real-ESRGAN Support](features/UPSCALE.md) - -- #### [Seamless Tiling](features/OTHER.md#seamless-tiling) - -- #### [Google Colab](features/OTHER.md#google-colab) - -- #### [Web Server](features/WEB.md) - -- #### [Reading Prompts From File](features/OTHER.md#reading-prompts-from-a-file) - -- #### [Shortcut: Reusing Seeds](features/OTHER.md#shortcuts-reusing-seeds) - -- #### [Weighted Prompts](features/OTHER.md#weighted-prompts) - -- #### [Variations](features/VARIATIONS.md) - -- #### [Personalizing Text-to-Image Generation](features/TEXTUAL_INVERSION.md) - -- #### [Simplified API for text to image generation](features/OTHER.md#simplified-api) +- [Interactive Command Line Interface](features/CLI.md) +- [Image To Image](features/IMG2IMG.md) +- [Inpainting Support](features/INPAINTING.md) +- [GFPGAN and Real-ESRGAN Support](features/UPSCALE.md) +- [Seamless Tiling](features/OTHER.md#seamless-tiling) +- [Google Colab](features/OTHER.md#google-colab) +- [Web Server](features/WEB.md) +- [Reading Prompts From File](features/OTHER.md#reading-prompts-from-a-file) +- [Shortcut: Reusing Seeds](features/OTHER.md#shortcuts-reusing-seeds) +- [Weighted Prompts](features/OTHER.md#weighted-prompts) +- [Variations](features/VARIATIONS.md) +- [Personalizing Text-to-Image Generation](features/TEXTUAL_INVERSION.md) +- [Simplified API for text to image generation](features/OTHER.md#simplified-api) ### Other Features -- #### [Creating Transparent Regions for Inpainting](features/INPAINTING.md#creating-transparent-regions-for-inpainting) - -- #### [Preload Models](features/OTHER.md#preload-models) +- [Creating Transparent Regions for Inpainting](features/INPAINTING.md#creating-transparent-regions-for-inpainting) +- [Preload Models](features/OTHER.md#preload-models) ## Latest Changes -- v1.14 (11 September 2022) +### v1.14 (11 September 2022) - - Memory optimizations for small-RAM cards. 512x512 now possible on 4 GB GPUs. - - Full support for Apple hardware with M1 or M2 chips. - - Add "seamless mode" for circular tiling of image. Generates beautiful effects. - ([prixt](https://github.com/prixt)). - - Inpainting support. - - Improved web server GUI. - - Lots of code and documentation cleanups. +- Memory optimizations for small-RAM cards. 512x512 now possible on 4 GB GPUs. +- Full support for Apple hardware with M1 or M2 chips. +- Add "seamless mode" for circular tiling of image. Generates beautiful effects. + ([prixt](https://github.com/prixt)). +- Inpainting support. +- Improved web server GUI. +- Lots of code and documentation cleanups. -- v1.13 (3 September 2022 +### v1.13 (3 September 2022 - - Support image variations (see [VARIATIONS](features/VARIATIONS.md) - ([Kevin Gibbons](https://github.com/bakkot) and many contributors and reviewers) - - Supports a Google Colab notebook for a standalone server running on Google hardware - [Arturo Mendivil](https://github.com/artmen1516) - - WebUI supports GFPGAN/ESRGAN facial reconstruction and upscaling - [Kevin Gibbons](https://github.com/bakkot) - - WebUI supports incremental display of in-progress images during generation - [Kevin Gibbons](https://github.com/bakkot) - - A new configuration file scheme that allows new models (including upcoming - stable-diffusion-v1.5) to be added without altering the code. - ([David Wager](https://github.com/maddavid12)) - - Can specify --grid on dream.py command line as the default. - - Miscellaneous internal bug and stability fixes. - - Works on M1 Apple hardware. - - Multiple bug fixes. +- Support image variations (see [VARIATIONS](features/VARIATIONS.md) + ([Kevin Gibbons](https://github.com/bakkot) and many contributors and reviewers) +- Supports a Google Colab notebook for a standalone server running on Google hardware + [Arturo Mendivil](https://github.com/artmen1516) +- WebUI supports GFPGAN/ESRGAN facial reconstruction and upscaling + [Kevin Gibbons](https://github.com/bakkot) +- WebUI supports incremental display of in-progress images during generation + [Kevin Gibbons](https://github.com/bakkot) +- A new configuration file scheme that allows new models (including upcoming stable-diffusion-v1.5) + to be added without altering the code. ([David Wager](https://github.com/maddavid12)) +- Can specify --grid on dream.py command line as the default. +- Miscellaneous internal bug and stability fixes. +- Works on M1 Apple hardware. +- Multiple bug fixes. For older changelogs, please visit the **[CHANGELOG](features/CHANGELOG.md)**. diff --git a/docs/other/CONTRIBUTORS.md b/docs/other/CONTRIBUTORS.md index 906b0edf33..78f33d93d1 100644 --- a/docs/other/CONTRIBUTORS.md +++ b/docs/other/CONTRIBUTORS.md @@ -50,6 +50,7 @@ We thank them for all of their time and hard work. - [Mihai](https://github.com/mh-dm) - [Any Winter](https://github.com/any-winter-4079) - [Doggettx](https://github.com/doggettx) +- [Matthias Wild](https://github.com/mauwii) ## __Original CompVis Authors:__