Update README.md

README.md

@@ -76,6 +76,8 @@ Users (both direct and downstream) should be made aware of the risks, biases and
 
 Use the code below to get started with the model.
 
+Using pipeline
+
 ```python
 from transformers import pipeline, set_seed
 gpt_web_bg = pipeline('text-generation', model='/usmiva/gpt_web_bg', max_length=50, num_beams=3, temperature=0.8)
@@ -88,14 +90,24 @@ gpt_web_bg("По професия той е ")
 ```
 [{'generated_text': 'По професия той е строителен работник, който е �'}]
 
+
+
 ## Training Details
 
 ### 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]
+The process of creating a diverse, bias-proof, and ethically fair dataset requires a meticulous and effective approach to clean the raw text data extracted from the internet. To address this challenge, we propose a specialized, multi-step procedure organized into the following stages:
 
+Deduplication- Duplicate text sequences, often caused by web scraping, are removed from the dataset, thus ensuring that each entry contributes unique information to the training data.
+Topic Classification- To guarantee diverse subject matter and reduce the risk of topic bias, topic classification is employed to categorize text entries based on their content.
+Sentiment Classification- By categorizing entries with sentiment, the dataset diversity is further enhanced, enabling models to better interpret and handle the inherent emotional aspects of human language.
+Hate-Speech Detection- To exclude content promoting hate speech from the dataset, automatic detection methods for Bulgarian are utilized.
+Balancing Topics and Sentiment in the Data- The emphasis is placed on ensuring an adequate balance between topics and sentiment classes, as an imbalanced dataset can lead to biased results. By carefully redistributing instances across topics and sentiment categories, a more representative and inclusive dataset can be assembled, resulting in more robust and adaptable models.
+Cleaning Abusive Content- To further refine the dataset, abusive content, including profanities, vulgar language, and other offensive expressions were cleaned from the text utilizing algorithms for abusive language detection.
+Minimum Sentence Threshold- To ensure that the dataset includes meaningful and coherent text instances, a minimum sentence threshold is imposed, requiring that each entry contains at least five sentences. This condition ensures that models are trained on richer linguistic contexts and promotes more accurate and nuanced text generation.
+Cleaning non Bulgarian content
 ### Training Procedure 
 
 <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
@@ -169,11 +181,11 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ### Model Architecture and Objective
 
-[More Information Needed]
+The model is trained BERT with the masked language modelling objective from scratch on Bulgarian dataset containing data from opensource online media.  
 
 ### Compute Infrastructure
 
-[More Information Needed]
+1 NVIDIA V100 video card
 
 #### Hardware
 
@@ -186,10 +198,11 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 ## 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. -->
+Transformer-Based Language Models for Bulgarian, Marinova et. al. - TBA
 
 **BibTeX:**
 
-[More Information Needed]
+TBA
 
 **APA:**