Update README.md

README.md

@@ -1,60 +1,39 @@
 ---
 license: apache-2.0
 base_model: cross-encoder/nli-deberta-v3-base
-tags:
-- generated_from_trainer
-metrics:
-- accuracy
 model-index:
-- name: test_trainer
+- name: Komainu
  results: []
 ---
 
 <!-- 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. -->
 
-# test_trainer
+# Komainu - Content Moderator
 
-This model is a fine-tuned version of [cross-encoder/nli-deberta-v3-base](https://huggingface.co/cross-encoder/nli-deberta-v3-base) on an unknown dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.8729
-- Accuracy: 0.6835
+This model is a fine-tuned version of [cross-encoder/nli-deberta-v3-base](https://huggingface.co/cross-encoder/nli-deberta-v3-base) on [Daijobu.ai's content moderation dataset](https://huggingface.co/datasets/DaijobuAI/moderation_dataset).
 
 ## Model description
 
-More information needed
+This model can identify 9 types of contents to be moderated.
 
-## Intended uses & limitations
-
-More information needed
-
-## Training and evaluation data
-
-More information needed
 
-## Training procedure
+| Category | Output | Definition |
+| -------- | ----- | ---------- |
+| sexual | `0` | Content meant to arouse sexual excitement, such as the description of sexual activity, or that promotes sexual services (excluding sex education and wellness). |
+| hate | `1` | Content that expresses, incites, or promotes hate based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste. |
+| violence | `2` | Content that promotes or glorifies violence or celebrates the suffering or humiliation of others. |
+| harassment | `3` | Content that may be used to torment or annoy individuals in real life, or make harassment more likely to occur. |
+| self-harm | `4` | Content that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting, and eating disorders. |
+| sexual/minors | `5` | Sexual content that includes an individual who is under 18 years old. |
+| hate/threatening | `6` | Hateful content that also includes violence or serious harm towards the targeted group. |
+| violence/graphic | `7` | Violent content that depicts death, violence, or serious physical injury in extreme graphic detail. |
+| fake news | `8` | Fake news
+| OK | `9` | OK
 
-### Training hyperparameters
-
-The following hyperparameters were used during training:
-- learning_rate: 5e-05
-- train_batch_size: 4
-- eval_batch_size: 8
-- seed: 42
-- gradient_accumulation_steps: 2
-- total_train_batch_size: 8
-- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
-- lr_scheduler_type: linear
-- num_epochs: 3.0
-
-### Training results
-
-| Training Loss | Epoch | Step | Validation Loss | Accuracy |
-|:-------------:|:------:|:----:|:---------------:|:--------:|
-| No log | 0.9980 | 245 | 1.2681 | 0.5688 |
-| No log | 2.0 | 491 | 1.0121 | 0.6651 |
-| 1.1214 | 2.9939 | 735 | 0.8729 | 0.6835 |
+## Intended uses & limitations
 
+English language only. Not intended for commercial or production use.
 
 ### Framework versions