Update README.md

README.md

@@ -83,33 +83,31 @@ The description of each key (when the instance contains two questions) is as fol
 - **tag:** Type of tag of the article (Inconsistent/Self-contradictory/Contradict-other). 
 - **tagDate:** Date of the tag.
 - **tagReason:** Reason for the tag.
-- **annotationResult:** Results of the human data annotation.
-	- **wikitag_label_valid:** Valid or invalid tag (Valid/Invalid).
-	- **valid_comment:** Comment on the tag.
-	- **paragraphA_article:** Title of article containing passage 1.
-	- **paragraphA_information:** Relevant information of passage 1.
-	- **paragraphA_information_standalone:** Decontextualized relevant information of passage 1.
-	- **paragraphB_article:** Relevant information of passage 2.
-	- **paragraphB_information_standalone:** Decontextualized relevant information of passage 2.
-	- **wikitag_label_samepassage:** Boolean value stating whether passage 1 and passage 2 are the same (Same/Different).
-	- **relevantInfo_comment_A:** Comment on the information of passage 1.
-	- **relevantInfo_comment_B:** Comment on the information of passage 2.
-	- **Contradict type I:** Contradiction type I focuses on the fine-grained semantics of the contradiction, e.g., date/time, location, language, etc. 
-	- **Contradict type II:** Contradiction type II focuses on the modality the contradiction.  It describes the modality of passage 1 and passage 2, whether the information is from a piece of text, or from a row an infobox or a table. 
-	- **Contradict type III:** Contradiction type III focuses on the source the contradiction.  It describes whether passage 1 and passage 2 are from the same article or not. 
-	- **Contradict type IV:** Contradiction type IV focuses on the reasoning aspect.  It describes whether the contraction is explicit or implicit (Explicit/Implicit). Implicit contradiction requires some reasoning to understand why passage 1 and passage 2 are contradicted. 
-	- **taxonomy:** Array of key-values corresponding to contradict type I, contradict type II, contradict type III, and contradict type IV. 
-	- **question1:** Question 1 inferred from the contradiction.
-	- **question1_answer1:** Gold answer to question 1 according to passage 1.
-	- **question1_answer2:** Gold answer to question 1 according to passage 2.
-	- **question2:** Question 2 inferred from the contradiction.
-	- **question2_answer1:** Gold answer to question 2 according to passage 1.
-	- **question2_answer2:** Gold answer to question 2 according to passage 2.    
+- **wikitag_label_valid:** Valid or invalid tag (Valid/Invalid).
+- **valid_comment:** Comment on the tag.
+- **paragraphA_article:** Title of article containing passage 1.
+- **paragraphA_information:** Relevant information of passage 1.
+- **paragraphA_information_standalone:** Decontextualized relevant information of passage 1.
+- **paragraphB_article:** Relevant information of passage 2.
+- **paragraphB_information_standalone:** Decontextualized relevant information of passage 2.
+- **wikitag_label_samepassage:** Boolean value stating whether passage 1 and passage 2 are the same (Same/Different).
+- **relevantInfo_comment_A:** Comment on the information of passage 1.
+- **relevantInfo_comment_B:** Comment on the information of passage 2.
+- **Contradict type I:** Contradiction type I focuses on the fine-grained semantics of the contradiction, e.g., date/time, location, language, etc. 
+- **Contradict type II:** Contradiction type II focuses on the modality the contradiction.  It describes the modality of passage 1 and passage 2, whether the information is from a piece of text, or from a row an infobox or a table. 
+- **Contradict type III:** Contradiction type III focuses on the source the contradiction.  It describes whether passage 1 and passage 2 are from the same article or not. 
+- **Contradict type IV:** Contradiction type IV focuses on the reasoning aspect.  It describes whether the contraction is explicit or implicit (Explicit/Implicit). Implicit contradiction requires some reasoning to understand why passage 1 and passage 2 are contradicted. 
+- **question1:** Question 1 inferred from the contradiction.
+- **question1_answer1:** Gold answer to question 1 according to passage 1.
+- **question1_answer2:** Gold answer to question 1 according to passage 2.
+- **question2:** Question 2 inferred from the contradiction.
+- **question2_answer1:** Gold answer to question 2 according to passage 1.
+- **question2_answer2:** Gold answer to question 2 according to passage 2.    
 
 
 ## Usage of the Dataset
 
-We provide the following starter code:
+We provide the following starter code. Please refer to the [GitHub repository](https://github.com/) for more information about the functions ```load_testingdata``` and ```generateAnswers_bam_models```.
 
 
 ```python
@@ -148,15 +146,16 @@ parameters = TextGenerationParameters(
     max_new_tokens=250,
     min_new_tokens=1,
     decoding_method=DecodingMethod.GREEDY,
-    # length_penalty=LengthPenalty(start_index=5, decay_factor=1.5),
     return_options=TextGenerationReturnOptions(
         # if ordered is False, you can use return_options to retrieve the corresponding prompt
         input_text=True,
     ),
 )
 
+
+# load dataset
 testingUnits = load_testingdata()
-print("question size", len(testingUnits))
+# test LLMs models
 generateAnswers_bam_models(testingUnits)
 ```
 
@@ -246,7 +245,7 @@ If this dataset is utilized in your research, kindly cite the following paper:
 
 **APA:**
 
-[More Information Needed]
+Hou, Y., Pascale, A., Carnerero-Cano, J., Tchrakian, T., Marinescu, R., Daly, E., Padhi, I., & Sattigeri, P. (2024). WikiContradict: A Benchmark for Evaluating LLMs on Real-World Knowledge Conflicts from Wikipedia. arXiv preprint arXiv:2406.13805.
 
 <!-- ## Glossary [optional] -->