Update README.md

README.md

@@ -1,151 +1,247 @@
 ---
-task_categories:
-- question-answering
 language:
 - en
+license: mit
+multilinguality:
+- monolingual
+task_categories:
+- question-answering
+task_ids:
+- closed-domain-qa
+- extractive-qa
+size_categories:
+- 1K<n<10K
+source_datasets:
+- original
 tags:
-- agricultural Extension
+- agriculture
+- Extension
+- agriculture Extension
 - irrigation
-- water research
 pretty_name: AgXQA1.1
-size_categories:
-- 1K<n<10K
+dataset_info:
+  config_name: agxqa_v1
+  features:
+  - name: id
+    dtype: string
+  - name: category
+    dtype: string
+  - name: context
+    dtype: string
+  - name: question
+    dtype: string
+  - name: answers
+    sequence:
+    - name: text
+      dtype: string
+    - name: answer_start
+      dtype: int32
+  - name: references
+    dtype: string
+  splits:
+  - name: train
+    num_examples: 1503
+  - name: validation
+    num_examples: 353
+  - name: test
+    num_examples: 330
+configs:
+- config_name: agxqa_v1
+  default: true
+  data_files:
+  - split: train
+    path: agxqa-train-2024-06-11.jsonl
+  - split: validation
+    path: agxqa-validation-2024-06-11.jsonl
+  - split: test
+    path: agxqa-test-2024-06-11.jsonl
 ---
 
