Create README.md

README.md

@@ -0,0 +1,51 @@
+MK-RoBERTa base model
+Pretrained model on Macedonia language using a masked language modeling (MLM) objective. It was introduced in this paper and first released in this repository. This model is case-sensitive: it makes a difference between скопје and Скопје.
+
+Model description
+RoBERTa is a transformers model pretrained on a large corpus of мацед data in a self-supervised fashion. This means it was pretrained on the raw texts only, with no humans labelling them in any way (which is why it can use lots of publicly available data) with an automatic process to generate inputs and labels from those texts.
+
+More precisely, it was pretrained with the Masked language modeling (MLM) objective. Taking a sentence, the model randomly masks 15% of the words in the input then run the entire masked sentence through the model and has to predict the masked words. This is different from traditional recurrent neural networks (RNNs) that usually see the words one after the other, or from autoregressive models like GPT which internally mask the future tokens. It allows the model to learn a bidirectional representation of the sentence.
+
+This way, the model learns an inner representation of the English language that can then be used to extract features useful for downstream tasks: if you have a dataset of labeled sentences for instance, you can train a standard classifier using the features produced by the BERT model as inputs.
+
+Intended uses & limitations
+You can use the raw model for masked language modeling, but it's mostly intended to be fine-tuned on a downstream task. See the model hub to look for fine-tuned versions on a task that interests you.
+
+Note that this model is primarily aimed at being fine-tuned on tasks that use the whole sentence (potentially masked) to make decisions, such as sequence classification, token classification or question answering. For tasks such as text generation you should look at model like GPT2.
+
+How to use
+You can use this model directly with a pipeline for masked language modeling:
+
+>>> from transformers import pipeline
+>>> unmasker = pipeline('fill-mask', model='macedonizer/mk-roberta-base')
+>>> unmasker("Скопје е <mask> град на Македонија.")
+
+[{'sequence': 'Скопје е главен град на Македонија.',
+    'score': 0.5900368094444275,
+    'token': 2782,
+    'token_str': ' главен'},
+  {'sequence': 'Скопје е главниот град на Македонија.',
+   'score': 0.1789761781692505,
+   'token': 3177,
+   'token_str': ' главниот'},
+  {'sequence': 'Скопје е административен град на Македонија.',
+   'score': 0.01679774932563305,
+   'token': 9563,
+   'token_str': ' административен'},
+  {'sequence': 'Скопје е мал град на Македонија.',
+   'score': 0.016263898462057114,
+   'token': 2473,
+   'token_str': ' мал'},
+  {'sequence': 'Скопје е најголемиот град на Македонија.',
+   'score': 0.01312252413481474,
+   'token': 4271,
+   'token_str': ' најголемиот'}]
+
+Here is how to use this model to get the features of a given text in PyTorch:
+
+from transformers import RobertaTokenizer, RobertaModel
+tokenizer = RobertaTokenizer.from_pretrained('macedonizer/mk-roberta-base')
+model = RobertaModel.from_pretrained('macedonizer/mk-roberta-base')
+text = "Replace me by any text you'd like."
+encoded_input = tokenizer(text, return_tensors='pt')
+output = model(**encoded_input)