Update README.md

README.md

@@ -1,47 +1,91 @@
 ---
+widget:
+- text: A family hiking in the mountains
+  example_title: Safe
+- text: A child playing with a puppy
+  example_title: Safe
+- text: A couple kissing passionately in bed
+  example_title: Nsfw
+- text: A woman naked
+  example_title: Nsfw
+- text: A man killing people
+  example_title: Nsfw
+- text: A mass shooting
+  example_title: Nsfw
 license: apache-2.0
-base_model: distilbert/distilroberta-base
-tags:
-- generated_from_trainer
+
+language:
+- en
 metrics:
-- accuracy
 - f1
+- accuracy
 - precision
 - recall
+pipeline_tag: text-classification
+tags:
+- Transformers
+- ' PyTorch'
+- safety
+- innapropriate
+- distiroberta
+datasets:
+- eliasalbouzidi/NSFW-Safe-Dataset
 model-index:
-- name: distilroberta-512-fbeta1.6
-  results: []
+- name: NSFW-Safe-Dataset
+  results:
+  - task:
+      name: Text Classification
+      type: text-classification
+    dataset:
+      name: NSFW-Safe-Dataset
+      type: .
+    metrics:
+    - name: F1
+      type: f1
+      value: 0.975
+    - name: Accuracy
+      type: accuracy
+      value: 0.981
 ---
+# Model Card
+
+<!-- Provide a quick summary of what the model is/does. -->
+
+This model is designed to categorize text into two classes: "safe", or "nsfw" (not safe for work), which makes it suitable for content moderation and filtering applications.
 
-<!-- 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. -->
+The model was trained using a dataset containing 190,000 labeled text samples, distributed among the two classes of "safe" and "nsfw".
 
-# distilroberta-512-fbeta1.6
+The model is based on the Distilroberta-base model. 
 
-This model is a fine-tuned version of [distilbert/distilroberta-base](https://huggingface.co/distilbert/distilroberta-base) on an unknown dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.0736
-- Accuracy: 0.9814
-- F1: 0.9752
-- Fbeta 1.6: 0.9766
-- False positive rate: 0.0169
-- False negative rate: 0.0216
-- Precision: 0.9721
-- Recall: 0.9784
+In terms of performance, the model has achieved a score of 0.975 for F1 (40K exemples).
 
-## Model description
+To improve the performance of the model, it is necessary to preprocess the input text. You can refer to the preprocess function in the app.py file in the following space: <https://huggingface.co/spaces/eliasalbouzidi/distilbert-nsfw-text-classifier>.
+### Model Description
+The model can be used directly to classify text into one of the two classes. It takes in a string of text as input and outputs a probability distribution over the two classes. The class with the highest probability is selected as the predicted class.
 
-More information needed
+- **Developed by:** Centrale Supélec Students
+- **Model type:** 82M
+- **Language(s) (NLP):** English
+- **License:** apache-2.0
 
-## Intended uses & limitations
 
-More information needed
 
-## Training and evaluation data
 
-More information needed
+### Uses
+
+The model can be integrated into larger systems for content moderation or filtering.
+### Training Data
+The training data for finetuning the text classification model consists of a large corpus of text labeled with one of the two classes: "safe" and "nsfw". The dataset contains a total of 190,000 examples, which are distributed as follows:
+
+117,000 examples labeled as "safe"
+
+63,000 examples labeled as "nsfw"
+
+It was assembled by scraping data from the web and utilizing existing open-source datasets. A significant portion of the dataset consists of descriptions for images and scenes. The primary objective was to prevent diffusers from generating NSFW content but it can be used for other moderation purposes.
+
+You can access the dataset : https://huggingface.co/datasets/eliasalbouzidi/NSFW-Safe-Dataset
+
 
-## Training procedure
 
 ### Training hyperparameters
 
@@ -90,7 +134,7 @@ The following hyperparameters were used during training:
 | 0.0433        | 2.7957 | 16408 | 0.0783          | 0.9814   | 0.9751 | 0.9733    | 0.0125              | 0.0289              | 0.9790    | 0.9711 |
 | 0.0398        | 2.8956 | 16994 | 0.0736          | 0.9814   | 0.9752 | 0.9766    | 0.0169              | 0.0216              | 0.9721    | 0.9784 |
 | 0.0431        | 2.9954 | 17580 | 0.0757          | 0.9816   | 0.9754 | 0.9757    | 0.0151              | 0.0240              | 0.9749    | 0.9760 |
-
+We selected the checkpoint with the highest F-beta1.6 score.
 
 ### Framework versions
 
@@ -98,3 +142,37 @@ The following hyperparameters were used during training:
 - Pytorch 2.3.0+cu121
 - Datasets 2.19.0
 - Tokenizers 0.19.1
+  
+### Out-of-Scope Use
+
+It should not be used for any illegal activities.
+
+## Bias, Risks, and Limitations
+
+The model may exhibit biases based on the training data used. It may not perform well on text that is written in languages other than English. It may also struggle with sarcasm, irony, or other forms of figurative language. The model may produce false positives or false negatives, which could lead to incorrect categorization of text.
+
+### Recommendations
+
+
+Users should be aware of the limitations and biases of the model and use it accordingly. They should also be prepared to handle false positives and false negatives. It is recommended to fine-tune the model for specific downstream tasks and to evaluate its performance on relevant datasets.
+
+
+### Load model directly
+```python
+from transformers import AutoTokenizer, AutoModelForSequenceClassification
+
+tokenizer = AutoTokenizer.from_pretrained("eliasalbouzidi/distilroberta-nsfw-text-classifier")
+
+model = AutoModelForSequenceClassification.from_pretrained("eliasalbouzidi/distilroberta-nsfw-text-classifier")
+
+```
+### Use a pipeline 
+```python
+from transformers import pipeline
+
+pipe = pipeline("text-classification", model="eliasalbouzidi/distilroberta-nsfw-text-classifier")
+```
+
+
+## Contact
+Please reach out to [email protected] if you have any questions or feedback.