add usage notes to readme

This commit is contained in:
Luna 2023-06-10 18:36:18 -03:00
parent faeb1fd7b3
commit c213987859
1 changed files with 26 additions and 1 deletions

View File

@ -12,8 +12,33 @@ score formula:
then average for all posts
system dependencies:
- python3
- [stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui) with the [tagger extension](https://github.com/toriato/stable-diffusion-webui-wd14-tagger)
- [hydrus-dd](https://gitgud.io/koto/hydrus-dd)
```sh
python3 -m venv env
env/bin/pip install -Ur ./requirements.txt
env/bin/python3 ./main.py
# by default, downloads 30 images at page 150 of the default empty query
env/bin/python3 ./main.py download_images
# gets 40 images at page 150 from tag 'rating:questionable'
# you should add more tags to diversify the dataset before calculating scores
env/bin/python3 ./main.py download_images 'rating:questionable' 40 150
# configure interrogators / tagger models
# set sd_webui_address to your stable diffusion webui' address
# set dd_address to hydrus-dd's address
# and set dd_model_name to be something identifiable about the model
# i set it to the md5sum output of my file, to make sure that if the file
# changes back on koto's end, my numbers may be different
cp config.example.json config.json
# fight mode -- run all interrogators against the dataset you've downloaded
env/bin/python3 ./main.py fight
# score mode -- crank the final numbers, generates graphs under plots/ folder
env/bin/python3 ./main.py fight
```