aarimond commited on
Commit
8d5f891
·
1 Parent(s): a836afc

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +78 -178
README.md CHANGED
@@ -20,203 +20,103 @@ model-index:
20
  name: f1 macro
21
  args:
22
  average: macro
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
23
  ---
 
24
 
25
- # Model Card for Model ID
 
26
 
27
- <!-- Provide a quick summary of what the model is/does. -->
28
 
29
- # Table of Contents
 
 
 
 
 
 
 
 
 
 
30
 
31
- 1. [Model Details](#model-details)
32
- 2. [Uses](#uses)
33
- 3. [Bias, Risks, and Limitations](#bias-risks-and-limitations)
34
- 4. [Training Details](#training-details)
35
- 5. [Evaluation](#evaluation)
36
- 6. [Model Examination](#model-examination-optional)
37
- 7. [Environmental Impact](#environmental-impact)
38
- 8. [Technical Specifications](#technical-specifications-optional)
39
- 9. [Citation](#citation-optional)
40
- 10. [Glossary](#glossary-optional)
41
- 11. [More Information](#more-information-optional)
42
- 12. [Model Card Authors](#model-card-authors-optional)
43
- 13. [Model Card Contact](#model-card-contact)
44
- 14. [How To Get Started With the Model](#how-to-get-started-with-the-model)
45
-
46
-
47
- # Model Details
48
 
49
  ## Model Description
50
 
51
  <!-- Provide a longer summary of what this model is. -->
52
 
 
 
 
53
 
 
54
 
55
- - **Developed by:** [More Information Needed]
56
- - **Shared by [optional]:** [More Information Needed]
57
- - **Model type:** [More Information Needed]
58
- - **Language(s) (NLP):** [More Information Needed]
59
- - **License:** [More Information Needed]
60
- - **Finetuned from model [optional]:** [More Information Needed]
61
- - **Resources for more information:** [More Information Needed]
62
 
63
  # Uses
64
 
65
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
66
 
67
- ## Direct Use
68
-
69
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
70
-
71
- [More Information Needed]
72
-
73
- ## Downstream Use [optional]
74
-
75
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
76
-
77
- [More Information Needed]
78
-
79
- ## Out-of-Scope Use
80
-
81
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
82
-
83
- [More Information Needed]
84
-
85
- # Bias, Risks, and Limitations
86
-
87
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
88
-
89
- [More Information Needed]
90
-
91
- ## Recommendations
92
-
93
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
94
-
95
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
96
-
97
- # Training Details
98
-
99
- ## Training Data
100
-
101
- <!-- 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. -->
102
-
103
- [More Information Needed]
104
-
105
- ## Training Procedure [optional]
106
-
107
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
108
-
109
- ### Preprocessing
110
-
111
- [More Information Needed]
112
-
113
- ### Speeds, Sizes, Times
114
-
115
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
116
-
117
- [More Information Needed]
118
-
119
- # Evaluation
120
-
121
- <!-- This section describes the evaluation protocols and provides the results. -->
122
-
123
- ## Testing Data, Factors & Metrics
124
-
125
- ### Testing Data
126
-
127
- <!-- This should link to a Data Card if possible. -->
128
-
129
- [More Information Needed]
130
-
131
- ### Factors
132
-
133
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
134
-
135
- [More Information Needed]
136
-
137
- ### Metrics
138
-
139
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
140
-
141
- [More Information Needed]
142
-
143
- ## Results
144
-
145
- [More Information Needed]
146
-
147
- # Model Examination [optional]
148
-
149
- <!-- Relevant interpretability work for the model goes here -->
150
-
151
- [More Information Needed]
152
-
153
- # Environmental Impact
154
-
155
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
156
-
157
- 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).
158
-
159
- - **Hardware Type:** [More Information Needed]
160
- - **Hours used:** [More Information Needed]
161
- - **Cloud Provider:** [More Information Needed]
162
- - **Compute Region:** [More Information Needed]
163
- - **Carbon Emitted:** [More Information Needed]
164
-
165
- # Technical Specifications [optional]
166
-
167
- ## Model Architecture and Objective
168
-
169
- [More Information Needed]
170
-
171
- ## Compute Infrastructure
172
-
173
- [More Information Needed]
174
-
175
- ### Hardware
176
-
177
- [More Information Needed]
178
-
179
- ### Software
180
-
181
- [More Information Needed]
182
-
183
- # Citation [optional]
184
-
185
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
186
-
187
- **BibTeX:**
188
-
189
- [More Information Needed]
190
-
191
- **APA:**
192
-
193
- [More Information Needed]
194
-
195
- # Glossary [optional]
196
-
197
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
198
-
199
- [More Information Needed]
200
-
201
- # More Information [optional]
202
-
203
- [More Information Needed]
204
-
205
- # Model Card Authors [optional]
206
-
207
- [More Information Needed]
208
-
209
- # Model Card Contact
210
-
211
- [More Information Needed]
212
 
213
- # How to Get Started with the Model
214
 
215
- Use the code below to get started with the model.
216
 
217
- <details>
218
- <summary> Click to expand </summary>
219
 
220
- [More Information Needed]
221
 
222
- </details>
 
20
  name: f1 macro
21
  args:
22
  average: macro
23
+ widget:
24
+ - text: "BetterMe Finland Oy"
25
+ - text: "Kotkan Kuurojen Yhdistys ry"
26
+ - text: "Kunnallisalan kehittämissäätiö sr"
27
+ - text: "Eero Kurvinen Ky"
28
+ - text: "OP-Tavoite 2 -sijoitusrahasto"
29
+ - text: "Asunto Oy Mertamäki"
30
+ - text: "Uponor Oyj"
31
+ - text: "Keskinäinen Kiinteistö Oy Keijo Lounala"
32
+ - text: "Kuusamon kaupunki"
33
+ - text: "Ilmajoen Musiikkijuhlat ry"
34
+ - text: "Hanne ja Timo Similä avoin yhtiö"
35
+ - text: "Vehmersalmen Osuuspankki"
36
+ - text: "Juvan seurakunta"
37
+ - text: "Nesteen Henkilöstörahasto hr"
38
+ - text: "Suur-Seudun Osuuskauppa SSO"
39
+ - text: "Tmi Ida Lehmus"
40
+ - text: "Pohjois-Karjalan sosiaali- ja terveyspalvelujen kuntayhtymä"
41
+ - text: "Finlaysonin Forssan Tehtaitten Sairauskassa"
42
+ - text: "Suomen Punainen Risti Savo-Karjalan piiri"
43
+ - text: "L-Fashion Group Oy:n Eläkesäätiö"
44
+ - text: "Gummandouran Osakaskunta"
45
+ - text: "Suomen Keskinäinen Lääkevahinkovakuutusyhtiö"
46
+ - text: "Työttömyyskassojen Tukikassa"
47
+ - text: "Kuntien Takauskeskus"
48
+ - text: "LUT-yliopiston ylioppilaskunta"
49
+ - text: "Huoltovarmuuskeskus"
50
+ - text: "Pohjois-Karjalan kauppakamari ry"
51
+ - text: "Turun katolinen seurakunta (Pyhän Birgitan ja Autuaan Hemminginseurakunta)"
52
+ - text: "Närpes Sjukvårdsfond"
53
+ - text: "Kvevlax Sparbank"
54
+ - text: "Valion Eläkekassa"
55
+ - text: "Yhteismetsä Visa"
56
+ - text: "Maatalousyhtymä Niinivehmas & Tallila"
57
+ - text: "Suomen Vahinkovakuutus Oy"
58
+ - text: "Pyhän Marian katolinen seurakunta"
59
+ - text: "Kumpulainen Elma Sofia kuolinpesä"
60
+ - text: "Afarak Group SE"
61
+ - text: "Nordiska Miljöfinansieringsbolaget, Pohjoismaiden ympäristörahoitusyhtiö NEFCO, Nordic Environment Finance Corporation"
62
+ - text: "Österbottens Fiskeriförsäkringsförening"
63
+ - text: "Joensuun ortodoksinen seurakunta"
64
+ - text: "Scandia Mink Ab konkursbo"
65
  ---
66
+ # LENU - Legal Entity Name Understanding for Finland
67
 
68
+ A [finnish Bert](https://huggingface.co/TurkuNLP/bert-base-finnish-cased-v1) model fine-tuned on finnish legal entity names (jurisdiction FI) from the Global [Legal Entity Identifier](https://www.gleif.org/en/about-lei/introducing-the-legal-entity-identifier-lei)
69
+ (LEI) System with the goal to detect [Entity Legal Form (ELF) Codes](https://www.gleif.org/en/about-lei/code-lists/iso-20275-entity-legal-forms-code-list).
70
 
71
+ ---------------
72
 
73
+ <h1 align="center">
74
+ <a href="https://gleif.org">
75
+ <img src="http://sdglabs.ai/wp-content/uploads/2022/07/gleif-logo-new.png" width="220px" style="display: inherit">
76
+ </a>
77
+ </h1><br>
78
+ <h3 align="center">in collaboration with</h3>
79
+ <h1 align="center">
80
+ <a href="https://sociovestix.com">
81
+ <img src="https://sociovestix.com/img/svl_logo_centered.svg" width="700px" style="width: 100%">
82
+ </a>
83
+ </h1><br>
84
 
85
+ ---------------
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
86
 
87
  ## Model Description
88
 
89
  <!-- Provide a longer summary of what this model is. -->
90
 
91
+ The model has been created as part of a collaboration of the [Global Legal Entity Identifier Foundation](https://gleif.org) (GLEIF) and
92
+ [Sociovestix Labs](https://sociovestix.com) with the goal to explore how Machine Learning can support in detecting the ELF Code solely based on an entity's legal name and legal jurisdiction.
93
+ See also the open source python library [lenu](https://github.com/Sociovestix/lenu), which supports in this task.
94
 
95
+ The model has been trained on the dataset [lenu](https://huggingface.co/datasets/Sociovestix), with a focus on finnish legal entities and ELF Codes within the Jurisdiction "FI".
96
 
97
+ - **Developed by:** [GLEIF](https://gleif.org) and [Sociovestix Labs](https://huggingface.co/Sociovestix)
98
+ - **License:** Creative Commons (CC0) license
99
+ - **Finetuned from model [optional]:** TurkuNLP/bert-base-finnish-cased-v1
100
+ - **Resources for more information:** [Press Release](https://www.gleif.org/en/newsroom/press-releases/machine-learning-new-open-source-tool-developed-by-gleif-and-sociovestix-labs-enables-organizations-everywhere-to-automatically-)
 
 
 
101
 
102
  # Uses
103
 
104
  <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
105
 
106
+ An entity's legal form is a crucial component when verifying and screening organizational identity.
107
+ The wide variety of entity legal forms that exist within and between jurisdictions, however, has made it difficult for large organizations to capture legal form as structured data.
108
+ The Jurisdiction specific models of [lenu](https://github.com/Sociovestix/lenu), trained on entities from
109
+ GLEIF’s Legal Entity Identifier (LEI) database of over two million records, will allow banks,
110
+ investment firms, corporations, governments, and other large organizations to retrospectively analyze
111
+ their master data, extract the legal form from the unstructured text of the legal name and
112
+ uniformly apply an ELF code to each entity type, according to the ISO 20275 standard.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
113
 
 
114
 
115
+ # Licensing Information
116
 
117
+ This model, which is trained on LEI data, is available under Creative Commons (CC0) license.
118
+ See [gleif.org/en/about/open-data](https://gleif.org/en/about/open-data).
119
 
120
+ # Recommendations
121
 
122
+ Users should always consider the score of the suggested ELF Codes. For low score values it may be necessary to manually review the affected entities.