Skip to content

Commit 188838b

Browse files
docs: expand README run section
1 parent db886d4 commit 188838b

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,40 @@ Tested on macOS with Python 3.11
2121

2222
### Public share
2323
Run with `--share` to get a temporary gradio.live URL.
24+
25+
---
26+
27+
### Penguin Distortion Tester — how to run
28+
29+
[![HF Space](https://img.shields.io/badge/%F0%9F%A4%97%20Spaces-Penguin%20Distortion%20Tester-blue)](https://huggingface.co/spaces/stuck-inadream/penguin-distortion-tester)
30+
31+
#### Local quickstart
32+
```bash
33+
# from repo root
34+
python3.11 -m venv .venv && source .venv/bin/activate
35+
pip install -r requirements.txt
36+
37+
# run (auto-summarize UI, 100k iterations, choose a port)
38+
env PYTHONUNBUFFERED=1 python gradio_demo.py --summary --ckmm-iterations 100000 --server_port 7860
39+
40+
md
41+
42+
---
43+
44+
### Penguin Distortion Tester — how to run
45+
46+
[![HF Space](https://img.shields.io/badge/%F0%9F%A4%97%20Spaces-Penguin%20Distortion%20Tester-blue)](https://huggingface.co/spaces/stuck-inadream/penguin-distortion-tester)
47+
48+
#### Local quickstart
49+
```bash
50+
# from repo root
51+
python3.11 -m venv .venv && source .venv/bin/activate
52+
pip install -r requirements.txt
53+
54+
# run (auto-summarize UI, 100k iterations, choose a port)
55+
env PYTHONUNBUFFERED=1 python gradio_demo.py --summary --ckmm-iterations 100000 --server_port 7860
56+
57+
``` ← closes the code block (type three backticks)
58+
MD ← closes the heredoc
59+
60+
```

0 commit comments

Comments
 (0)