-# Dataset Card for AgXQA1.1
-
-<!-- Provide a quick summary of the dataset. -->
-
-This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
-
-## Dataset Details
-
-### Dataset Description
-
-<!-- Provide a longer summary of what this dataset is. -->
-
-
-
-- **Curated by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-
-### Dataset Sources [optional]
-
-<!-- Provide the basic links for the dataset. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the dataset is intended to be used. -->
-
-### Direct Use
-
-<!-- This section describes suitable use cases for the dataset. -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
-
-[More Information Needed]
+# DISCLAIMER: DUE TO AN ONGOING PUBLICATION REVIEW FOR ITS ASSOCIATED JOURNAL PAPER, THIS REPO IS CURRENTLY EMPTY. THE REST OF THE DATA WILL BE UPLOADED UPON THE PAPER ACCEPTANCE. 
+
+# Dataset Card for AgXQA 1.1
+
+## Table of Contents
+- [Dataset Card for "agxqa_v1"](#dataset-card-for-agxqa_v1)
+  - [Table of Contents](#table-of-contents)
+  - [Dataset Description](#dataset-description)
+    - [Dataset Summary](#dataset-summary)
+    - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+    - [Languages](#languages)
+  - [Dataset Structure](#dataset-structure)
+    - [Data Instances](#data-instances)
+      - [agxqa_v1](#agxqa_v1)
+    - [Data Fields](#data-fields)
+      - [agxqa_v1](#agxqa_v1-1)
+    - [Data Splits](#data-splits)
+  - [Dataset Creation](#dataset-creation)
+    - [Curation Rationale](#curation-rationale)
+    - [Source Data](#source-data)
+      - [Initial Data Collection and Normalization](#initial-data-collection-and-normalization)
+      - [Who are the source language producers?](#who-are-the-source-language-producers)
+    - [Annotations](#annotations)
+      - [Annotation process](#annotation-process)
+      - [Who are the annotators?](#who-are-the-annotators)
+    - [Personal and Sensitive Information](#personal-and-sensitive-information)
+  - [Considerations for Using the Data](#considerations-for-using-the-data)
+    - [Social Impact of Dataset](#social-impact-of-dataset)
+    - [Discussion of Biases](#discussion-of-biases)
+    - [Other Known Limitations](#other-known-limitations)
+  - [Additional Information](#additional-information)
+    - [Licensing Information](#licensing-information)
+    - [Citation Information](#citation-information)
+    - [Contributions](#contributions)
+
+## Dataset Description
+
+- **Homepage:** https://huggingface.co/datasets/msu-ceco/agxqa_v1
+- **Paper:** [TO-DO]()
+- **Point of Contact:** Dr. A.Pouyan Nejadhashemi (pouyan@msu.edu)
+
+### Dataset Summary
+
+The Agricultural eXtension Question Answering Dataset (AgXQA 1.1) is a small-scale, SQuAD-like QA dataset targeting the Agriculture Extension domain. 
+Version 1.1 currently contains 2.1K+ questions related to irrigation topics across the US. The crops of interest are mainly soybean and corn.
+
+### Supported Tasks and Leaderboards
+
+Question Answering.
+
+### Languages
+
+English (`en`).
 
 ## Dataset Structure
 
-<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
-
-[More Information Needed]
+### Data Instances
+
+#### agxqa_v1
+
+An example from the 'test' split looks as follows.
+```
+Please note that the "context" of this example was too long and was cropped:
+
+{
+    "answers": {
+        "answer_start": [78, 21],
+        "text": [' the rate water can enter the soils surface', 'the quantity of water that can enter the soil in a specified time interval']
+    },
+    "context": "Irrigation Fact Sheet # 2: Instantaneous Rates. The soils infiltration rate is the rate water can enter the soils surface. Michigan soils...",
+    "id": "1170477",
+    "question": "what is infiltration rate?",
+    "category": "Irrigation",
+    "references": "Kelley, L. (2007a). Irrigation Fact Sheet # 2 - Irrigation Application Instantaneous Rates. https://www.canr.msu.edu/uploads/235/67987/FactSheets/2_IrrigationApplicationRates1.30.pdf",
+}
+```
+
+### Data agxqa_v1
+
+The data fields are the same among all splits.
+
+#### squad_v2
+- `id`: a `string` feature.
+- `category`: a `string` feature.
+- `context`: a `string` feature.
+- `question`: a `string` feature.
+- `answers`: a dictionary feature containing:
+  - `text`: a `string` feature.
+  - `answer_start`: a `int32` feature.
+- `references`: a `string` feature.
+  
+### Data Splits
+
+| name     |  train | validation | test  |
+| -------- | -----: | ---------: | ----: |
+| agxqa_v1 | 1503   |    353     |  330  |
 
 ## Dataset Creation
 
 ### Curation Rationale
 
-<!-- Motivation for the creation of this dataset. -->
+The creation of this dataset aims to enhance the performance of NLP models (e.g., LLMs) in understanding and extracting relevant information about agro-hydrological practices for crops such as corn and soybeans.
+This dataset 
 
-[More Information Needed]
-
-### Source Data
+### Scope and Domain
 
-<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+The dataset specifically focuses on irrigation practices, techniques, and related agricultural knowledge concerning corn and soybeans. 
+This includes, but is not limited to:
+ - irrigation laws and policies
+ - irrigation methods (e.g., drip, sprinkler, furrow),
+ - irrigation scheduling,
+ - soil moisture monitoring,
+ - crop growth stage,
+ - crop water requirements,
+ - general crop (soybean and corn) characteristics
 
-#### Data Collection and Processing
 
-<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
+### Source Data
 
-[More Information Needed]
+#### Initial Data Collection and Normalization
 
-#### Who are the source data producers?
+About ~600 paragraphs (e.g., context) were extracted from the Agriculture Extension Corpus [(AEC1.1)](https://huggingface.co/datasets/msu-ceco/aec_v1). For more details about AEC1.1's data sources, please refer to its dataset card [here](https://huggingface.co/datasets/msu-ceco/aec_v1#source-data).
 
-<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
 
-[More Information Needed]
+#### Who are the source language producers?
 
-### Annotations [optional]
+ - [CECO](https://huggingface.co/msu-ceco) curated and supervised the creation and annotations of the QA pairs.
+ - Regarding the original paragraphs/contexts, please see [here](https://huggingface.co/datasets/msu-ceco/aec_v1#who-are-the-source-data-producers).
 
-<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
+### Annotations
 
 #### Annotation process
 
-<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
-
-[More Information Needed]
-
-#### Who are the annotators?
-
-<!-- This section describes the people or systems who created the annotations. -->
+We followed the general guidelines described in [Rajpurkar et al. (2016)](https://arxiv.org/abs/1606.05250), which also inspired us to create a SQUAD-like dataset.
+We leveraged [Deepset's annotation tool](https://docs.haystack.deepset.ai/v1.20/docs/annotation) to annotate the paragraphs and create the QA pairs. 
 
-[More Information Needed]
+Our main guidelines can be summarized as follows: 
 
-#### Personal and Sensitive Information
+- Question formulation: Based on the rationale in the paragraph, the extracted questions represented common queries by farmers and agricultural practitioners regarding irrigation.
+- Answer collection: Already present in the paragraph, so the annotations cover both short and long:
+  - clauses
+  - subjects
+  - predicates
+  - phrases (nouns, verbs, adjectives and adverbials)
+- Quality control: Domain experts reviewed and validated the QA pairs to ensure accuracy and relevance. This review was conducted weekly on 50% of the annotated batch (randomly selected) for that week.
+- Diversity and Coverage: Since the crops of interest (soybean and corn) are mostly grown in the Midwest states of the USA, most of the QA pairs cover those states. However, the dataset also includes general irrigation QA pairs, that are applicable in most states.
+- Ethical considerations: To maintain transparency and credibility, we cited the original authors of the annotated paragraphs for each QA pair. Please see the annotated example provided above.
 
-<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
+For more information on the annotation process, please refer to [here (TO_DO)]().
 
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+#### Who are the annotators?
 
-### Recommendations
+There were three annotators in total, two with a background in agricultural topics. Two experts in water and irrigation research hired them, who supervised their annotations.
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+### Personal and Sensitive Information
 
-Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
+* Some of the original paragraphs contained extension educators' names and email addresses, but these have been analyzed accordingly. In other words, they have been replaced with `x`'s in our dataset.
+* For each paragraph, we referenced the main article, where the context was extracted. 
 
-## Citation [optional]
+## Considerations for Using the Data
 
-<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+### Social Impact of Dataset
 
-**BibTeX:**
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
 
-[More Information Needed]
+### Discussion of Biases
 
-**APA:**
+* Version 1.1 is small and only contains irrigation-related topics, so we suggested not using it in production since, in the real world, agriculture-based questions require temporal and geospatial information, which is not covered yet. 
+* We found three paragraphs that contained URLs (links to an Extension YouTube video and a decision support tool). These are outliers and do not necessarily provide implicit answers. They will be removed in version 2.  
 
-[More Information Needed]
+### Other Known Limitations
 
-## Glossary [optional]
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
+## Additional Information
 
-[More Information Needed]
+### Licensing Information
 
-## More Information [optional]
+The dataset is distributed under the [TO-DO] license.
 
-[More Information Needed]
+### Citation Information
 
-## Dataset Card Authors [optional]
+[TO-DO]
 
-[More Information Needed]
 
-## Dataset Card Contact
+### Contributions
 
 [More Information Needed]