Edited model card

README.md

@@ -1,64 +1,174 @@
 ---
 tags:
-- generated_from_trainer
+- legal
 model-index:
 - name: legal-croatian-roberta-base
   results: []
+license: cc
+language:
+- hr
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
+# Model Card for joelito/legal-croatian-roberta-base
 
-# legal-croatian-roberta-base
+This model is a monolingual model pretrained on legal data. It is based on XLM-R ([base](https://huggingface.co/xlm-roberta-base) and [large](https://huggingface.co/xlm-roberta-large)). For pretraining we used the Croatian portion of [Multi Legal Pile](https://huggingface.co/datasets/joelito/Multi_Legal_Pile) ([Niklaus et al. 2023](https://arxiv.org/abs/2306.02069?utm_source=tldrai)), a multilingual dataset from various legal sources covering 24 languages.
 
-This model was trained from scratch on an unknown dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.4008
+## Model Details
 
-## Model description
+### Model Description
 
-More information needed
+- **Developed by:** Joel Niklaus: [huggingface](https://huggingface.co/joelito); [email](mailto:joel.niklaus.2@bfh.ch)
+- **Model type:** Transformer-based language model (RoBERTa)
+- **Language(s) (NLP):** Croatian
+- **License:** CC BY-SA
 
-## Intended uses & limitations
+## Uses
 
-More information needed
+### Direct Use and Downstream Use
 
-## Training and evaluation data
+You can utilize the raw model for masked language modeling since we did not perform next sentence prediction. However, its main purpose is to be fine-tuned for downstream tasks.
 
-More information needed
+It's important to note that this model is primarily designed for fine-tuning on tasks that rely on the entire sentence, potentially with masked elements, to make decisions. Examples of such tasks include sequence classification, token classification, or question answering. For text generation tasks, models like GPT-2 are more suitable.
 
-## Training procedure
+Additionally, the model is specifically trained on legal data, aiming to deliver strong performance in that domain. Its performance may vary when applied to non-legal data.
 
-### Training hyperparameters
+### Out-of-Scope Use
 
-The following hyperparameters were used during training:
-- learning_rate: 0.0001
-- train_batch_size: 16
-- eval_batch_size: 16
-- seed: 42
-- distributed_type: tpu
-- num_devices: 8
-- gradient_accumulation_steps: 4
-- total_train_batch_size: 512
-- total_eval_batch_size: 128
-- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
-- lr_scheduler_type: cosine
-- lr_scheduler_warmup_ratio: 0.05
-- training_steps: 200000
+For tasks such as text generation you should look at model like GPT2.
 
-### Training results
+The model should not be used to intentionally create hostile or alienating environments for people. The model was not trained to be factual or true representations of people or events, and therefore using the models to generate such content is out-of-scope for the abilities of this model.
 
-| Training Loss | Epoch | Step   | Validation Loss |
-|:-------------:|:-----:|:------:|:---------------:|
-| 0.8722        | 32.0  | 50000  | 0.5036          |
-| 0.7612        | 64.0  | 100000 | 0.4363          |
-| 0.6916        | 96.0  | 150000 | 0.4080          |
-| 0.6656        | 128.0 | 200000 | 0.4008          |
+## Bias, Risks, and Limitations
 
+Significant research has explored bias and fairness issues with language models (see, e.g., [Sheng et al. (2021)](https://aclanthology.org/2021.acl-long.330.pdf) and [Bender et al. (2021)](https://dl.acm.org/doi/pdf/10.1145/3442188.3445922)). Predictions generated by the model may include disturbing and harmful stereotypes across protected classes; identity characteristics; and sensitive, social, and occupational groups.
 
-### Framework versions
+### Recommendations
 
-- Transformers 4.20.1
-- Pytorch 1.12.0+cu102
-- Datasets 2.9.0
-- Tokenizers 0.12.0
+Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model.
+
+## How to Get Started with the Model
+
+See [huggingface tutorials](https://huggingface.co/learn/nlp-course/chapter7/1?fw=pt). For masked word prediction see [this tutorial](https://huggingface.co/tasks/fill-mask).
+
+## Training Details
+
+This model was pretrained on [Multi Legal Pile](https://huggingface.co/datasets/joelito/Multi_Legal_Pile) ([Niklaus et al. 2023](https://arxiv.org/abs/2306.02069?utm_source=tldrai)).
+
+Our pretraining procedure includes the following key steps:
+
+(a) Warm-starting: We initialize our models from the original XLM-R checkpoints ([base](https://huggingface.co/xlm-roberta-base) and [large](https://huggingface.co/xlm-roberta-large)) of [Conneau et al. (2019)](https://proceedings.neurips.cc/paper/2019/file/c04c19c2c2474dbf5f7ac4372c5b9af1-Paper.pdf) to benefit from a well-trained base.
+
+(b) Tokenization: We train a new tokenizer of 128K BPEs to cover legal language better. However, we reuse the original XLM-R embeddings for lexically overlapping tokens and use random embeddings for the rest.
+
+(c) Pretraining: We continue pretraining on Multi Legal Pile with batches of 512 samples for an additional 1M/500K steps for the base/large model. We use warm-up steps, a linearly increasing learning rate, and cosine decay scheduling. During the warm-up phase, only the embeddings are updated, and a higher masking rate and percentage of predictions based on masked tokens are used compared to [Devlin et al. (2019)](https://aclanthology.org/N19-1423).
+
+(d) Sentence Sampling: We employ a sentence sampler with exponential smoothing to handle disparate token proportions across cantons and languages, preserving per-canton and language capacity.
+
+(e) Mixed Cased Models: Our models cover both upper- and lowercase letters, similar to recently developed large PLMs.
+
+### Training Data
+
+This model was pretrained on the Croatian portion of [Multi Legal Pile](https://huggingface.co/datasets/joelito/Multi_Legal_Pile) ([Niklaus et al. 2023](https://arxiv.org/abs/2306.02069?utm_source=tldrai)).
+
+#### Preprocessing
+
+For further details see [Niklaus et al. 2023](https://arxiv.org/abs/2306.02069?utm_source=tldrai)
+
+#### Training Hyperparameters
+
+- batche size: 512 samples
+- Number of steps: 1M/500K for the base/large model
+- Warm-up steps for the first 5\% of the total training steps
+- Learning rate: (linearly increasing up to) 1e-4
+- Word masking: increased 20/30\% masking rate for base/large models respectively
+
+### Model Architecture and Objective
+
+It is a RoBERTa-based model. Run the following code to view the architecture:
+
+```
+from transformers import AutoModel
+model = AutoModel.from_pretrained('joelito/legal-croatian-roberta-base')
+print(model)
+
+RobertaModel(
+  (embeddings): RobertaEmbeddings(
+    (word_embeddings): Embedding(32000, 768, padding_idx=0)
+    (position_embeddings): Embedding(514, 768, padding_idx=0)
+    (token_type_embeddings): Embedding(1, 768)
+    (LayerNorm): LayerNorm((768,), eps=1e-05, elementwise_affine=True)
+    (dropout): Dropout(p=0.1, inplace=False)
+  )
+  (encoder): RobertaEncoder(
+    (layer): ModuleList(
+      (0-11): 12 x RobertaLayer(
+        (attention): RobertaAttention(
+          (self): RobertaSelfAttention(
+            (query): Linear(in_features=768, out_features=768, bias=True)
+            (key): Linear(in_features=768, out_features=768, bias=True)
+            (value): Linear(in_features=768, out_features=768, bias=True)
+            (dropout): Dropout(p=0.1, inplace=False)
+          )
+          (output): RobertaSelfOutput(
+            (dense): Linear(in_features=768, out_features=768, bias=True)
+            (LayerNorm): LayerNorm((768,), eps=1e-05, elementwise_affine=True)
+            (dropout): Dropout(p=0.1, inplace=False)
+          )
+        )
+        (intermediate): RobertaIntermediate(
+          (dense): Linear(in_features=768, out_features=3072, bias=True)
+          (intermediate_act_fn): GELUActivation()
+        )
+        (output): RobertaOutput(
+          (dense): Linear(in_features=3072, out_features=768, bias=True)
+          (LayerNorm): LayerNorm((768,), eps=1e-05, elementwise_affine=True)
+          (dropout): Dropout(p=0.1, inplace=False)
+        )
+      )
+    )
+  )
+  (pooler): RobertaPooler(
+    (dense): Linear(in_features=768, out_features=768, bias=True)
+    (activation): Tanh()
+  )
+)
+
+```
+
+### Compute Infrastructure
+
+Google TPU.
+
+#### Hardware
+
+Google TPU v3-8
+
+#### Software
+
+pytorch, transformers.
+
+## Citation
+
+```
+
+@article{Niklaus2023MultiLegalPileA6,
+  title={MultiLegalPile: A 689GB Multilingual Legal Corpus},
+  author={Joel Niklaus and Veton Matoshi and Matthias Sturmer and Ilias Chalkidis and Daniel E. Ho},
+  journal={ArXiv},
+  year={2023},
+  volume={abs/2306.02069}
+}
+
+```
+
+## Model Card Authors
+
+Joel Niklaus: [huggingface](https://huggingface.co/joelito); [email](mailto:joel.niklaus.2@bfh.ch)
+
+Veton Matoshi: [huggingface](https://huggingface.co/kapllan); [email](mailto:msv3@bfh.ch)
+
+## Model Card Contact
+
+Joel Niklaus: [huggingface](https://huggingface.co/joelito); [email](mailto:joel.niklaus.2@bfh.ch)
+
+Veton Matoshi: [huggingface](https://huggingface.co/kapllan); [email](mailto:msv3@bfh.ch)