Update README.md

README.md

@@ -4,6 +4,7 @@ license: mit
 base_model: FacebookAI/xlm-roberta-base
 tags:
 - generated_from_trainer
+language: de
 metrics:
 - accuracy
 - precision
@@ -17,9 +18,9 @@ model-index:
 <!-- 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. -->
 
-# academic_main_text_classifier_de
+# Academic Main Text_Classifier (de)
 
-This model is a fine-tuned version of [FacebookAI/xlm-roberta-base](https://huggingface.co/FacebookAI/xlm-roberta-base) on the None dataset.
+This model is a fine-tuned version of [FacebookAI/xlm-roberta-base](https://huggingface.co/FacebookAI/xlm-roberta-base) on a labelled dataset of publications in the Bibliography of Linguistic Literature.
 It achieves the following results on the evaluation set:
 - Loss: 0.2342
 - Accuracy: 0.9385
@@ -29,15 +30,60 @@ It achieves the following results on the evaluation set:
 
 ## Model description
 
-More information needed
+The model is fine-tuned with academic publications in Linguistics, to classify texts in publications into 4 classes as a filter to other tasks. Sentence-based data obtained from OCR-processed PDF files was annotated manually with the following classes:
+
+- 0: out of scope - materials that are of low significance, eg. page number and page header, noise from OCR/pdf-to-text convertion
+- 1: main text - texts that are the main texts of the publication, to be used for down-stream tasks
+- 2: examples - texts that are captions of the figures, or quotes or excerpts
+- 3: references - references of the publication, excluding in-text citations
 
 ## Intended uses & limitations
 
-More information needed
+Intended uses:
+
+- filter out noise from OCR of academic texts (conference papers, journals, books etc.)
+- extract main text in academic texts for down-stream NLP tasks
+
+Limitations:
+
+- training and evaluation data is limited to English, and academic texts in Linguistics (though still to a higher extent usable for German texts)
+
+## How to run
+
+```python
+from transformers import pipeline
+
+# define model name
+model_name = "ubffm/academic_text_filter_de"
+
+# run model with hf pipeline
+## return output for the best label
+## eg. [{'label': 'EXAMPLE', 'score': 0.9601941108703613}]
+classifier = pipeline("text-classification", model=model_name, tokenizer=model_name)
+
+## return output for all labels
+## eg. [[{'label': 'OUT OF SCOPE', 'score': 0.007808608002960682}, {'label': 'MAIN TEXT', 'score': 0.028077520430088043}, {'label': 'EXAMPLE', 'score': 0.9601941108703613}, {'label': 'REFERENCE', 'score': 0.003919811453670263}]]
+classifier = pipeline("text-classification", model=model_name, tokenizer=model_name, return_all_scores=True)
+
+# Perform inference on your input text
+your_text = "your text here."
+result = classifier(your_text)
+
+print(result)
+```
+
+## Try it yourself with the following examples (not in training/ evaluation data)
+
+## Problematic cases
 
 ## Training and evaluation data
 
-More information needed
+### Labelled dataset from open access publications of the Bibliography of Linguistic Literature (BLL)
+
+The Bibliography of Linguistic Literature (BLL) is one of the most comprehensive sources of bibliographic information for the general linguistics with its subdomains and neighboring disciplines as well as for the English, German and Romance linguistics. The subject bibliography is based mainly on the library's holdings on linguistics. It lists monographs, dissertations, articles from periodicals, collective works, conference contributions, unpublished research papers, etc. The printed edition is published annually (at the end of each year) and covers the literature of the previous year and some supplements. Usually, it includes about 10,000 references per year. (Frankfurt a. M. : Klostermann, 1.1971/75(1976) - 47.2021 (2022))
+
+(See more at https://www.ub.uni-frankfurt.de/linguistik/sammlung_en.html)
+
 
 ## Training procedure