Update README.md

README.md

@@ -72,6 +72,8 @@ language:
 - en
 - fr
 pretty_name: CLIRudit
+tags:
+- research papers
 ---
 
 # Dataset Card for CLIRudit
@@ -91,4 +93,107 @@ The dataset includes only Érudit **research articles** containing both abstract
 The translations between languages were provided by the original authors of the articles.
 
 As an _empirical upper bound_, we also include the actual English translations of the French titles, subtitles, and abstracts as documents.
-This represents the best possible performance that can be achieved by a retrieval method with perfect translation.
+This represents the best possible performance that can be achieved by a retrieval method with perfect translation.
+
+
+## Dataset Details
+
+### Dataset Description
+
+<!-- Provide a longer summary of what this dataset is. -->
+
+- **Language(s) (NLP):** English, French
+- **License:** CC BY-NC 4.0. The dataset should not be used for any commercial purpose.
+
+
+### Dataset Sources
+
+<!-- Provide the basic links for the dataset. -->
+
+- **Repository:** TBA
+- **Paper:** [CLIRudit: Cross-Lingual Information Retrieval of Scientific Documents](TODO)
+
+
+## Uses
+
+The dataset is meant to be used to evaluate cross-lingual IR models.
+
+
+## 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. -->
+
+### Data Instances
+
+A typical instance of the `docs` subset looks like:
+
+```
+{
+  'docid': '000200ar',
+  'title': 'Le charme féminin chez les Peuls Djeneri du Mali',
+  'subtitle': 'Un « objet » de la nature ou de la culture?',
+  'abstract': 'La notion de charme soulève une confusion de sens, car elle est souvent utilisée dans un sens commun...',
+}
+```
+
+A typical instance of the `queries` subset looks like:
+
+```
+{
+  'qid': 0,
+  'query': '"biblioclasts", books with holes, picture books'
+}
+```
+
+A typical instance of the `qrels` subset looks like:
+
+```
+{
+  'qid': 0,
+  'docid': '1089655ar',
+  'rel': 1
+}
+```
+
+
+
+
+### Data Fields
+
+- `qid`: query id
+- `query`: query text
+- `docid`: document id in Érudit
+- `title`: article title, if any
+- `subtitle`: article subtitle,  if any
+- `abstract`: article abstract
+- `rel`: relevance tag (currently only positives are tagged with 1)
+
+<!-- Note that the descriptions can be initialized with the **Show Markdown Data Fields** output of the [Datasets Tagging app](https://huggingface.co/spaces/huggingface/datasets-tagging), you will then only need to refine the generated descriptions. -->
+
+
+
+### Data Splits
+
+There is one `subset` per dataset component (documents, queries, qrels). 
+`split` is used to represent language and train/test split. 
+
+For qrels, we first indicate query lang and then doc lang in the `split` name; e.g., `en_fr.test` means test split judgments with English queries and French documents. 
+
+
+
+
+## Citation
+
+<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+
+**BibTeX:**
+
+```bibtex
+@article{
+  TODO 
+}
+```
+
+**APA:**
+
+TODO