Update README.md
Browse files
    	
        README.md
    CHANGED
    
    | 
         @@ -1,3 +1,67 @@ 
     | 
|
| 1 | 
         
            -
            ---
         
     | 
| 2 | 
         
            -
            license: mit
         
     | 
| 3 | 
         
            -
             
     | 
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
|
| 
         | 
| 
         | 
|
| 1 | 
         
            +
            ---
         
     | 
| 2 | 
         
            +
            license: mit
         
     | 
| 3 | 
         
            +
            language:
         
     | 
| 4 | 
         
            +
            - en
         
     | 
| 5 | 
         
            +
            tags:
         
     | 
| 6 | 
         
            +
            - material
         
     | 
| 7 | 
         
            +
            - pbr
         
     | 
| 8 | 
         
            +
            - svbrdf
         
     | 
| 9 | 
         
            +
            - texture
         
     | 
| 10 | 
         
            +
            - editing
         
     | 
| 11 | 
         
            +
            ---
         
     | 
| 12 | 
         
            +
             
     | 
| 13 | 
         
            +
             
     | 
| 14 | 
         
            +
            # MatFuse: Controllable Material Generation with Diffusion Models
         
     | 
| 15 | 
         
            +
             
     | 
| 16 | 
         
            +
            ## 🧩 Model Overview
         
     | 
| 17 | 
         
            +
             
     | 
| 18 | 
         
            +
            MatFuse leverages diffusion models to simplify the creation of Spatially-Varying Bidirectional Reflectance Distribution Function (SVBRDF) maps. 
         
     | 
| 19 | 
         
            +
            It allows for fine-grained control over material synthesis through multiple conditioning sources like color palettes, sketches, text, and images. 
         
     | 
| 20 | 
         
            +
            Additionally, it supports post-generation editing of materials.
         
     | 
| 21 | 
         
            +
             
     | 
| 22 | 
         
            +
            For more details, visit the [project page](https://gvecchio.com/matfuse/) or read the full paper on [arXiv](https://arxiv.org/abs/2308.11408).
         
     | 
| 23 | 
         
            +
             
     | 
| 24 | 
         
            +
            ## 🧑💻 Usage
         
     | 
| 25 | 
         
            +
             
     | 
| 26 | 
         
            +
            ### 💿 Installation
         
     | 
| 27 | 
         
            +
             
     | 
| 28 | 
         
            +
            1. Clone the repository:
         
     | 
| 29 | 
         
            +
                ```bash
         
     | 
| 30 | 
         
            +
                git clone https://github.com/giuvecchio/matfuse-sd.git
         
     | 
| 31 | 
         
            +
                cd matfuse-sd
         
     | 
| 32 | 
         
            +
                ```
         
     | 
| 33 | 
         
            +
             
     | 
| 34 | 
         
            +
            2. Set up the environment:
         
     | 
| 35 | 
         
            +
                ```bash
         
     | 
| 36 | 
         
            +
                # create environment (can use venv instead of conda)
         
     | 
| 37 | 
         
            +
                conda create -n matfuse python==3.10.13
         
     | 
| 38 | 
         
            +
                conda activate matfuse
         
     | 
| 39 | 
         
            +
                # install required packages
         
     | 
| 40 | 
         
            +
                pip install -r requirements.txt
         
     | 
| 41 | 
         
            +
                ```
         
     | 
| 42 | 
         
            +
                
         
     | 
| 43 | 
         
            +
            3. Download the checkpoint.
         
     | 
| 44 | 
         
            +
             
     | 
| 45 | 
         
            +
            ### 🧪 Inference
         
     | 
| 46 | 
         
            +
             
     | 
| 47 | 
         
            +
            To run inference on a trained model:
         
     | 
| 48 | 
         
            +
            ```bash
         
     | 
| 49 | 
         
            +
            python src/gradio_app.py --ckpt <path/to/checkpoint.ckpt> --config src/configs/diffusion/<config.yaml>
         
     | 
| 50 | 
         
            +
            ```
         
     | 
| 51 | 
         
            +
             
     | 
| 52 | 
         
            +
            ## 📜 Citation
         
     | 
| 53 | 
         
            +
             
     | 
| 54 | 
         
            +
            ```bibtex
         
     | 
| 55 | 
         
            +
            @inproceedings{vecchio2024matfuse,
         
     | 
| 56 | 
         
            +
              author    = {Vecchio, Giuseppe and Sortino, Renato and Palazzo, Simone and Spampinato, Concetto},
         
     | 
| 57 | 
         
            +
              title     = {MatFuse: Controllable Material Generation with Diffusion Models},
         
     | 
| 58 | 
         
            +
              booktitle = {Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition (CVPR)},
         
     | 
| 59 | 
         
            +
              month     = {June},
         
     | 
| 60 | 
         
            +
              year      = {2024},
         
     | 
| 61 | 
         
            +
              pages     = {4429-4438}
         
     | 
| 62 | 
         
            +
            }
         
     | 
| 63 | 
         
            +
            ```
         
     | 
| 64 | 
         
            +
             
     | 
| 65 | 
         
            +
            ## License
         
     | 
| 66 | 
         
            +
             
     | 
| 67 | 
         
            +
            This project is licensed under the MIT License.
         
     |