Update README.md
Browse files
    	
        README.md
    CHANGED
    
    | @@ -1,74 +1,10 @@ | |
| 1 | 
             
            ---
         | 
| 2 | 
            -
            title:  | 
| 3 | 
             
            emoji: π
         | 
| 4 | 
            -
            colorFrom:  | 
| 5 | 
            -
            colorTo:  | 
| 6 | 
             
            sdk: gradio
         | 
| 7 | 
             
            sdk_version: 4.36.1
         | 
| 8 | 
             
            app_file: app.py
         | 
| 9 | 
            -
            pinned:  | 
| 10 | 
            -
            ---
         | 
| 11 | 
            -
             | 
| 12 | 
            -
            
         | 
| 13 | 
            -
            ***
         | 
| 14 | 
            -
            [](https://huggingface.co/spaces/TheStinger/Ilaria_Upscaler) [](https://huggingface.co/spaces/TheStinger/Ilaria_Upscaler?duplicate=true) [](https://github.com/TheStingerX/Ilaria-Upscaler) [](https://discord.gg/aihub) [](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 Upscaler 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 Upscaler 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.
         | 
|  | |
| 1 | 
             
            ---
         | 
| 2 | 
            +
            title: Upscaler
         | 
| 3 | 
             
            emoji: π
         | 
| 4 | 
            +
            colorFrom: blue
         | 
| 5 | 
            +
            colorTo: blue
         | 
| 6 | 
             
            sdk: gradio
         | 
| 7 | 
             
            sdk_version: 4.36.1
         | 
| 8 | 
             
            app_file: app.py
         | 
| 9 | 
            +
            pinned: false
         | 
| 10 | 
            +
            ---
         | 
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  |