SIRIS-Lab
/

affilgood-NER

@@ -1,199 +1,176 @@
 ---
 library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- 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. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-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).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
 library_name: transformers
+tags:
+- affiliations
+- ner
+- science
+license: apache-2.0
+language:
+- en
+base_model:
+- SIRIS-Lab/affilgood-affilroberta
 ---
+# AffilGood-NER
+## Overview
+<details>
+<summary>Click to expand</summary>
+- **Model type:** Language Model
+- **Architecture:** RoBERTa-base
+- **Language:** English
+- **License:** Apache 2.0
+- **Task:** Named Entity Recognition
+- **Data:** AffilGood-NER
+- **Additional Resources:**
+  - [Paper](https://https://aclanthology.org/2024.sdp-1.13/)
+  - [GitHub](https://github.com/sirisacademic/affilgood)
+</details>
+## Model description
+The English version of **affilgood-NER** is a Named Entity Recognition (NER) model for identifying named entities in raw affiliation strings from scientific papers and projects,
+fine-tuned from the [AffilRoberta](https://huggingface.co/SIRIS-Lab/affilgood-affilroberta) model, a [RoBERTa](https://arxiv.org/abs/1907.11692) base model futher pre-trained for MLM task on a medium-size corpus of raw affiliation stirngs collected from OpenAlex.
+It has been trained with a dataset that contains 7 main types of entities from multilingual raw affiliation strings texts, with  5,266 texts.
+After analyzing hundreds of affiliations from multiple countries and languages, we defined seven entity types: `SUB-ORGANISATION`, `ORGANISATION`, `CITY`, `COUNTRY`, `ADDRESS`, `POSTAL-CODE`, and `REGION`, detailed [annotation guidelines here].
+**Identifying named entities** (organization names, cities, countries) in affiliation strings not only enables more effective linking with external organization registries, but it can also play an essential role in the geolocation of organizations and can also contribute to identify organizations and their position in an institutional hierarchy -- especially for those not listed in external databases. Information automatically extracted by means of a NER model can also facilitate the construction of knowledge graphs, and support the development of manually curated registries.
+## Intended Usage
+This model is intended to be used for raw affiliation strings in English, because this model is pre-trained on English RoBERTa, however NER and large further pre-training corpora are both multilingual.
+## How to use
+```python
+from transformers import pipeline
+affilgood_ner_pipeline("ner", model=model, tokenizer=tokenizer, aggregation_strategy="simple")
+sentence = "CSIC, Global ecology Unit CREAF-CSIC-UAB, Bellaterra 08193, Catalonia, Spain."
+output = affilgood_ner_pipeline(sentence)
+print(output)
+```
+## Limitations and bias
+No measures have been taken to estimate the bias and toxicity embedded in the model.
+The NER dataset contains 5,266 raw affiliation strings obtained from OpenAlex.
+It includes multilingual samples from all available countries and geographies to ensure comprehensive coverage and diversity.
+To enable our model to recognize various affiliation string formats, the dataset includes a wide range of structures, different ways of grouping main and subsidiary institutions and various methods of separating organization names. We also included ill-formed affiliations and those containing errors resulting from automatic extraction from PDF files.
+## Training
+We used the [AffilGood-NER dataset](link) for training and evaluation.
+We fine-tuned the adapted and base models for token classification with the IOB annotation schema.
+We trained the models for 25 epochs, using 80% of the dataset for training, 10% for validation and 10% for testing.
+Hyperparameters used for training are described here:
+- Learning Rate: 2e-5
+- Learning Rate Decay: Linear
+- Weight Decay: 0.01
+- Warmup Portion: 0.06
+- Batch Size: 128
+- Number of Steps: 25k steps
+- Adam ε: 1e-6
+- Adam β<sub>1</sub>: 0.9
+- Adam β<sub>2</sub>: 0.999
+The **best performing epoch (considering macro-averaged F1 with *strict* matching criteria) was used to select the model**.
+### Evaluation
+The model's performance was evaluated on a 10% of the dataset.
+| Category| RoBERTa | XLM | **AffilRoBERTa (this model)** | AffilXLM |
+|-----|------|------|------|----------|
+| ALL | .910 | .915 | .920 | **.925** |
+|-----|------|------|------|----------|
+| ORG | .869 | .886 | .879 | **.906** |
+| SUB | .898 | .890 | **.911** | .892 |
+| CITY | .936 | .941 | .950 | **.958** |
+| COUNTRY | .971 | .973 | **.980** | .970 |
+| REGION | .870 | .876 | .874 | **.882** |
+| POSTAL | .975 | .975 | **.981** | .966 |
+| ADDRESS | .804 | .811 | .794 | **.869** |
+All the numbers reported above represent F1-score with *strict* match, when both the boundaries and types of the entities match.
+## Additional information
+### Authors
+- SIRIS Lab, Research Division of SIRIS Academic, Barcelona, Spain
+- LaSTUS Lab, TALN Group, Universitat Pompeu Fabra, Barcelona, Spain
+- Institute of Computer Science, Polish Academy of Sciences, Warsaw, Poland
+### Contact
+For further information, send an email to either <[email protected]> or <info@sirisacademic.com>.
+### License
+This work is distributed under a [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
+### Funding
+This work was partially funded and supporter by:
+- Industrial Doctorates Plan of the Department of Research and Universities of the Generalitat de Catalunya, by Departament de Recerca i Universitats de la Generalitat de Catalunya (ajuts SGR-Cat 2021),
+- Maria de Maeztu Units of Excellence Programme CEX2021-001195-M, funded by MCIN/AEI /10.13039/501100011033
+- EU HORIZON SciLake (Grant Agreement 101058573)
+- EU HORIZON ERINIA (Grant Agreement 101060930)
+### Citation
+```bibtex
+@inproceedings{duran-silva-etal-2024-affilgood,
+    title = "{A}ffil{G}ood: Building reliable institution name disambiguation tools to improve scientific literature analysis",
+    author = "Duran-Silva, Nicolau  and
+      Accuosto, Pablo  and
+      Przyby{\l}a, Piotr  and
+      Saggion, Horacio",
+    editor = "Ghosal, Tirthankar  and
+      Singh, Amanpreet  and
+      Waard, Anita  and
+      Mayr, Philipp  and
+      Naik, Aakanksha  and
+      Weller, Orion  and
+      Lee, Yoonjoo  and
+      Shen, Shannon  and
+      Qin, Yanxia",
+    booktitle = "Proceedings of the Fourth Workshop on Scholarly Document Processing (SDP 2024)",
+    month = aug,
+    year = "2024",
+    address = "Bangkok, Thailand",
+    publisher = "Association for Computational Linguistics",
+    url = "https://aclanthology.org/2024.sdp-1.13",
+    pages = "135--144",
+}
+```
+### Disclaimer
+<details>
+<summary>Click to expand</summary>
+The model published in this repository is intended for a generalist purpose
+and is made available to third parties under a Apache v2.0 License.
+Please keep in mind that the model may have bias and/or any other undesirable distortions.
+When third parties deploy or provide systems and/or services to other parties using this model
+(or a system based on it) or become users of the model itself, they should note that it is under
+their responsibility to mitigate the risks arising from its use and, in any event, to comply with
+applicable regulations, including regulations regarding the use of Artificial Intelligence.
+In no event shall the owners and creators of the model be liable for any results arising from the use made by third parties.
+</details>