Update README.md

README.md

@@ -11,11 +11,26 @@ base_model:
 - microsoft/deberta-v3-base
 
 ---
-# The solution for COLING 2025 Workshop on Detecting AI Generated Content (DAIGenC)
+---
+library_name: transformers
+license: mit
+datasets:
+- Jinyan1/COLING_2025_MGT_en
+language:
+- en
+metrics:
+- f1
+base_model:
+- microsoft/deberta-v3-base
 
-The model that won first place in the [competition](https://genai-content-detection.gitlab.io) in the task-1A.
+---
+# 🏆 Winning model for the COLING 2025 Workshop on Detecting AI Generated Content (DAIGenC)
+
+## Model description
+
+A **binary classification model** of machine-generated fragments that achieved **first place** on the monolingual subtask in the [COLING 2025 GenAI Detection Task](https://genai-content-detection.gitlab.io). The model is a fine-tuned version of DeBERTa-v3-base in multi-task mode with a shared encoder and three parallel heads for classification. Only head is used for inference.
 
-# Get Usage
+## Usage
 
 ```python
 import torch
@@ -45,8 +60,7 @@ model.eval()
 
 inputs = tokenizer(
     ['Hello, Thanks for sharing your health concern with us. I have gone through your query and here are your answers: 1. If you have regular cycles, there is no further need to use any medication to regulate cycles. 2. Establishment of regular ovulation and timing of intercourse properly is necessary. 3. If you want to conceive quickly, you have to get further evaluation and plan management. Hope this helps.',
-     'He might have small intestinal TB rather than stomach TB. Amoebas also involves small intestine/some part of large intestine. If he has taken medicines for both diseases in form of a Complete Course, he should be fine. U can go for an oral+iv contrast CT scan of him. Now, the diagnosis of a lax cardiac can be confirmed by an upper GI endoscopy with manometry (if available). Lax cardiac may cause acidity with reflux.',
-     'In Micronesia during the early 1900s, there was a unique culture known as the Yap. What sets the Yap apart from other cultures is their unusual form of currency - enormous limestone disks called Rai Stones. These massive stones are not easily movable, with the largest one weighing four tons and measuring 12 feet in diameter. Instead of physically exchanging the stones, the Yap people simply keep track of ownership through an intricate system. A fascinating tale revolves around some sailors who attempted to transport a Rai Stone across the ocean but encountered difficulties along the way, resulting in the stone falling into the sea.'],
+     'He might have small intestinal TB rather than stomach TB. Amoebas also involves small intestine/some part of large intestine. If he has taken medicines for both diseases in form of a Complete Course, he should be fine. U can go for an oral+iv contrast CT scan of him. Now, the diagnosis of a lax cardiac can be confirmed by an upper GI endoscopy with manometry (if available). Lax cardiac may cause acidity with reflux.'],
     max_length=512,
     truncation=True,
     padding="max_length",
@@ -58,13 +72,28 @@ torch.softmax(
 ).detach().cpu()[:, 1].tolist()
 ```
 
-# Quality
+## Limitations and bias
+
+This model is limited to a training dataset consisting of generated and human generated texts from different sources and domains over a period of time. It may not be a good fit for all use cases in different domains. In addition, the model may have false positives in some cases, which can be varied by the classification threshold.
+
+## Quality
+
+Quality on the declaired test set in the competition. 
+
+Model | Main Score (F1 Macro) | Auxiliary Score (F1 Micro) |
+--------------------- | --------------------- | -------------------------- |
+|        MTL DeBERTa-v3-base (*our*)         |           **0.8307**           | **0.8311**
+|        Single-task DeBERTa-v30-base         |           0.7852           | 0.7891
+|        *baseline*         |           0.7342           | 0.7343
+
+
+## Training procedure
+
+This model was fine-tuned on train part of English version of the competition data [MGT Detection Task 1](https://huggingface.co/datasets/Jinyan1/COLING_2025_MGT_en) dataset. Class `0 - human`, `1 - machine`. Model was fine-tuned with 2 stages on a single NVIDIA RTX 3090 GPU with hyperparameters described in [our paper](https://arxiv.org/abs/2411.11736).
 
-Quality on the delayed sample of competition organizers.
+## Your Own Fine-Tune
 
-| Main Score (F1 Macro) | Auxiliary Score (F1 Micro) |
-| --------------------- | -------------------------- |
-|        0.8307         |           0.8311           |
+If you would like to fine-tune this architecture on your data domains or base models, we offer you our learn and run code with all instructions, which we have posted on the [GitHub](https://github.com/Advacheck-OU/ai-detector-coling2025).
 
 # Citation