Upload README.md

README.md

@@ -30091,4 +30091,161 @@ configs:
     data_files:
       - split: default
         path: data/vie_zho.jsonl
----
+---
+<h1 align="center">WebFAQ Bilingual Datasets (Bitexts)</h1>
+<h4 align="center">
+   <p>
+       <a href=#overview>Overview</a> |
+       <a href=#details>Details</a>  |
+       <a href=#structure>Structure</a>  |
+       <a href=#examples>Examples</a> |
+       <a href=#considerations>Considerations</a> |
+       <a href=#license>License</a> |
+       <a href=#citation>Citation</a> |
+       <a href=#contact>Contact</a> |
+       <a href=#acknowledgement>Acknowledgement</a>
+   <p>
+</h4>
+
+## Overview
+
+The **WebFAQ Bilingual Datasets** (a.k.a. **Bitexts**) are derived from the [WebFAQ Q&A Dataset](https://huggingface.co/datasets/anonymous202501/webfaq), but instead of monolingual question-answer (QA) pairs, each entry here contains **aligned QA pairs** in **two different languages**. These alignments are created via **state-of-the-art bitext mining** techniques (cross-lingual sentence embeddings) and an **automated translation evaluation** step using an LLM (GPT-4o-mini).
+
+The resulting bitext corpora span **over 1,000 language pairs** (from the original 75 languages in WebFAQ), offering a **high-quality resource** for **machine translation, cross-lingual IR**, and **bitext mining** research.
+
+**Why is it useful?**  
+- Curated **bilingual** dataset with QA pairs aligned across languages.  
+- Large coverage: **1.5 million** aligned question-answer pairs.  
+- Facilitates **training/testing of cross-lingual models** (e.g., for sentence embedding, CLIR, or neural machine translation).  
+
+**Background**  
+- Aligned data extracted from **FAQ pages** on the web annotated with [schema.org FAQPage](https://schema.org/FAQPage).  
+- Built using [Web Data Commons](https://webdatacommons.org) outputs (Oct 2022 – Oct 2024 Common Crawl snapshots).  
+- Aligned via [LaBSE](https://aclanthology.org/2022.acl-long.62) embeddings and GPT-based translation checks, yielding **~95% precision** on the sampled evaluation.
+
+## Details
+
+### Language Coverage
+
+Each of the **bilingual datasets** corresponds to a specific language pair, e.g., `eng-deu`, `eng-fra`, etc. In total, there are over **1,000** language combinations, each containing **≥100** aligned QA pairs (with the largest subsets including tens of thousands of pairs).
+
+- The top frequent language pairs include `deu-eng`, `eng-fra`, `eng-spa`, each with **30k+** aligned samples.  
+- Less frequent language pairs still have **≥100** QA alignments, making them suitable for smaller-scale bilingual tasks.
+
+### Construction Method
+1. **Extraction of QAs** from WebFAQ (removing near-duplicates).  
+2. **Computation of LaBSE embeddings** for each QA text.  
+3. **Similarity-based candidate matching** within the **same website** but across different languages.  
+4. **Automated QA alignment validation**: GPT-based translation scoring to prune low-quality matches, targeting ~95% precision.
+
+## Structure
+
+Each dataset file focuses on **one language pair**, e.g. `eng-deu`. The typical row structure includes:
+ 
+- **`origin`**: Specifies the FAQ's website through scheme, host, and optionally, port.  
+- **`labse_similarity`**: LaBSE similarity score between the concatenated text of question and answer in the two languages.
+- **`url`**: URL of the webpage where the QA pair was extracted.  
+- **`question1`**: Question in the first language.  
+- **`question2`**: Question in the second language.  
+- **`answer1`**: Answer in the first language.  
+- **`answer2`**: Answer in the second language.  
+- **`details`**: Additional metadata such as `urls`, `topics`, or `question types` of the two original QA pairs.
+
+> **Note**: The bilingual dataset does not include an official train/validation/test split. If you require such splits (e.g., for training models), you can create them programmatically. Furthermore, the language pair is not given as a field in the dataset, as it is specified through the selected subset. The topic and question type are given only for those QAs in languages among the 49 languages with ≥100 websites.
+
+## Examples
+
+A sample row in JSON-like form (e.g., `eng-fra` dataset) might look like:
+
+```json
+{
+  "origin": "http://hanting.airporthotelshanghai.com",
+  "labse_similarity": 0.946659,
+  "question1": "Wieviel kostet der Aufenthalt in der Hanting Express Shanghai Pudong Airport?",
+  "question2": "Hanting Express Shanghai Pudong Airportの宿泊料金はいくらですか？",
+  "answer1": "Die Preise beginnen bei CNY264, Dies hängt vom Zimmertyp und dem Datum ab.",
+  "answer2": "宿泊料金はCNY264から、部屋のタイプと日付によって異なります。",
+  "details": {
+    "urls": ["http://hanting.airporthotelshanghai.com/de/", "http://hanting.airporthotelshanghai.com/ja/"],
+    "topics": [ "Traveling and Hospitality", "Traveling and Hospitality"],
+    "question_types": ["What", "Is, are, do, does"]
+  }
+}
+```
+
+**Loading with 🤗 Datasets** (pseudo-example):
+```python
+from datasets import load_dataset
+
+# e.g. load the 'eng-deu' bitext subset
+dataset = load_dataset("anonymous202501/webfaq-bitexts", "deu-jpn")["default"]
+
+print(dataset[0])
+# Example output:
+# {
+#   'origin': 'http://hanting.airporthotelshanghai.com',
+#   'labse_similarity': 0.946659,
+#   'question1': 'Wieviel kostet der Aufenthalt in der Hanting Express Shanghai Pudong Airport?',
+#   'question2': 'Hanting Express Shanghai Pudong Airportの宿泊料金はいくらですか？',
+#   'answer1': 'Die Preise beginnen bei CNY264, Dies hängt vom Zimmertyp und dem Datum ab.',
+#   'answer2': '宿泊料金はCNY264から、部屋のタイプと日付によって異なります。',
+#   'details': {
+#     'urls': ['http://hanting.airporthotelshanghai.com/de/', 'http://hanting.airporthotelshanghai.com/ja/'],
+#     'topics': ['Traveling and Hospitality', 'Traveling and Hospitality'],
+#     'question_types': ['What', 'Is, are, do, does']
+#   }
+# }
+```
+
+## Considerations
+
+Please note the following considerations when using the collected QAs:
+
+- *[Q&A Dataset]* **Risk of Duplicate or Near-Duplicate Content**: The raw Q&A dataset is large and includes minor paraphrases.  
+- *[Retrieval Dataset]* **Sparse Relevance**: As raw FAQ data, each question typically has one “best” (on-page) answer. Additional valid answers may exist on other websites but are not labeled as relevant.  
+- **Language Detection Limitations**: Some QA pairs mix languages, or contain brand names, which can confuse automatic language classification.  
+- **No Guarantee of Factual Accuracy**: Answers reflect the content of the source websites. They may include outdated, biased, or incorrect information.  
+- **Copyright and Privacy**: Please ensure compliance with any applicable laws and the source website’s terms.
+
+#### Additional remarks
+
+1. **Translation Quality**  
+   - While GPT-based scoring ensures ~95% precision, noise may still exist.  
+   - Some FAQ pairs could be partially relevant or partially aligned.
+
+2. **Unbalanced Pair Sizes**  
+   - Large pairs (e.g., `eng-deu`) contain more data than smaller ones (e.g., `fas-lit`).
+
+## License
+
+The **Collection of WebFAQ Datasets** is shared under [**Creative Commons Attribution 4.0 (CC BY 4.0)**](https://creativecommons.org/licenses/by/4.0/) license.
+
+> **Note**: The dataset is derived from public webpages in Common Crawl snapshots (2022–2024) and intended for **research purposes**. Each FAQ’s text is published by the original website under their terms. Downstream users should verify any usage constraints from the **original websites** as well as [Common Crawl’s Terms of Use](https://commoncrawl.org/terms-of-use/).
+
+## Citation
+
+If you use this dataset in your research, please consider citing the associated paper:
+
+```bibtex
+@misc{webfaq2025,
+  title     = {WebFAQ: A Multilingual Collection of Natural Q&A Datasets for Dense Retrieval},
+  author    = {Anonymous Author(s)},
+  year      = {2025},
+  howpublished = {...},
+  note      = {Under review}
+}
+```
+
+## Contact
+
+TBD
+
+## Acknowledgement
+
+We thank the Common Crawl and Web Data Commons teams for providing the underlying data, and all contributors who helped shape the WebFAQ project.
+
+### Thank you
+
+We hope the **Collection of WebFAQ Datasets** serves as a valuable resource for your research. Please consider citing it in any publications or projects that use it. If you encounter issues or want to contribute improvements, feel free to get in touch with us on HuggingFace or GitHub.
+
+Happy researching!