TheStinger commited on
Commit
53a960a
β€’
1 Parent(s): 8e93679

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +63 -1
README.md CHANGED
@@ -9,4 +9,66 @@ app_file: app.py
9
  pinned: false
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
  pinned: false
10
  ---
11
 
12
+ ![Ilaria AI Suite](./ilariaaisuite.png)
13
+ ***
14
+ [![Static Badge](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Space-s?labelColor=YELLOW&color=FFEA00)](https://huggingface.co/spaces/TheStinger/Ilaria_Upscaler) [![Static Badge](https://img.shields.io/badge/%F0%9F%A4%97%20HF%20Space-Duplication-s?labelColor=YELLOW&color=FFEA00)](https://huggingface.co/spaces/TheStinger/Ilaria_Upscaler?duplicate=true) [![Static Badge](https://img.shields.io/badge/GitHub-Source%20Code-s?logo=GitHub)](https://github.com/TheStingerX/Ilaria-Upscaler) [![Static Badge](https://img.shields.io/badge/AI%20Hub-Discord%20Server-s?logo=Discord&color=%09%237289da)](https://discord.gg/aihub) [![Static Badge](https://img.shields.io/badge/Ko--Fi-s?logo=Ko-Fi&label=Support%20me%20on&labelColor=434b57&color=FF5E5B)](https://ko-fi.com/ilariaowo)
15
+ ***
16
+ <p align="center">
17
+ <h1>Ilaria Upscaler πŸ’–</h1>
18
+ </p>
19
+
20
+ πŸŽ‰ Welcome to Ilaria Upscaler! πŸŽ‰
21
+
22
+ This project leverages various libraries and modules to create a Graphical User Interface (GUI) for upscaling images.
23
+ It's primarily designed for use with HuggingFace Spaces. πŸ€—
24
+
25
+ Ilaria RVC is part of the Ilaria AI Suite wich includes various easy and powerful tools. πŸ’–
26
+
27
+ ## πŸ“¦ Installation πŸ“¦
28
+
29
+ To use this project, clone the original Space on Hugging Face.
30
+ Make sure you restart it time to time to keep up with the new updates.
31
+
32
+ ## πŸ–₯️ Usage πŸ–₯️
33
+
34
+ Once the dependencies are installed automatically, Hugging Face will use app.py to start the user interface.
35
+ From there, you can utilize the various features of the project.
36
+
37
+ ## 🌟 Features 🌟
38
+
39
+ Ilaria RVC offers a range of features, including:
40
+
41
+ - πŸ–ΌοΈ **Image Upscaling and Restoration**:
42
+ Ilaria Upscaler uses the RealESRGANer class from the realesrgan module to upscale and restore images.
43
+ It supports multiple models, each with different scales and architectures, providing flexibility in the upscaling process.
44
+
45
+ - πŸŽ›οΈ **Adjustable Parameters**:
46
+ The realesrgan function allows users to adjust various parameters such as the model name, denoise strength, face enhancement, and output scale.
47
+ This provides a high level of customization to fit different use cases.
48
+
49
+ - πŸ–₯️ **User-Friendly Web Interface**:
50
+ Ilaria Upscaler The code uses the gradio module to create an intuitive web interface.
51
+ Users can easily upload an image, and the application will return the upscaled and restored image.
52
+
53
+ - πŸ“‚ **Efficient File Handling**:
54
+ The code uses the os and basicsr.utils.download_util modules for efficient file handling operations.
55
+ It checks if the model file exists in the local directory, and if not, it downloads the file from the specified URL.
56
+
57
+ - πŸ‘© **Face Enhancement Option**:
58
+ If the face_enhance parameter is set to True, the code uses the GFPGANer class from the gfpgan module to enhance faces in the image.
59
+ This is particularly useful for images with faces that need to be upscaled and enhanced separately from the rest of the image.
60
+
61
+ ## πŸ™ Credits πŸ™
62
+
63
+ - **Squishy** - For helping me with the ideas
64
+
65
+ ## 🀝 Contributing 🀝
66
+
67
+ Interested in contributing to this project? Ilaria is always looking for collaborators.
68
+ Feel free to open a pull request on Hugging Face.
69
+
70
+ ## πŸ“„ License πŸ“„
71
+
72
+ This project is released under the `INCU` license.
73
+ For more details, please check the license file.
74
+ For further questions feel free to contact Ilaria.