First version of the model card

README.md

@@ -0,0 +1,215 @@
+---
+language:
+- sv
+base_model:
+- KB/bert-base-swedish-cased
+pipeline_tag: text-classification
+---
+# Model Card for Model ID
+
+This model was developed as part of the [Computational SLA](https://spraakbanken.gu.se/en/projects/computational-sla) working group at Språkbanken Text.
+It takes essays written in Swedish by second language learners and assigns them one of the [CEFR levels](https://en.wikipedia.org/wiki/Common_European_Framework_of_Reference_for_Languages).
+Of note is that it only uses the first five levels of the scale (A1 to C1), ignoring level C2 due to both lack of training data and it measuring things differently than the other levels do.
+
+
+## Model Details
+
+### Model Description
+
+<!-- Provide a longer summary of what this model is. -->
+
+\[***ADD DETAILS HERE***\]
+
+- **Developed by:** [Språkbanken Text](https://spraakbanken.gu.se/en), as part of the [Computational SLA group](https://spraakbanken.gu.se/en/projects/computational-sla)
+- **Shared by:** Ricardo Muñoz Sánchez ([rimusa](https://huggingface.co/rimusa))
+- **Model type:** BERT for text classification
+- **Language(s):** Swedish
+- **License:** [More Information Needed]
+- **Finetuned from model:** [KB/bert-base-swedish-cased](https://huggingface.co/KB/bert-base-swedish-cased)
+
+### 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:**
+
+```
+@inproceedings{sanchez-etal-2024-jingle,
+    title = "Jingle {BERT}, Jingle {BERT}, Frozen All the Way: Freezing Layers to Identify {CEFR} Levels of Second Language Learners Using {BERT}",
+    author = "Mu{\~n}oz S{\'a}nchez, Ricardo  and
+      Alfter, David  and
+      Dobnik, Simon  and
+      Szawerna, Maria Irena  and
+      Volodina, Elena",
+    editor = {Gaillat, Thomas  and
+      Mallart, Cyriel  and
+      Moreau, Fabienne  and
+      Li, Jen-Yu  and
+      Drouet, Griselda  and
+      Alfter, David  and
+      Volodina, Elena  and
+      J{\"o}nsson, Arne},
+    booktitle = "Proceedings of the 13th Workshop on Natural Language Processing for Computer Assisted Language Learning",
+    month = oct,
+    year = "2024",
+    address = "Rennes, France",
+    publisher = "LiU Electronic Press",
+    url = "https://aclanthology.org/2024.nlp4call-1.11/",
+    pages = "137--152"
+}
+```
+
+**APA:**
+
+Ricardo Muñoz Sánchez, David Alfter, Simon Dobnik, Maria Irena Szawerna, and Elena Volodina. 2024. Jingle BERT, Jingle BERT, Frozen All the Way: Freezing Layers to Identify CEFR Levels of Second Language Learners Using BERT. In Proceedings of the 13th Workshop on Natural Language Processing for Computer Assisted Language Learning, pages 137–152, Rennes, France. LiU Electronic Press.
+
+## Model Card Authors
+
+Ricardo Muñoz Sánchez ([rimusa](https://huggingface.co/rimusa))
+
+## Model Card Contact
+
+[More Information Needed]