Martlgap commited on
Commit
74b81a1
·
1 Parent(s): d148abf

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +14 -117
README.md CHANGED
@@ -71,48 +71,29 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
71
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
72
  SOFTWARE.
73
 
74
- - **Finetuned from model:** [FaceTransformer](https://github.com/zhongyy/Face-Transformer)
75
 
76
- ### Model Sources [optional]
77
-
78
- <!-- Provide the basic links for the model. -->
79
 
80
  - **Repository:** [GitHub](github.com/martlgap/octuplet-loss)
81
  - **Paper:** [IEEExplore](https://ieeexplore.ieee.org/document/10042669)
82
 
83
  ## Uses
84
 
85
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
86
 
87
  ### Direct Use
88
 
89
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
90
 
91
- [More Information Needed]
92
 
93
- ### Downstream Use [optional]
94
 
95
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
96
-
97
- [More Information Needed]
98
-
99
- ### Out-of-Scope Use
100
-
101
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
102
 
103
  [More Information Needed]
104
 
105
  ## Bias, Risks, and Limitations
106
 
107
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
108
-
109
- [More Information Needed]
110
-
111
- ### Recommendations
112
-
113
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
114
-
115
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
116
 
117
  ## How to Get Started with the Model
118
 
@@ -120,100 +101,27 @@ Use the code below to get started with the model.
120
 
121
  [More Information Needed]
122
 
123
- ## Training Details
124
-
125
- ### Training Data
126
-
127
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
128
-
129
- [More Information Needed]
130
-
131
- ### Training Procedure
132
-
133
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
134
-
135
- #### Preprocessing [optional]
136
-
137
- [More Information Needed]
138
-
139
-
140
- #### Training Hyperparameters
141
-
142
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
143
-
144
- #### Speeds, Sizes, Times [optional]
145
-
146
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
147
-
148
- [More Information Needed]
149
-
150
  ## Evaluation
151
 
152
- <!-- This section describes the evaluation protocols and provides the results. -->
153
-
154
  ### Testing Data, Factors & Metrics
155
 
156
  #### Testing Data
157
 
158
- <!-- This should link to a Dataset Card if possible. -->
159
-
160
- [More Information Needed]
161
-
162
- #### Factors
163
-
164
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
165
-
166
- [More Information Needed]
167
 
168
  #### Metrics
169
 
170
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
171
-
172
- [More Information Needed]
173
 
174
  ### Results
175
 
176
- [More Information Needed]
177
-
178
- #### Summary
179
-
180
-
181
-
182
- ## Model Examination [optional]
183
-
184
- <!-- Relevant interpretability work for the model goes here -->
185
-
186
- [More Information Needed]
187
-
188
- ## Environmental Impact
189
-
190
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
191
-
192
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
193
-
194
- - **Hardware Type:** [More Information Needed]
195
- - **Hours used:** [More Information Needed]
196
- - **Cloud Provider:** [More Information Needed]
197
- - **Compute Region:** [More Information Needed]
198
- - **Carbon Emitted:** [More Information Needed]
199
-
200
- ## Technical Specifications [optional]
201
-
202
- ### Model Architecture and Objective
203
-
204
- Vision Transformer Network
205
-
206
- ### Compute Infrastructure
207
-
208
- [More Information Needed]
209
-
210
- #### Hardware
211
-
212
- [More Information Needed]
213
-
214
- #### Software
215
-
216
- [More Information Needed]
217
 
218
  ## Citation
219
 
@@ -230,17 +138,6 @@ Vision Transformer Network
230
  }
231
  ~~~
232
 
233
-
234
- ## Glossary [optional]
235
-
236
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
237
-
238
- [More Information Needed]
239
-
240
- ## More Information [optional]
241
-
242
- [More Information Needed]
243
-
244
  ## Model Card Author
245
 
246
  Martin Knoche
 
71
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
72
  SOFTWARE.
73
 
74
+ - **Finetuned from model:** [FaceTransformer](https://github.com/zhongyy/Face-Transformer) by [zhongyy](https://github.com/zhongyy)
75
 
76
+ ### Model Sources
 
 
77
 
78
  - **Repository:** [GitHub](github.com/martlgap/octuplet-loss)
79
  - **Paper:** [IEEExplore](https://ieeexplore.ieee.org/document/10042669)
80
 
81
  ## Uses
82
 
83
+ Use the model to extract a facial feature vector from an arbitrary aligned facial image.
84
 
85
  ### Direct Use
86
 
87
+ The model can be used by within an ONNX-Runtime environment. Face must be aligned according to:
88
 
 
89
 
 
90
 
 
 
 
 
 
 
 
91
 
92
  [More Information Needed]
93
 
94
  ## Bias, Risks, and Limitations
95
 
96
+ The model was originally trained and also finetuned on the [MS1M](https://exposing.ai/msceleb/) dataset. Thus please be check the MS1M dataset for bias and risks.
 
 
 
 
 
 
 
 
97
 
98
  ## How to Get Started with the Model
99
 
 
101
 
102
  [More Information Needed]
103
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
104
  ## Evaluation
105
 
 
 
106
  ### Testing Data, Factors & Metrics
107
 
108
  #### Testing Data
109
 
110
+ - [LFW](http://vis-www.cs.umass.edu/lfw/)
111
+ - [CALFW](http://whdeng.cn/CALFW/)
112
+ - [CPLFW](http://whdeng.cn/CPLFW/)
113
+ - [MLFW](http://whdeng.cn/mlfw/)
114
+ - [XQLFW](https://martlgap.github.io/xqlfw/)
 
 
 
 
115
 
116
  #### Metrics
117
 
118
+ Accuracy [%]
 
 
119
 
120
  ### Results
121
 
122
+ | [LFW](http://vis-www.cs.umass.edu/lfw/) | [CALFW](http://whdeng.cn/CALFW/) | [CPLFW](http://whdeng.cn/CPLFW/) | [MLFW](http://whdeng.cn/mlfw/) | [XQLFW](https://martlgap.github.io/xqlfw/) |
123
+ |---|---|---|---|---|
124
+ | 99.73 | 94.93 | 91.58 | 85.63 | 95.12 |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
125
 
126
  ## Citation
127
 
 
138
  }
139
  ~~~
140
 
 
 
 
 
 
 
 
 
 
 
 
141
  ## Model Card Author
142
 
143
  Martin Knoche