Improve model card: Add pipeline tag and setup instructions

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +49 -30
README.md CHANGED
@@ -22,96 +22,97 @@ model-index:
22
  name: LOL-v1
23
  type: LOL-v1
24
  metrics:
25
- - name: PSNR
26
- type: PSNR
27
  value: 27.97
28
- - name: SSIM
29
- type: SSIM
30
  value: 0.897
 
31
  - task:
32
  type: low-light-image-enhancement
33
  dataset:
34
  name: LOL-v2-Real
35
  type: LOL-v2-Real
36
  metrics:
37
- - name: PSNR
38
- type: PSNR
39
  value: 29.33
40
- - name: SSIM
41
- type: SSIM
42
  value: 0.915
 
43
  - task:
44
  type: low-light-image-enhancement
45
  dataset:
46
  name: LOL-v2-Synthetic
47
  type: LOL-v2-Synthetic
48
  metrics:
49
- - name: PSNR
50
- type: PSNR
51
  value: 30.15
52
- - name: SSIM
53
- type: SSIM
54
  value: 0.951
 
55
  - task:
56
  type: low-light-image-enhancement
57
  dataset:
58
  name: SDSD-indoor
59
  type: SDSD-indoor
60
  metrics:
61
- - name: PSNR
62
- type: PSNR
63
  value: 31.37
64
- - name: SSIM
65
- type: SSIM
66
  value: 0.917
 
67
  - task:
68
  type: low-light-image-enhancement
69
  dataset:
70
  name: SDSD-outdoor
71
  type: SDSD-outdoor
72
  metrics:
73
- - name: PSNR
74
- type: PSNR
75
  value: 31.73
76
- - name: SSIM
77
- type: SSIM
78
  value: 0.904
 
79
  - task:
80
  type: low-light-image-enhancement
81
  dataset:
82
  name: MEF
83
  type: MEF
84
  metrics:
85
- - name: NIQE
86
- type: NIQE
87
  value: 3.44
 
88
  - task:
89
  type: low-light-image-enhancement
90
  dataset:
91
  name: LIME
92
  type: LIME
93
  metrics:
94
- - name: NIQE
95
- type: NIQE
96
  value: 3.82
 
97
  - task:
98
  type: low-light-image-enhancement
99
  dataset:
100
  name: DICM
101
  type: DICM
102
  metrics:
103
- - name: NIQE
104
- type: NIQE
105
  value: 3.64
 
106
  - task:
107
  type: low-light-image-enhancement
108
  dataset:
109
  name: NPE
110
  type: NPE
111
  metrics:
112
- - name: NIQE
113
- type: NIQE
114
  value: 3.55
 
 
115
  ---
116
 
117
  # โœจ ModalFormer: Multimodal Transformer for Low-Light Image Enhancement
@@ -120,7 +121,7 @@ model-index:
120
 
