Goader
/

liberta-large

@@ -1,201 +1,114 @@
 ---
 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
+license: cc-by-4.0
+datasets:
+- uonlp/CulturaX
+language:
+- uk
+pipeline_tag: fill-mask
 ---
+# LiBERTa
 <!-- Provide a quick summary of what the model is/does. -->
+LiBERTa Large is a BERT-like model pre-trained from scratch exclusively for Ukrainian. It was presented during the [UNLP](https://unlp.org.ua/) @ [LREC-COLING 2024](https://lrec-coling-2024.org/). Further details are in the [LiBERTa: Advancing Ukrainian Language Modeling through Pre-training from Scratch](https://aclanthology.org/2024.unlp-1.14/) paper.
 ## Evaluation
 <!-- This section describes the evaluation protocols and provides the results. -->
+Read the [paper](https://aclanthology.org/2024.unlp-1.14/) for more detailed tasks descriptions.
+|                                                                                                                         | NER-UK (Micro F1)   | WikiANN (Micro F1) | UD POS (Accuracy)              | News (Macro F1) |
+|:------------------------------------------------------------------------------------------------------------------------|:------------------------:|:------------------:|:------------------------------:|:----------------------------------------:|
+| <tr><td colspan="5" style="text-align: center;"><strong>Base Models</strong></td></tr>
+| [xlm-roberta-base](https://huggingface.co/FacebookAI/xlm-roberta-base)                                                  | 90.86 (0.81)             | 92.27 (0.09)       | 98.45 (0.07)                   | -                                        |
+| [roberta-base-wechsel-ukrainian](https://huggingface.co/benjamin/roberta-base-wechsel-ukrainian)                        | 90.81 (1.51)             | 92.98 (0.12)       | 98.57 (0.03)                   | -                                        |
+| [electra-base-ukrainian-cased-discriminator](https://huggingface.co/lang-uk/electra-base-ukrainian-cased-discriminator) | 90.43 (1.29)             | 92.99 (0.11)       | 98.59 (0.06)                   | -                                        |
+| <tr><td colspan="5" style="text-align: center;"><strong>Large Models</strong></td></tr>
+| [xlm-roberta-large](https://huggingface.co/FacebookAI/xlm-roberta-large)                                                | 90.16 (2.98)             | 92.92 (0.19)       | 98.71 (0.04)                   | 95.13 (0.49)                             |
+| [roberta-large-wechsel-ukrainian](https://huggingface.co/benjamin/roberta-large-wechsel-ukrainian)                      | 91.24 (1.16)             | __93.22 (0.17)__   | 98.74 (0.06)                   | __96.48 (0.09)__                         |
+| [liberta-large](https://huggingface.co/Goader/liberta-large)                                                            | 91.27 (1.22)             | 92.50 (0.07)       | 98.62 (0.08)                   | 95.44 (0.04)                             |
+| [liberta-large-v2](https://huggingface.co/Goader/liberta-large-v2)                                                      | __91.73 (1.81)__         | __93.22 (0.14)__   | __98.79 (0.06)__               | 95.67 (0.12)                             |
+## How to Get Started with the Model
+Use the code below to get started with the model. Note, that the repository contains custom code for tokenization:
+Pipeline usage:
+```python
+>>> from transformers import pipeline
+>>> fill_mask = pipeline("fill-mask", "Goader/liberta-large", trust_remote_code=True)
+>>> fill_mask("Арсенальна - найглибша станція <mask> у світі.")
+[{'score': 0.929235577583313,
+  'token': 8670,
+  'token_str': 'метро',
+  'sequence': 'Арсенальна - найглибша станція метро у світі.'},
+ {'score': 0.005501953419297934,
+  'token': 8608,
+  'token_str': 'світла',
+  'sequence': 'Арсенальна - найглибша станція світла у світі.'},
+ {'score': 0.0037314200308173895,
+  'token': 3808,
+  'token_str': 'Європи',
+  'sequence': 'Арсенальна - найглибша станція Європи у світі.'},
+ {'score': 0.0032518072985112667,
+  'token': 21678,
+  'token_str': 'ЮНЕСКО',
+  'sequence': 'Арсенальна - найглибша станція ЮНЕСКО у світі.'},
+ {'score': 0.002941741142421961,
+  'token': 20250,
+  'token_str': 'залізниці',
+  'sequence': 'Арсенальна - найглибша станція залізниці у світі.'}]
+```
+Extracting embeddings:
+```python
+from transformers import AutoTokenizer, AutoModel
+tokenizer = AutoTokenizer.from_pretrained("Goader/liberta-large", trust_remote_code=True)
+model = AutoModel.from_pretrained("Goader/liberta-large")
+encoded = tokenizer('Арсенальна - найглибша станція метро у світі.', return_tensors='pt')
+output = model(**encoded)
+```
+## Citation
 <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+```
+@inproceedings{haltiuk-smywinski-pohl-2024-liberta,
+    title = "{L}i{BERT}a: Advancing {U}krainian Language Modeling through Pre-training from Scratch",
+    author = "Haltiuk, Mykola  and
+      Smywi{\'n}ski-Pohl, Aleksander",
+    editor = "Romanyshyn, Mariana  and
+      Romanyshyn, Nataliia  and
+      Hlybovets, Andrii  and
+      Ignatenko, Oleksii",
+    booktitle = "Proceedings of the Third Ukrainian Natural Language Processing Workshop (UNLP) @ LREC-COLING 2024",
+    month = may,
+    year = "2024",
+    address = "Torino, Italia",
+    publisher = "ELRA and ICCL",
+    url = "https://aclanthology.org/2024.unlp-1.14",
+    pages = "120--128",
+    abstract = "Recent advancements in Natural Language Processing (NLP) have spurred remarkable progress in language modeling, predominantly benefiting English. While Ukrainian NLP has long grappled with significant challenges due to limited data and computational resources, recent years have seen a shift with the emergence of new corpora, marking a pivotal moment in addressing these obstacles. This paper introduces LiBERTa Large, the inaugural BERT Large model pre-trained entirely from scratch only on Ukrainian texts. Leveraging extensive multilingual text corpora, including a substantial Ukrainian subset, LiBERTa Large establishes a foundational resource for Ukrainian NLU tasks. Our model outperforms existing multilingual and monolingual models pre-trained from scratch for Ukrainian, demonstrating competitive performance against those relying on cross-lingual transfer from English. This achievement underscores our ability to achieve superior performance through pre-training from scratch with additional enhancements, obviating the need to rely on decisions made for English models to efficiently transfer weights. We establish LiBERTa Large as a robust baseline, paving the way for future advancements in Ukrainian language modeling.",
+}
+```
+## Licence
+CC-BY 4.0
+## Authors
+The model was trained by Mykola Haltiuk as a part of his Master's Thesis under the supervision of Aleksander Smywiński-Pohl, PhD, AGH University of Krakow.