Merge pull request #27 from hodanov/feature/update_readme
Update README.md
This commit is contained in:
		
						commit
						b6c9e4aa72
					
				
							
								
								
									
										22
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										22
									
								
								README.md
									
									
									
									
									
								
							@ -2,7 +2,18 @@
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
# Stable Diffusion Modal
 | 
					# Stable Diffusion Modal
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This is the script to execute Stable Diffusion on [Modal](https://modal.com/).
 | 
					This is a Diffusers-based script for running Stable Diffusion on [Modal](https://modal.com/). It can perform txt2img inference and has the ability to increase resolution using ControlNet Tile and Upscaler.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Features
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. Image generation using txt2img
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					2. Upscaling
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					| Before upscaling | After upscaling |
 | 
				
			||||||
 | 
					| ---- | ---- |
 | 
				
			||||||
 | 
					| <img src="assets/20230708204347_1172778945_0_0.png" width="300"> | <img src="assets/20230708204347_1172778945_0_2.png" width="300"> |
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Requirements
 | 
					## Requirements
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -31,11 +42,10 @@ 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 with reference to `.env.example`.
 | 
					2. Copy `./setup_files/config.sample.yml` to `./setup_files/config.yml`
 | 
				
			||||||
3. Copy `./setup_files/config.sample.yml` to `./setup_files/config.yml`
 | 
					3. Open the Makefile and set prompts.
 | 
				
			||||||
4. Open the Makefile and set prompts.
 | 
					4. Execute `make deploy` command. An application will be deployed to Modal.
 | 
				
			||||||
5. Execute `make deploy` command. An application will be deployed to Modal.
 | 
					5. Execute `make run` command.
 | 
				
			||||||
6. Execute `make run` command.
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
Images are generated and output to the `outputs/` directory.
 | 
					Images are generated and output to the `outputs/` directory.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user