diff --git a/Readme.md b/Readme.md index 263a660..2f03be6 100644 --- a/Readme.md +++ b/Readme.md @@ -1,23 +1,60 @@ -TRT- Patch from -Modified for Linux by estro +This `api.py` file has some additional modifications that can be activated within the api.py file. -Copy files from `modules` folder into your `modules` folder. replace existing files. +This file replaces `modules/api/api.py` . -Original files for restoring can be found in the `#Original` folder +::: error +Don't overwrite your original `api.py` file. Rename it to something different like `api_original.py` and then copy the modified `api.py` into your `modules/api` folder. -Copy `api.py` from the previous folder into `modules/api` and enable `eris_TRTpatch` or `eris_imagelimit` +::: + +A clean, original[ ](http://api.py)`api.py` file can be found in the `#Original API File` folder + +After replacing the file you will need to restart your A1111 Stable-diffusion to apply the changes. + +The modified API.py file can do the following: + +1. Eris Promptlog: + - Every Prompt that is send from through the API will be saved in a Textfile, with the current date as name, in a folder named "logs" +2. Eris Imagelog: + - Every generated Images will be saved in the default "outputs" folder +3. Eris Consolelog: + - Every Prompt that is send from through the API will be displayed in the console/terminal window +4. Eris TRTpatch: + - Necessary modification for the TRT Plugin to work. + - Please read the Readme in the `TRT-Patch` folder for the additional instructions +5. Eris Imagelimit: + - Will resize and limit every request down to 1024px max on height and width, keeping the aspect ratio. Also reduces Steps down to 35 if the set Steps exceeds 35 + - Compatible with TRTpatch. Please read the Readme in the `TRT-Patch` folder for the additional instructions + +# Enabling the Modifications + +To enable any of these modifications open the `api.py` file with an text editor and go to line 61. Alternatively you can search for `# Eris modifier switches` to find the correct place. + +There you should now see the following: + +```python +eris_promtlog = False +eris_imagelog = False +eris_consolelog = False +eris_TRTpatch = False +eris_imagelimit = False +``` + +Change the `False` to `True` to enable any of the modifications. + +For example to enable the Promptlog and Imagelog: + +```python +eris_promtlog = True +eris_imagelog = True +eris_consolelog = False +eris_TRTpatch = False +eris_imagelimit = False +``` + +Don't forget to save the `api.py` file again and (re)start your A1111 Stable-difussion ::: warn -If you use the TRTpatch with the Imagelimit you will need to create a **__Dynamic Tensor Profile__** with the following settings: - -`min/opt/max batch size: 1` - -`min/opt/max width: 256/576/1024` - -`min/opt/max height: 256/704/1024` - -`min/opt/max tokens: 75/75/500`\` - -Those settings are **__very critical__** to have the TRT Plugin working correctly +Additional and !!**__necessary__**!! Instructions for the TRT-Patch are in the `TRT-Patch` Folder ::: \ No newline at end of file