docs: add short description of each pipeline

fboulnois · Feb 17, 2023 · da50be6 · da50be6
1 parent 1f98385
commit da50be6
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -60,6 +60,8 @@ To build:
 
 ### Text-to-Image (`txt2img`)
 
+Create an image from a text prompt.
+
 To run:
 
 ```sh
@@ -68,6 +70,8 @@ To run:
 
 ### Image-to-Image (`img2img`)
 
+Create an image from an existing image and a text prompt.
+
 First, copy an image to the `input` folder. Next, to run:
 
 ```sh
@@ -76,6 +80,8 @@ First, copy an image to the `input` folder. Next, to run:
 
 ### Depth-Guided Diffusion (`depth2img`)
 
+Modify an existing image with its depth map and a text prompt.
+
 First, copy an image to the `input` folder. Next, to run:
 
 ```sh
@@ -85,6 +91,8 @@ First, copy an image to the `input` folder. Next, to run:
 
 ### Instruct Pix2Pix (`pix2pix`)
 
+Modify an existing image with a text prompt.
+
 First, copy an image to the `input` folder. Next, to run:
 
 ```sh
@@ -94,6 +102,8 @@ First, copy an image to the `input` folder. Next, to run:
 
 ### Image Upscaling (`upscale4x`)
 
+Create a high resolution image from an existing image with a text prompt.
+
 First, copy an image to the `input` folder. Next, to run:
 
 ```sh
@@ -103,6 +113,8 @@ First, copy an image to the `input` folder. Next, to run:
 
 ### Diffusion Inpainting (`inpaint`)
 
+Modify specific areas of an existing image with an image mask and a text prompt.
+
 First, copy an image and an image mask to the `input` folder. White areas of the
 mask will be diffused and black areas will be kept untouched. Next, to run: