Update README.md

README.md

@@ -18,7 +18,9 @@ should probably proofread and complete it, then remove this comment. -->
 
 # predicting_misdirection
 
-This model is a fine-tuned version of [distilbert-base-uncased](https://huggingface.co/distilbert-base-uncased) on an unknown dataset.
+This model is a fine-tuned version of [distilbert-base-uncased](https://huggingface.co/distilbert-base-uncased) on the `misdirection.csv` dataset. 
+The data is cleaned by selecting relevant columns and filtering rows based on whether they are labeled as 'accepted' or 'rejected'. It then groups the data by a unique identifier, concatenates text entries within each group into paragraphs, and prepares these paragraphs as predictors (X). Target labels (y) are derived from the final submission grade, mapping 'accepted' to 'violation' and 'rejected' to 'non-violation'. Finally, the data is split into training and testing sets using stratified sampling with a 20% test size and a random state of 1 for reproducibility.
+
 It achieves the following results on the evaluation set:
 - Loss: 1.0736
 - Accuracy: 0.6937
@@ -28,17 +30,13 @@ It achieves the following results on the evaluation set:
 
 ## Model description
 
-More information needed
+The code begins by loading a DistilBERT model and tokenizer configured for sequence classification with two possible labels. It then preprocesses the data: training and testing text sequences are tokenized using BERT, ensuring uniform length with padding and truncation to 256 tokens.
+A CustomDataset class is defined to organize the tokenized data into a format suitable for PyTorch training, converting labels ('non-violation' and 'violation') into numeric values. Evaluation metrics such as accuracy, precision, recall, and F1 score are set up to assess model performance.
+The main task is hyperparameter optimization using Optuna. An objective function is defined to optimize dropout rate, learning rate, batch size, epochs, and weight decay. For each trial, the data is tokenized again, a new model is initialized with the chosen dropout rate, and a Trainer object manages training and evaluation using these parameters. The goal is to maximize the F1 score across 15 trials.
 
 ## Intended uses & limitations
 
-More information needed
-
-## Training and evaluation data
-
-More information needed
-
-## Training procedure
+Created solely for the Humane Intelligence Algorithmic Bias Bounty
 
 ### Training hyperparameters
 
@@ -53,21 +51,6 @@ The following hyperparameters were used during training:
 - lr_scheduler_type: linear
 - num_epochs: 9
 
-### Training results
-
-| Training Loss | Epoch | Step | Validation Loss | Accuracy | Precision | Recall | F1     |
-|:-------------:|:-----:|:----:|:---------------:|:--------:|:---------:|:------:|:------:|
-| 0.6794        | 1.0   | 28   | 0.6453          | 0.6396   | 0.6908    | 0.6396 | 0.5791 |
-| 0.5817        | 2.0   | 56   | 0.6867          | 0.6396   | 0.6663    | 0.6396 | 0.5924 |
-| 0.3639        | 3.0   | 84   | 0.7680          | 0.6216   | 0.6184    | 0.6216 | 0.6192 |
-| 0.2073        | 4.0   | 112  | 0.8974          | 0.6757   | 0.6732    | 0.6757 | 0.6687 |
-| 0.0729        | 5.0   | 140  | 1.0736          | 0.6937   | 0.6916    | 0.6937 | 0.6917 |
-| 0.1303        | 6.0   | 168  | 1.1722          | 0.6667   | 0.6638    | 0.6667 | 0.6639 |
-| 0.0675        | 7.0   | 196  | 1.4547          | 0.6577   | 0.6597    | 0.6577 | 0.6396 |
-| 0.0682        | 8.0   | 224  | 1.3582          | 0.6486   | 0.6517    | 0.6486 | 0.6497 |
-| 0.0678        | 9.0   | 252  | 1.3401          | 0.6486   | 0.6496    | 0.6486 | 0.6491 |
-
-
 ### Framework versions
 
 - Transformers 4.41.2