Skip to content
This repository was archived by the owner on Nov 27, 2024. It is now read-only.

Commit 5bdd4ce

Browse files
committed
added to readme file in example project
1 parent fd795df commit 5bdd4ce

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

OnnxStack.Console/README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,39 @@
1-
Example - Console App
1+
# Example - Console App
2+
3+
## Getting Started
4+
5+
### 1.) Download the required `.onnx` models:
6+
7+
8+
* https://huggingface.co/rocca/swin-ir-onnx
9+
* This is the upscaler model.
10+
* https://huggingface.co/runwayml/stable-diffusion-v1-5
11+
* https://huggingface.co/softwareweaver/InstaFlow-0.9B-Olive-Onnx
12+
* https://huggingface.co/SimianLuo/LCM_Dreamshaper_v7
13+
* https://huggingface.co/softwareweaver/stable-diffusion-xl-base-1.0-Olive-Onnx
14+
15+
Note: Ensure you run ```git lfs install``` before cloning the repository to ensure the models are downloaded correctly.
16+
17+
18+
### 2.) Update the paths in the `appsettings.json` within the `/OnnxStack.Console/` project:
19+
20+
21+
* Update the paths in `appsettings.json` to point to the downloaded models
22+
* If the downloaded model repository does not contain a `Tokenizer` or `Tokenizer2` `.onnx` file, leave the path empty.
23+
* Note: When the path is empty, OnnxStack will use it's own 'built-in' tokenizer called `cliptokenizer.onnx`
24+
* Example with empty path:
25+
```json
26+
{
27+
"Type": "Tokenizer",
28+
"OnnxModelPath": ""
29+
}
30+
```
31+
32+
33+
### FAQ
34+
35+
* **Q:** My `.GIF` is flashing, is it supposed to do this?
36+
* **A:** The `.GIF` area has been deprecated in favor of the 'video' features that are being added. Please ignore this example for now.
37+
38+
39+

0 commit comments

Comments
 (0)