121
  **[Alexandru Brateanu](https://scholar.google.com/citations?user=ru0meGgAAAAJ&hl=en), [Raul Balmez](https://scholar.google.com/citations?user=vPC7raQAAAAJ&hl=en), [Ciprian Orhei](https://scholar.google.com/citations?user=DZHdq3wAAAAJ&hl=en), [Codruta Ancuti](https://scholar.google.com/citations?user=5PA43eEAAAAJ&hl=en), [Cosmin Ancuti](https://scholar.google.com/citations?user=zVTgt8IAAAAJ&hl=en)**
122
 
123
- [![arXiv](https://img.shields.io/badge/arxiv-paper-179bd3)](https://arxiv.org/abs/2401.15204)
124
  </div>
125
 
126
  ### Abstract
@@ -131,7 +132,25 @@ model-index:
131
  - `28.07.2025` ๐Ÿ“ฆ Pre-trained models and test data published! ArXiv paper version and HuggingFace demo coming soon, stay tuned!
132
 
133
  ## โš™๏ธ Setup and Testing
134
- Please check out the [**GitHub repository**](https://github.com/albrateanu/ModalFormer) for implementation details.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
135
 
136
  ## ๐Ÿ“š Citation
137
 
 
22
  name: LOL-v1
23
  type: LOL-v1
24
  metrics:
25
+ - type: PSNR
 
26
  value: 27.97
27
+ name: PSNR
28
+ - type: SSIM
29
  value: 0.897
30
+ name: SSIM
31
  - task:
32
  type: low-light-image-enhancement
33
  dataset:
34
  name: LOL-v2-Real
35
  type: LOL-v2-Real
36
  metrics:
37
+ - type: PSNR
 
38
  value: 29.33
39
+ name: PSNR
40
+ - type: SSIM
41
  value: 0.915
42
+ name: SSIM
43
  - task:
44
  type: low-light-image-enhancement
45
  dataset:
46
  name: LOL-v2-Synthetic
47
  type: LOL-v2-Synthetic
48
  metrics:
49
+ - type: PSNR
 
50
  value: 30.15
51
+ name: PSNR
52
+ - type: SSIM
53
  value: 0.951
54
+ name: SSIM
55
  - task:
56
  type: low-light-image-enhancement
57
  dataset:
58
  name: SDSD-indoor
59
  type: SDSD-indoor
60
  metrics:
61
+ - type: PSNR
 
62
  value: 31.37
63
+ name: PSNR
64
+ - type: SSIM
65
  value: 0.917
66
+ name: SSIM
67
  - task:
68
  type: low-light-image-enhancement
69
  dataset:
70
  name: SDSD-outdoor
71
  type: SDSD-outdoor
72
  metrics:
73
+ - type: PSNR
 
74
  value: 31.73
75
+ name: PSNR
76
+ - type: SSIM
77
  value: 0.904
78
+ name: SSIM
79
  - task:
80
  type: low-light-image-enhancement
81
  dataset:
82
  name: MEF
83
  type: MEF
84
  metrics:
85
+ - type: NIQE
 
86
  value: 3.44
87
+ name: NIQE
88
  - task:
89
  type: low-light-image-enhancement
90
  dataset:
91
  name: LIME
92
  type: LIME
93
  metrics:
94
+ - type: NIQE
 
95
  value: 3.82
96
+ name: NIQE
97
  - task:
98
  type: low-light-image-enhancement
99
  dataset:
100
  name: DICM
101
  type: DICM
102
  metrics:
103
+ - type: NIQE
 
104
  value: 3.64
105
+ name: NIQE
106
  - task:
107
  type: low-light-image-enhancement
108
  dataset:
109
  name: NPE
110
  type: NPE
111
  metrics:
112
+ - type: NIQE
 
113
  value: 3.55
114
+ name: NIQE
115
+ pipeline_tag: image-to-image
116
  ---
117
 
118
  # โœจ ModalFormer: Multimodal Transformer for Low-Light Image Enhancement
 
121
 
122
  **[Alexandru Brateanu](https://scholar.google.com/citations?user=ru0meGgAAAAJ&hl=en), [Raul Balmez](https://scholar.google.com/citations?user=vPC7raQAAAAJ&hl=en), [Ciprian Orhei](https://scholar.google.com/citations?user=DZHdq3wAAAAJ&hl=en), [Codruta Ancuti](https://scholar.google.com/citations?user=5PA43eEAAAAJ&hl=en), [Cosmin Ancuti](https://scholar.google.com/citations?user=zVTgt8IAAAAJ&hl=en)**
123
 
124
+ [![arXiv](https://img.shields.io/badge/arxiv-paper-179bd3)](https://arxiv.org/abs/2507.20388)
125
  </div>
126
 
127
  ### Abstract
 
132
  - `28.07.2025` ๐Ÿ“ฆ Pre-trained models and test data published! ArXiv paper version and HuggingFace demo coming soon, stay tuned!
133
 
134
  ## โš™๏ธ Setup and Testing
135
+ For ease, utilize a Linux machine with CUDA-ready devices (GPUs).
136
+
137
+ To setup the environment, first run the provided setup script:
138
+
139
+ ```bash
140
+ ./environment_setup.sh
141
+ # or
142
+ bash environment_setup.sh
143
+ ```
144
+
145
+ Note: in case of difficulties, ensure ```environment_setup.sh``` is executable by running:
146
+
147
+ ```bash
148
+ chmod +x environment_setup.sh
149
+ ```
150
+
151
+ Give the setup a couple of minutes to run.
152
+
153
+ Please check out the [**GitHub repository**](https://github.com/albrateanu/ModalFormer) for more implementation details.
154
 
155
  ## ๐Ÿ“š Citation
156