Mirrored_Repos/InvokeAI
1
0
Fork 0
mirror of https://github.com/invoke-ai/InvokeAI synced 2024-08-30 20:32:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Mkdocs material (#593)

Browse Source 
* Squashed commit of the following:

commit 82d9c25d9a
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 19:29:11 2022 +0200

    fix branch name in mkdocs-flow

commit 2e276cecc1
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 19:28:35 2022 +0200

    fix theme name

commit 2eb77c1173
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 19:14:42 2022 +0200

    fixed some links and formating in main README

commit 66a7152e48
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 08:58:58 2022 +0200

    trigger mkdocs deployment on main

commit 897cc373ce
Merge: 89da371 3b5a830
Author: Matthias Wild <40327258+mauwii@users.noreply.github.com>
Date:   Wed Sep 14 07:51:23 2022 +0200

    Merge pull request #1 from mauwii/mkdocs

    Mkdocs

commit 3b5a8308eb
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 07:42:56 2022 +0200

    huge update
    I was pretty busy trying to make the Readmes / docs  look good in MkDocs

commit 0b4f5a926f
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 07:41:45 2022 +0200

    update mkdocs config

commit 872172ea70
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 07:33:49 2022 +0200

    added the mkdocs-git-revision-date-plugin

commit eac81bf875
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 06:46:43 2022 +0200

    add  prettier config
    remove markdownlint
    move and rename requirements-mkdocs.txt

commit b36d4cc088
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 02:06:39 2022 +0200

    add dark theme

commit a14f18fede
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 01:38:02 2022 +0200

    update mkdocs flow and config

commit 2764b48693
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 01:15:33 2022 +0200

    add mkdocs workflow

commit 1bd22523b1
Author: mauwii <Mauwii@outlook.de>
Date:   Wed Sep 14 00:57:37 2022 +0200
    I already begun with formating /  revising the sites

* change repository in mkdocs config to lstein

* adapt changes from repos main README.md

* add PR to mkdocs-flow

* update docs/index.md
- removed unecessary headlines
- added instructions how to host the docs locally
- removed TOC since it is already available via MkDocs
- update appearance of the latest changes

* Update appearance of docs/featuers/changelog

* add me to the contributors
and a small cosmetical change to docs/other/CLI.md

Co-authored-by: Lincoln Stein <lincoln.stein@gmail.com>
This commit is contained in:
Matthias Wild 2022-09-15 20:35:22 +02:00 committed by GitHub
parent 60b731e7ab
commit e6011631a1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 73 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.github/workflows/mkdocs-flow.yml vendored
View File

@ -3,6 +3,9 @@ on:
push: push:
branches: branches:
- main - main
pull_request:
branches:
- main
jobs: jobs:
build: build:
name: Deploy docs to GitHub Pages name: Deploy docs to GitHub Pages

26
docs/features/CHANGELOG.md
View File

@ -2,7 +2,7 @@
title: Changelog title: Changelog
--- ---
## v1.13 (in process) ## v1.13 <small>(in process)</small>
- Supports a Google Colab notebook for a standalone server running on Google - Supports a Google Colab notebook for a standalone server running on Google
hardware [Arturo Mendivil](https://github.com/artmen1516) hardware [Arturo Mendivil](https://github.com/artmen1516)
@ -18,7 +18,7 @@ title: Changelog
--- ---
## v1.12 (28 August 2022) ## v1.12 <small>(28 August 2022)</small>
- Improved file handling, including ability to read prompts from standard input. - Improved file handling, including ability to read prompts from standard input.
(kudos to [Yunsaki](https://github.com/yunsaki) (kudos to [Yunsaki](https://github.com/yunsaki)
@ -34,7 +34,7 @@ title: Changelog
--- ---
## v1.11 (26 August 2022) ## v1.11 <small>(26 August 2022)</small>
- NEW FEATURE: Support upscaling and face enhancement using the GFPGAN module. - NEW FEATURE: Support upscaling and face enhancement using the GFPGAN module.
(kudos to [Oceanswave](https://github.com/Oceanswave)) (kudos to [Oceanswave](https://github.com/Oceanswave))
@ -52,14 +52,14 @@ title: Changelog
--- ---
## v1.10 (25 August 2022) ## v1.10 <small>(25 August 2022)</small>
- A barebones but fully functional interactive web server for online generation - A barebones but fully functional interactive web server for online generation
of txt2img and img2img. of txt2img and img2img.
--- ---
## v1.09 (24 August 2022) ## v1.09 <small>(24 August 2022)</small>
- A new -v option allows you to generate multiple variants of an initial image - A new -v option allows you to generate multiple variants of an initial image
in img2img mode. (kudos to [Oceanswave](https://github.com/Oceanswave). in img2img mode. (kudos to [Oceanswave](https://github.com/Oceanswave).
@ -71,7 +71,7 @@ title: Changelog
--- ---
## v1.08 (24 August 2022) ## v1.08 <small>(24 August 2022)</small>
- Escape single quotes on the dream> command before trying to parse. This avoids - Escape single quotes on the dream> command before trying to parse. This avoids
parse errors. parse errors.
@ -82,7 +82,7 @@ title: Changelog
--- ---
## v1.07 (23 August 2022) ## v1.07 <small>(23 August 2022)</small>
- Image filenames will now never fill gaps in the sequence, but will be assigned - 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 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 <small>(23 August 2022)</small>
- Added weighted prompt support contributed by - Added weighted prompt support contributed by
[xraxra](https://github.com/xraxra) [xraxra](https://github.com/xraxra)
@ -99,7 +99,7 @@ title: Changelog
--- ---
## v1.05 (22 August 2022 - after the drop) ## v1.05 <small>(22 August 2022 - after the drop)</small>
- Filenames now use the following formats: 000010.95183149.png -- Two files - Filenames now use the following formats: 000010.95183149.png -- Two files
produced by the same command (e.g. -n2), 000010.26742632.png -- distinguished 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 - You can use the "cd" and "pwd" commands at the dream> prompt to set and
retrieve the path of the output directory. retrieve the path of the output directory.
## v1.04 (22 August 2022 - after the drop) ## v1.04 <small>(22 August 2022 - after the drop)</small>
- Updated README to reflect installation of the released weights. - Updated README to reflect installation of the released weights.
- Suppressed very noisy and inconsequential warning when loading the frozen CLIP - Suppressed very noisy and inconsequential warning when loading the frozen CLIP
tokenizer. tokenizer.
## v1.03 (22 August 2022) ## v1.03 <small>(22 August 2022)</small>
- The original txt2img and img2img scripts from the CompViz repository have been - The original txt2img and img2img scripts from the CompViz repository have been
moved into a subfolder named "orig_scripts", to reduce confusion. moved into a subfolder named "orig_scripts", to reduce confusion.
## v1.02 (21 August 2022) ## v1.02 <small>(21 August 2022)</small>
- A copy of the prompt and all of its switches and options is now stored in the - 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 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" explore the full metadata. **Please run "conda env update -f environment.yaml"
to load the k_lms dependencies!!** to load the k_lms dependencies!!**
## v1.01 (21 August 2022) ## v1.01 <small>(21 August 2022)</small>
- added k_lms sampling. **Please run "conda env update -f environment.yaml" to - added k_lms sampling. **Please run "conda env update -f environment.yaml" to
load the k_lms dependencies!!** load the k_lms dependencies!!**

4
docs/features/CLI.md
View File

@ -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 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 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): slashes (ick): `C:\\\\path\\\\to\\\\my\\\\file`, or use Linux/Mac style forward slashes (better):
C:/path/to/my/file. `C:/path/to/my/file`.
### List of prompt arguments ### List of prompt arguments

127
docs/index.md
View File

@ -2,6 +2,15 @@
title: Home title: Home
--- ---
<!--
The Docs you find here (/docs/*) are built and deployed via mkdocs. If you want to do so from local it is pretty strait forward:
```bash
pip install -r requirements-mkdocs.txt
mkdocs serve -a localhost:8080
```
-->
<h1 align='center'><b>Stable Diffusion Dream Script</b></h1> <h1 align='center'><b>Stable Diffusion Dream Script</b></h1>
<p align='center'> <p align='center'>
@ -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 [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._ 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 ## Installation
This fork is supported across multiple platforms. You can find individual installation instructions This fork is supported across multiple platforms. You can find individual installation instructions
below. below.
- ### [Linux](installation/INSTALL_LINUX.md) - [Linux](installation/INSTALL_LINUX.md)
- [Windows](installation/INSTALL_WINDOWS.md)
- ### [Windows](installation/INSTALL_WINDOWS.md) - [Macintosh](installation/INSTALL_MAC.md)
- ### [Macintosh](installation/INSTALL_MAC.md)
## Hardware Requirements ## Hardware Requirements
**System** ### System
You wil need one of the following: You wil need one of the following:
- An NVIDIA-based graphics card with 4 GB or more VRAM memory. - An NVIDIA-based graphics card with 4 GB or more VRAM memory.
- An Apple computer with an M1 chip. - An Apple computer with an M1 chip.
**Memory** ### Memory
- At least 12 GB Main Memory RAM. - 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. - 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 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. 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 ### Major Features
- #### [Interactive Command Line Interface](features/CLI.md) - [Interactive Command Line Interface](features/CLI.md)
- [Image To Image](features/IMG2IMG.md)
- #### [Image To Image](features/IMG2IMG.md) - [Inpainting Support](features/INPAINTING.md)
- [GFPGAN and Real-ESRGAN Support](features/UPSCALE.md)
- #### [Inpainting Support](features/INPAINTING.md) - [Seamless Tiling](features/OTHER.md#seamless-tiling)
- [Google Colab](features/OTHER.md#google-colab)
- #### [GFPGAN and Real-ESRGAN Support](features/UPSCALE.md) - [Web Server](features/WEB.md)
- [Reading Prompts From File](features/OTHER.md#reading-prompts-from-a-file)
- #### [Seamless Tiling](features/OTHER.md#seamless-tiling) - [Shortcut: Reusing Seeds](features/OTHER.md#shortcuts-reusing-seeds)
- [Weighted Prompts](features/OTHER.md#weighted-prompts)
- #### [Google Colab](features/OTHER.md#google-colab) - [Variations](features/VARIATIONS.md)
- [Personalizing Text-to-Image Generation](features/TEXTUAL_INVERSION.md)
- #### [Web Server](features/WEB.md) - [Simplified API for text to image generation](features/OTHER.md#simplified-api)
- #### [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 ### Other Features
- #### [Creating Transparent Regions for Inpainting](features/INPAINTING.md#creating-transparent-regions-for-inpainting) - [Creating Transparent Regions for Inpainting](features/INPAINTING.md#creating-transparent-regions-for-inpainting)
- [Preload Models](features/OTHER.md#preload-models)
- #### [Preload Models](features/OTHER.md#preload-models)
## Latest Changes ## Latest Changes
- v1.14 (11 September 2022) ### v1.14 <small>(11 September 2022)</small>
- Memory optimizations for small-RAM cards. 512x512 now possible on 4 GB GPUs. - Memory optimizations for small-RAM cards. 512x512 now possible on 4 GB GPUs.
- Full support for Apple hardware with M1 or M2 chips. - Full support for Apple hardware with M1 or M2 chips.
- Add "seamless mode" for circular tiling of image. Generates beautiful effects. - Add "seamless mode" for circular tiling of image. Generates beautiful effects.
([prixt](https://github.com/prixt)). ([prixt](https://github.com/prixt)).
- Inpainting support. - Inpainting support.
- Improved web server GUI. - Improved web server GUI.
- Lots of code and documentation cleanups. - Lots of code and documentation cleanups.
- v1.13 (3 September 2022 ### v1.13 <small>(3 September 2022</small>
- Support image variations (see [VARIATIONS](features/VARIATIONS.md) - Support image variations (see [VARIATIONS](features/VARIATIONS.md)
([Kevin Gibbons](https://github.com/bakkot) and many contributors and reviewers) ([Kevin Gibbons](https://github.com/bakkot) and many contributors and reviewers)
- Supports a Google Colab notebook for a standalone server running on Google hardware - Supports a Google Colab notebook for a standalone server running on Google hardware
[Arturo Mendivil](https://github.com/artmen1516) [Arturo Mendivil](https://github.com/artmen1516)
- WebUI supports GFPGAN/ESRGAN facial reconstruction and upscaling - WebUI supports GFPGAN/ESRGAN facial reconstruction and upscaling
[Kevin Gibbons](https://github.com/bakkot) [Kevin Gibbons](https://github.com/bakkot)
- WebUI supports incremental display of in-progress images during generation - WebUI supports incremental display of in-progress images during generation
[Kevin Gibbons](https://github.com/bakkot) [Kevin Gibbons](https://github.com/bakkot)
- A new configuration file scheme that allows new models (including upcoming - A new configuration file scheme that allows new models (including upcoming stable-diffusion-v1.5)
stable-diffusion-v1.5) to be added without altering the code. to be added without altering the code. ([David Wager](https://github.com/maddavid12))
([David Wager](https://github.com/maddavid12)) - Can specify --grid on dream.py command line as the default.
- Can specify --grid on dream.py command line as the default. - Miscellaneous internal bug and stability fixes.
- Miscellaneous internal bug and stability fixes. - Works on M1 Apple hardware.
- Works on M1 Apple hardware. - Multiple bug fixes.
- Multiple bug fixes.
For older changelogs, please visit the **[CHANGELOG](features/CHANGELOG.md)**. For older changelogs, please visit the **[CHANGELOG](features/CHANGELOG.md)**.

1
docs/other/CONTRIBUTORS.md
View File

@ -50,6 +50,7 @@ We thank them for all of their time and hard work.
- [Mihai](https://github.com/mh-dm) - [Mihai](https://github.com/mh-dm)
- [Any Winter](https://github.com/any-winter-4079) - [Any Winter](https://github.com/any-winter-4079)
- [Doggettx](https://github.com/doggettx) - [Doggettx](https://github.com/doggettx)
- [Matthias Wild](https://github.com/mauwii)
## __Original CompVis Authors:__ ## __Original CompVis Authors:__