Jenthe commited on
Commit
76437d2
·
1 Parent(s): 0e15756

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +3 -153
README.md CHANGED
@@ -10,25 +10,6 @@ ECAPA2 is a hybrid neural network architecture and training strategy for speaker
10
 
11
  <img src="https://cdn-uploads.huggingface.co/production/uploads/620f6a7d110b521c673c1914/BORgtl2G6XUlWaZeMLGPc.png" width="300"/>
12
 
13
- ### Model Description
14
-
15
- <!-- Provide a longer summary of what this model is. -->
16
-
17
- - **Developed by:** [More Information Needed]
18
- - **Shared by [optional]:** [More Information Needed]
19
- - **Model type:** [More Information Needed]
20
- - **Language(s) (NLP):** [More Information Needed]
21
- - **License:** [More Information Needed]
22
- - **Finetuned from model [optional]:** [More Information Needed]
23
-
24
- ### Model Sources [optional]
25
-
26
- <!-- Provide the basic links for the model. -->
27
-
28
- - **Repository:** [More Information Needed]
29
- - **Paper [optional]:** [More Information Needed]
30
- - **Demo [optional]:** [More Information Needed]
31
-
32
  ## Usage Guide
33
 
34
  ### Speaker Embedding Extraction
@@ -61,136 +42,10 @@ The following table describes the available features:
61
 
62
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
63
 
64
- ### Direct Use
65
-
66
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
67
-
68
- [More Information Needed]
69
-
70
- ### Downstream Use [optional]
71
-
72
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
73
-
74
- [More Information Needed]
75
-
76
- ### Out-of-Scope Use
77
-
78
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
79
-
80
- [More Information Needed]
81
-
82
- ## Bias, Risks, and Limitations
83
-
84
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
85
-
86
- [More Information Needed]
87
-
88
- ### Recommendations
89
-
90
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
91
-
92
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
93
-
94
- ## How to Get Started with the Model
95
-
96
- Use the code below to get started with the model.
97
-
98
- [More Information Needed]
99
-
100
- ## Training Details
101
-
102
- ### Training Data
103
-
104
- <!-- This should link to a Data 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. -->
105
-
106
- [More Information Needed]
107
-
108
- ### Training Procedure
109
-
110
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
111
-
112
- #### Preprocessing [optional]
113
-
114
- [More Information Needed]
115
-
116
-
117
- #### Training Hyperparameters
118
-
119
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
120
-
121
- #### Speeds, Sizes, Times [optional]
122
-
123
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
124
-
125
- [More Information Needed]
126
-
127
- ## Evaluation
128
-
129
- <!-- This section describes the evaluation protocols and provides the results. -->
130
-
131
- ### Testing Data, Factors & Metrics
132
-
133
- #### Testing Data
134
-
135
- <!-- This should link to a Data Card if possible. -->
136
-
137
- [More Information Needed]
138
-
139
- #### Factors
140
-
141
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
142
-
143
- [More Information Needed]
144
-
145
- #### Metrics
146
-
147
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
148
-
149
- [More Information Needed]
150
-
151
  ### Results
152
 
153
  [More Information Needed]
154
 
155
- #### Summary
156
-
157
-
158
-
159
- ## Model Examination [optional]
160
-
161
- <!-- Relevant interpretability work for the model goes here -->
162
-
163
- [More Information Needed]
164
-
165
- ## Environmental Impact
166
-
167
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
168
-
169
- 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).
170
-
171
- - **Hardware Type:** [More Information Needed]
172
- - **Hours used:** [More Information Needed]
173
- - **Cloud Provider:** [More Information Needed]
174
- - **Compute Region:** [More Information Needed]
175
- - **Carbon Emitted:** [More Information Needed]
176
-
177
- ## Technical Specifications [optional]
178
-
179
- ### Model Architecture and Objective
180
-
181
- [More Information Needed]
182
-
183
- ### Compute Infrastructure
184
-
185
- [More Information Needed]
186
-
187
- #### Hardware
188
-
189
- [More Information Needed]
190
-
191
- #### Software
192
-
193
- [More Information Needed]
194
 
195
  ## Citation [optional]
196
 
@@ -214,12 +69,7 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
214
 
215
  [More Information Needed]
216
 
217
- ## Model Card Authors [optional]
218
-
219
- [More Information Needed]
220
-
221
- ## Model Card Contact
222
-
223
- [More Information Needed]
224
-
225
 
 
 
 
10
 
11
  <img src="https://cdn-uploads.huggingface.co/production/uploads/620f6a7d110b521c673c1914/BORgtl2G6XUlWaZeMLGPc.png" width="300"/>
12
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
13
  ## Usage Guide
14
 
15
  ### Speaker Embedding Extraction
 
42
 
43
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
44
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
45
  ### Results
46
 
47
  [More Information Needed]
48
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
49
 
50
  ## Citation [optional]
51
 
 
69
 
70
  [More Information Needed]
71
 
72
+ ## Contact [optional]
 
 
 
 
 
 
 
73
 
74
+ Name: Jenthe Thienpondt
75
+ E-mail: [email protected]