Modify README.md

This commit is contained in:
hodanov 2023-07-02 23:08:59 +09:00
parent ecd5d58022
commit 762f28626d

View File

@ -29,13 +29,33 @@ Please see [the documentation of Modal](https://modal.com/docs/guide) for modals
To use the script, execute the below. To use the script, execute the below.
1. git clone the repository. 1. git clone the repository.
2. Create the `.env` file and set a huggingface API token and a model with reference to `.env.example`. 2. Create the `./setup_files/.env` file and set a huggingface API token with reference to `./setup_files/.env.example`.
3. Open the Makefile and set prompts. 3. Copy `./setup_files/config.sample.yml` to `./setup_files/config.yml`
4. Execute `make deploy` command. An application will be deployed to Modal by the command. 4. Open the Makefile and set prompts.
5. Execute `make run` command. 5. Execute `make deploy` command. An application will be deployed to Modal.
6. Execute `make run` command.
Images are generated and output to the `outputs/` directory. Images are generated and output to the `outputs/` directory.
## Directory structure
```
.
├── Makefile
├── README.md
├── sdcli/ # A directory with scripts to run inference.
│   ├── __init__.py
│   ├── outputs/ # Images are outputted this directory.
│   ├── txt2img.py # A script to run txt2img inference.
│   └── util.py
└── setup_files/ # A directory with config files.
├── .env # Secrets manager
├── Dockerfile # To build a base image.
├── config.yml # To set a model, vae and some tools.
├── requirements.txt
└── setup.py # Build an application to deploy on Modal.
```
Thank you. Thank you.
## Author ## Author