From 39a422f2e504838a268944ade0dffb8aa39a1748 Mon Sep 17 00:00:00 2001 From: Sean Sube Date: Sat, 4 Feb 2023 17:16:36 -0600 Subject: [PATCH] feat(docs): start a developer guide --- docs/dev-test.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 docs/dev-test.md diff --git a/docs/dev-test.md b/docs/dev-test.md new file mode 100644 index 00000000..e4d21999 --- /dev/null +++ b/docs/dev-test.md @@ -0,0 +1,65 @@ +# Development and Testing + +## Contents + +- [Development and Testing](#development-and-testing) + - [Contents](#contents) + - [Development](#development) + - [API](#api) + - [GUI](#gui) + - [Updating Github Pages](#updating-github-pages) + - [Testing](#testing) + - [Pre-Release Test Plan](#pre-release-test-plan) + +## Development + +### API + +- TODO: testing +- TODO: lint/style + +### GUI + +Run `make ci` to build the bundle. + +#### Updating Github Pages + +Checkout the `gh-pages` branch and run the `copy-bundle.sh` script, assuming you have the project +checked out to a directory named `onnx-web`. + +You can also clone the GH pages branch into its own directory to avoid switching between them. + +## Testing + +### Pre-Release Test Plan + +This is the test plan for manual pre-release testing and should exercise all of the major features. + +- txt2img + - 256x256 with SD v1.5 + - 512x512 with SD v1.5 + - DPM Multi + - Euler A + - 768x768 with SD v2.1 +- img2img + - 256x256 input + - 512x512 input + - 1024x768 input +- inpaint + - outpaint + - 256 all sides + - 512 top and bottom, 0 left and right + - 512 left and right, 0 top and bottom +- upscale + - Real ESRGAN + - with face correction + - without face correction + - Stable Diffusion + - with face correction + - without face correction +- interactions + - generate new image + - delete pending image + - delete finished image + - copy to img2img + - copy to inpaint