From dec7d8b16097a28a818c3ac8f0ed4aaba1cc59d2 Mon Sep 17 00:00:00 2001 From: Lincoln Stein Date: Wed, 8 Feb 2023 13:52:02 -0500 Subject: [PATCH] fix up the features/overview document --- docs/features/index.md | 60 +++++++++++++++++++++++++++++++++++++- docs/installation/index.md | 13 +++++---- 2 files changed, 67 insertions(+), 6 deletions(-) diff --git a/docs/features/index.md b/docs/features/index.md index 42d855c643..69cc972ee0 100644 --- a/docs/features/index.md +++ b/docs/features/index.md @@ -2,4 +2,62 @@ title: Overview --- -Here you can find the documentation for different features. +Here you can find the documentation for InvokeAI's various features. + +## The Basics +### * The [Web User Interface](WEB.md) +Guide to the Web interface. Also see the [WebUI Hotkeys Reference Guide](WEBUIHOTKEYS.md) + +### * The [Unified Canvas](UNIFIED_CANVAS.md) +Build complex scenes by combine and modifying multiple images in a stepwise +fashion. This feature combines img2img, inpainting and outpainting in +a single convenient digital artist-optimized user interface. + +### * The [Command Line Interface (CLI)](CLI.md) +Scriptable access to InvokeAI's features. + +## Image Generation +### * [Prompt Engineering](PROMPTS.md) +Get the images you want with the InvokeAI prompt engineering language. + +## * [Post-Processing](POSTPROCESS.md) +Restore mangled faces and make images larger with upscaling. Also see the [Embiggen Upscaling Guide](EMBIGGEN.md). + +## * The [Concepts Library](CONCEPTS.md) +Add custom subjects and styles using HuggingFace's repository of embeddings. + +### * [Image-to-Image Guide for the CLI](IMG2IMG.md) +Use a seed image to build new creations in the CLI. + +### * [Inpainting Guide for the CLI](INPAINTING.md) +Selectively erase and replace portions of an existing image in the CLI. + +### * [Outpainting Guide for the CLI](OUTPAINTING.md) +Extend the borders of the image with an "outcrop" function within the CLI. + +### * [Generating Variations](VARIATIONS.md) +Have an image you like and want to generate many more like it? Variations +are the ticket. + +## Model Management + +## * [Model Installation](050_INSTALLING_MODELS.md) +Learn how to import third-party models and switch among them. This +guide also covers optimizing models to load quickly. + +## * [Merging Models](MODEL_MERGING.md) +Teach an old model new tricks. Merge 2-3 models together to create a +new model that combines characteristics of the originals. + +## * [Textual Inversion](TEXTUAL_INVERSION.md) +Personalize models by adding your own style or subjects. + +# Other Features + +## * [The NSFW Checker](NSFW.md) +Prevent InvokeAI from displaying unwanted racy images. + +## * [Miscellaneous](OTHER.md) +Run InvokeAI on Google Colab, generate images with repeating patterns, +batch process a file of prompts, increase the "creativity" of image +generation by adding initial noise, and more! \ No newline at end of file diff --git a/docs/installation/index.md b/docs/installation/index.md index 56bc77b0c0..12accf95ca 100644 --- a/docs/installation/index.md +++ b/docs/installation/index.md @@ -15,6 +15,8 @@ See the [troubleshooting section](010_INSTALL_AUTOMATED.md#troubleshooting) of the automated install guide for frequently-encountered installation issues. +## Main Application + 1. [Automated Installer](010_INSTALL_AUTOMATED.md) This is a script that will install all of InvokeAI's essential @@ -44,8 +46,9 @@ install guide for frequently-encountered installation issues. individuals with experience with Docker containers and understand the pluses and minuses of a container-based install. -4. Other Installation Guides -- [PyPatchMatch](installation/060_INSTALL_PATCHMATCH.md) -- [XFormers](installation/070_INSTALL_XFORMERS.md) -- [CUDA and ROCm Drivers](installation/030_INSTALL_CUDA_AND_ROCM.md) -- [Installing New Models](installation/050_INSTALLING_MODELS.md) +## Quick Guides + +* [Installing CUDA and ROCm Drivers](installation/030_INSTALL_CUDA_AND_ROCM.md) +* [Installing XFormers](installation/070_INSTALL_XFORMERS.md) +* [Installing PyPatchMatch](installation/060_INSTALL_PATCHMATCH.md) +* [Installing New Models](installation/050_INSTALLING_MODELS.md)