Update README.md

README.md

@@ -11,9 +11,20 @@ licenses:
 
 ## General concept of the model
 
-This model is trained on the dataset of inappropriate messages of the Russian language. The concept of inappropriateness is described [in this article ](https://www.aclweb.org/anthology/2021.bsnlp-1.4/) presented at the workshop for Balto-Slavic NLP at the EACL-2021 conference. Please note that this article describes the first version of the dataset, while the model is trained on the extended version of the dataset open-sourced on our [GitHub](https://github.com/skoltech-nlp/inappropriate-sensitive-topics/blob/main/Version2/appropriateness/Appropriateness.csv) or on [kaggle](https://www.kaggle.com/nigula/russianinappropriatemessages). The properties of the dataset is the same as the one described in the article, the only difference is the size.
+#### Inappropraiteness intuition
+This model is trained on the dataset of inappropriate messages of the Russian language. Generally, an inappropriate utterance is an utterance that has not obscene words or any kind of toxic intent, but can still harm the reputation of the speaker. Find some sample for more intuition in the table below. Learn more about the concept of inappropriateness [in this article ](https://www.aclweb.org/anthology/2021.bsnlp-1.4/) presented at the workshop for Balto-Slavic NLP at the EACL-2021 conference. Please note that this article describes the first version of the dataset, while the model is trained on the extended version of the dataset open-sourced on our [GitHub](https://github.com/skoltech-nlp/inappropriate-sensitive-topics/blob/main/Version2/appropriateness/Appropriateness.csv) or on [kaggle](https://www.kaggle.com/nigula/russianinappropriatemessages). The properties of the dataset are the same as the one described in the article, the only difference is the size.
 
-The model was trained, validated and tested only on the samples with 100% confidence, which allowed to get the following metrics on test set: 
+| Text                                                                                                 | Inappropriate | Comment                                                        | Unsafe topic  |
+|------------------------------------------------------------------------------------------------------|---------------|----------------------------------------------------------------|---------------|
+| Ладно бы видного деятеля завалили а тут какого то ноунейм нигру преступника                          | yes           | Оправдание убийства                                            | offline crime |
+| Это нарушение УКРФ!                                                                                  | no            | Осуждение нарушения закона                                     | offline crime |
+| Религия - это насилие высшего уровня. Верующего принуждают к вере еще в младенчестве.                | yes           | Оскорбление чувств верующих                                    | religion      |
+| Христиане, как вы относитесь к иноверцам, в частности к Гамалиилу и к уверовавшим в Иисуса фарисеям? | no            | Обычные вопросы к верующим без намека на оскорбление их чувств | religion      |
+| Хорошо что проституция запрещена                                                                     | no            | Осуждение простуитуции                                         | prostitution  |
+| Возьму бабки и сниму шлюх на выходных                                                                | yes           | Популяризация проституции                                      | prostitution  |
+
+#### Metrics
+The model was trained, validated, and tested only on the samples with 100% confidence, which allowed to get the following metrics on test set: 
 
 |              | precision | recall | f1-score | support |
 |--------------|----------|--------|----------|---------|
@@ -23,6 +34,12 @@ The model was trained, validated and tested only on the samples with 100% confid
 | macro avg    | 0.86     | 0.85   | 0.85     | 10565   |
 | weighted avg | 0.89     | 0.89   | 0.89     | 10565   |
 
+#### Proposed usage
+
+The 'inappropriateness' substance we tried to collect in the dataset and detect with the model is not a substitution of toxicity, it is rather a derivative of toxicity. So the model based on our dataset could serve as an additional layer of inappropriateness filtering after toxicity and obscenity filtration.
+
+![alt text](https://huggingface.co/Skoltech/russian-inappropriate-messages/blob/main/classifier_all_en.pdf?raw=true)
+
 ## Licensing Information
 
 [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License][cc-by-nc-sa].