README.md

---
license: mit
language:
- cs
---

# Model Card for Model ID

<!-- Provide a quick summary of what the model is/does. -->

Fine-tuned multilingual BART model for Czech Grammatical Error Correction.

## Model Details

### Model Description

<!-- Provide a longer summary of what this model is. -->



- **Developed by:** Satoru Katsumata
- **Shared by [optional]:** [More Information Needed]
- **Model type:** [More Information Needed]
- **Language(s) (NLP):** Czech
- **License:** MIT License
- **Finetuned from model [optional]:** Fairseq multilingual BART-large ([mbart.CC25](https://github.com/Katsumata420/generic-pretrained-GEC/tree/master/mBART-GEC/examples/mbart#pre-trained-models))

### Model Sources [optional]

<!-- Provide the basic links for the model. -->

- **Repository:** https://github.com/Katsumata420/generic-pretrained-GEC
- **Paper [optional]:** [Stronger Baselines for Grammatical Error Correction Using a Pretrained Encoder-Decoder Model.](https://aclanthology.org/2020.aacl-main.83/)
- **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. -->
Since this model was trained with fairseq, fairseq must be used during inference as well.  
More details can be found in the [README](https://github.com/Katsumata420/generic-pretrained-GEC/blob/master/mBART-GEC/README.md).

This fine-tuned model must be used with a binary file.  
The binary file can be downloaded [here](https://drive.google.com/drive/folders/1oECT9q06j9r0whKmp8cqgpzvXINFutoX?usp=share_link).

### 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

See this [README](https://github.com/Katsumata420/generic-pretrained-GEC/blob/master/mBART-GEC/HOW_TO_REPRODUCE.md).

### Training Data

<!-- 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. -->

[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 Data 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. -->

- m2scorer
  - https://www.comp.nus.edu.sg/~nlp/conll14st.html
  - metrics
    - Precision
    - Recall
    - F0.5

### Results

This model achieved the following results for AKCES-GEC test data.

- Precision: 75.75
- Recall: 61.41
- F0.5: 72.37

#### 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:**

```bib
@inproceedings{katsumata2020AACL,
    title = {Stronger Baselines for Grammatical Error Correction Using a Pretrained Encoder-Decoder Model},
    author = {Satoru Katsumata and Mamoru Komachi},
    booktitle = {Proceedings of AACL-IJCNLP 2020}
    year = {2020},
}
```

**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]

Satoru Katsumata

## Model Card Contact

[More Information Needed]