Update README.md

README.md

@@ -23,7 +23,7 @@ should probably proofread and complete it, then remove this comment. -->
 
 # IKT_classifier_transport_ghg_best
 
-This model is a fine-tuned version of [sentence-transformers/all-mpnet-base-v2](https://huggingface.co/sentence-transformers/all-mpnet-base-v2) on the None dataset.
+This model is a fine-tuned version of [sentence-transformers/all-mpnet-base-v2](https://huggingface.co/sentence-transformers/all-mpnet-base-v2) on the [GIZ/policy_qa_v0_1](https://huggingface.co/datasets/GIZ/policy_qa_v0_1) dataset.
 It achieves the following results on the evaluation set:
 - Loss: 0.4763
 - Precision Macro: 0.8974
@@ -35,19 +35,41 @@ It achieves the following results on the evaluation set:
 
 ## Model description
 
-More information needed
+The model is a multi-class text classifier based on [sentence-transformers/all-mpnet-base-v2](https://huggingface.co/sentence-transformers/all-mpnet-base-v2) and fine-tuned on text sourced from national climate policy documents.
 
 ## Intended uses & limitations
 
-More information needed
+The classifier assigns a class of 'GHG','NOT_GHG', or 'NEGATIVE' to denote alignment with **GHG-related transport targets** in extracted passages from the documents. The 'NEGATIVE' class in this case relates to negative samples not aligning with targets.
+
+The intended use is for climate policy researchers and analysts seeking to automate the process of reviewing lengthy, non-standardized PDF documents to produce summaries and reports. 
+
+The performance of the classifier is middle of the road. On training, the classifier exhibited very good overall performance (F1 ~ 0.9). This performance was evenly balanced between precise identification of true positive classifications (precision ~ 0.9) and a wide net to capture as many true positives as possible (recall ~ 0.9). By contrast, when tested on real world unseen test data, the performance was mediocre (F1 ~ 0.5). However, testing was based on a small out-of-sample dataset. Therefore classification performance may differ in the wild. 
+
 
 ## Training and evaluation data
 
-More information needed
+The training dataset is comprised of labelled passages from 2 sources:
+- [ClimateWatch NDC Sector data](https://www.climatewatchdata.org/data-explorer/historical-emissions?historical-emissions-data-sources=climate-watch&historical-emissions-gases=all-ghg&historical-emissions-regions=All%20Selected&historical-emissions-sectors=total-including-lucf%2Ctotal-including-lucf&page=1). 
+- [IKI TraCS Climate Strategies for Transport Tracker](https://changing-transport.org/wp-content/uploads/20220722_Tracker_Database.xlsx) implemented by GIZ and funded by theInternational Climate Initiative (IKI) of the German Federal Ministry for Economic Affairs and Climate Action (BMWK). Here we utilized the QA dataset (CW_NDC_data_Sector).
+
+The combined dataset[GIZ/policy_qa_v0_1](https://huggingface.co/datasets/GIZ/policy_qa_v0_1) contains ~85k rows. Each row is duplicated twice, to provide varying sequence lengths (denoted by the values 'small', 'medium', and 'large', which correspond to sequence lengths of 60, 85, and 150 respectively - indicated in the 'strategy' column). This effectively means the dataset is reduced by 1/3 in useful size, and the 'strategy' value should be selected based on the use case. For this training, we utilized the 'medium' samples Furthermore, for each row, the 'context' column contains 3 samples of varying quality. The approach used to assess quality and select samples is described below.
+
+The pre-processing operations used to produce the final training dataset were as follows:
+
+1. Dataset is filtered based on 'medium' value in 'strategy' column (sequence length = 85).
+2. For ClimateWatch, all rows are removed as there was assessed to be no taxonomical alignment with the IKITracs labels inherent to the dataset. For IKITracs, labels are assigned based on the presence of certain substrings based on 'parameter' values which correspond to assessments of Net-Zero targets by human annotaters. The specific assignments are as follows:
+> - 'GHG': target_labels_ghg_yes = ['T_Transport_Unc','T_Transport_C']
+> - 'NOT_GHG': target_labels_ghg_no = ['T_Adaptation_Unc', 'T_Adaptation_C', 'T_Transport_O_Unc', 'T_Transport_O_C']
+> - 'NEGATIVE': random sample of other labeled data omitting above labels
+3. If 'context_translated' is available and the 'language' is not English, 'context' is replaced with 'context_translated'. 
+4. The dataset is "exploded" - i.e., the text samples in the 'context' column, which are lists, are converted into separate rows - and labels are merged to align with the associated samples.
+5. The 'match_onanswer' and 'answerWordcount' are used conditionally to select high quality samples (prefers high % of word matches in 'match_onanswer', but will take lower if there is a high 'answerWordcount')
+6. Data is then augmented using sentence shuffle from the ```albumentations``` library and NLP-based insertions using ```nlpaug```.
+
 
 ## Training procedure
 
-- Data augmentation using sentence shuffle but no NLP (poor results)
+The model hyperparameters were tuned using ```optuna``` over 10 trials on a truncated training and validation dataset. The model was then trained over 5 epochs using the best hyperparameters identified.
 
 ### Training hyperparameters