Upload README.md with huggingface_hub

README.md

@@ -1,55 +1,292 @@
 ---
-dataset_info:
-  features:
-  - name: prompt
-    dtype: string
-    id: field
-  - name: context
-    dtype: string
-    id: field
-  - name: response
-    list:
-    - name: user_id
-      dtype: string
-      id: question
-    - name: value
-      dtype: string
-      id: suggestion
-    - name: status
-      dtype: string
-      id: question
-  - name: response-suggestion
-    dtype: string
-    id: suggestion
-  - name: response-suggestion-metadata
-    struct:
-    - name: type
-      dtype: string
-      id: suggestion-metadata
-    - name: score
-      dtype: float32
-      id: suggestion-metadata
-    - name: agent
-      dtype: string
-      id: suggestion-metadata
-  - name: external_id
-    dtype: string
-    id: external_id
-  - name: metadata
-    dtype: string
-    id: metadata
-  splits:
-  - name: train
-    num_bytes: 5208494
-    num_examples: 1030
-  download_size: 2291723
-  dataset_size: 5208494
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+size_categories: 1K<n<10K
+tags:
+- rlfh
+- argilla
+- human-feedback
 ---
-# Dataset Card for "text-descriptives-metadata"
 
-[More Information needed](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+# Dataset Card for text-descriptives-metadata
+
+This dataset has been created with [Argilla](https://docs.argilla.io).
+
+As shown in the sections below, this dataset can be loaded into Argilla as explained in [Load with Argilla](#load-with-argilla), or used directly with the `datasets` library in [Load with `datasets`](#load-with-datasets).
+
+## Dataset Description
+
+- **Homepage:** https://argilla.io
+- **Repository:** https://github.com/argilla-io/argilla
+- **Paper:** 
+- **Leaderboard:** 
+- **Point of Contact:** 
+
+### Dataset Summary
+
+This dataset contains:
+
+* A dataset configuration file conforming to the Argilla dataset format named `argilla.yaml`. This configuration file will be used to configure the dataset when using the `FeedbackDataset.from_huggingface` method in Argilla.
+
+* Dataset records in a format compatible with HuggingFace `datasets`. These records will be loaded automatically when using `FeedbackDataset.from_huggingface` and can be loaded independently using the `datasets` library via `load_dataset`.
+
+* The [annotation guidelines](#annotation-guidelines) that have been used for building and curating the dataset, if they've been defined in Argilla.
+
+### Load with Argilla
+
+To load with Argilla, you'll just need to install Argilla as `pip install argilla --upgrade` and then use the following code:
+
+```python
+import argilla as rg
+
+ds = rg.FeedbackDataset.from_huggingface("argilla/text-descriptives-metadata")
+```
+
+### Load with `datasets`
+
+To load this dataset with `datasets`, you'll just need to install `datasets` as `pip install datasets --upgrade` and then use the following code:
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset("argilla/text-descriptives-metadata")
+```
+
+### Supported Tasks and Leaderboards
+
+This dataset can contain [multiple fields, questions and responses](https://docs.argilla.io/en/latest/conceptual_guides/data_model.html#feedback-dataset) so it can be used for different NLP tasks, depending on the configuration. The dataset structure is described in the [Dataset Structure section](#dataset-structure).
+
+There are no leaderboards associated with this dataset.
+
+### Languages
+
+[More Information Needed]
+
+## Dataset Structure
+
+### Data in Argilla
+
+The dataset is created in Argilla with: **fields**, **questions**, **suggestions**, **metadata**, and **guidelines**.
+
+The **fields** are the dataset records themselves, for the moment just text fields are supported. These are the ones that will be used to provide responses to the questions.
+
+| Field Name | Title | Type | Required | Markdown |
+| ---------- | ----- | ---- | -------- | -------- |
+| prompt | Prompt | text | True | True |
+| context | Context | text | False | True |
+
+
+The **questions** are the questions that will be asked to the annotators. They can be of different types, such as rating, text, label_selection, multi_label_selection, or ranking.
+
+| Question Name | Title | Type | Required | Description | Values/Labels |
+| ------------- | ----- | ---- | -------- | ----------- | ------------- |
+| response | Response | text | True | N/A | N/A |
+
+
+The **suggestions** are human or machine generated recommendations for each question to assist the annotator during the annotation process, so those are always linked to the existing questions, and named appending "-suggestion" and "-suggestion-metadata" to those, containing the value/s of the suggestion and its metadata, respectively. So on, the possible values are the same as in the table above, but the column name is appended with "-suggestion" and the metadata is appended with "-suggestion-metadata".
+
+**✨ NEW** The **metadata** is a dictionary that can be used to provide additional information about the dataset record. This can be useful to provide additional context to the annotators, or to provide additional information about the dataset record itself. For example, you can use this to provide a link to the original source of the dataset record, or to provide additional information about the dataset record itself, such as the author, the date, or the source. The metadata is always optional, and can be potentially linked to the `metadata_properties` defined in the dataset configuration file in `argilla.yaml`.
+
+The **guidelines**, are optional as well, and are just a plain string that can be used to provide instructions to the annotators. Find those in the [annotation guidelines](#annotation-guidelines) section.
+
+### Data Instances
+
+An example of a dataset instance in Argilla looks as follows:
+
+```json
+{
+    "external_id": null,
+    "fields": {
+        "prompt": "Can brain cells move? By movement I mean long distance migration (preferably within the brain only)."
+    },
+    "metadata": {
+        "alpha_ratio": 0.8,
+        "automated_readability_index": 6.414375,
+        "coleman_liau_index": 10.267499999999998,
+        "dependency_distance_mean": 2.0,
+        "dependency_distance_std": 0.7999999999999999,
+        "doc_length": 20.0,
+        "duplicate_line_chr_fraction": 0.0,
+        "duplicate_ngram_chr_fraction_10": 0.0,
+        "duplicate_ngram_chr_fraction_5": 0.0,
+        "duplicate_ngram_chr_fraction_6": 0.0,
+        "duplicate_ngram_chr_fraction_7": 0.0,
+        "duplicate_ngram_chr_fraction_8": 0.0,
+        "duplicate_ngram_chr_fraction_9": 0.0,
+        "entropy": 0.4352176404374839,
+        "first_order_coherence": 0.2952488958835602,
+        "flesch_kincaid_grade": 3.7550000000000026,
+        "flesch_reading_ease": 82.39000000000001,
+        "gunning_fog": 5.7,
+        "lix": 33.0,
+        "mean_word_length": 4.25,
+        "n_characters": 85,
+        "n_sentences": 2,
+        "n_stop_words": 7.0,
+        "n_tokens": 16,
+        "n_unique_tokens": 15,
+        "oov_ratio": 0.0,
+        "passed_quality_check": "True",
+        "per_word_perplexity": 0.07726496709902252,
+        "perplexity": 1.5452993419804504,
+        "pos_prop_adj": 0.05,
+        "pos_prop_adp": 0.1,
+        "pos_prop_adv": 0.1,
+        "pos_prop_aux": 0.05,
+        "pos_prop_cconj": 0.0,
+        "pos_prop_det": 0.05,
+        "pos_prop_intj": 0.0,
+        "pos_prop_noun": 0.3,
+        "pos_prop_num": 0.0,
+        "pos_prop_part": 0.0,
+        "pos_prop_pron": 0.05,
+        "pos_prop_propn": 0.0,
+        "pos_prop_punct": 0.2,
+        "pos_prop_sconj": 0.0,
+        "pos_prop_space": 0.0,
+        "pos_prop_sym": 0.0,
+        "pos_prop_verb": 0.1,
+        "pos_prop_x": 0.0,
+        "prop_adjacent_dependency_relation_mean": 0.5333333333333333,
+        "prop_adjacent_dependency_relation_std": 0.06666666666666665,
+        "proportion_bullet_points": 0.0,
+        "proportion_ellipsis": 0.0,
+        "proportion_unique_tokens": 0.9375,
+        "rix": 2.0,
+        "second_order_coherence": 0.0,
+        "sentence_length_mean": 8.0,
+        "sentence_length_median": 8.0,
+        "sentence_length_std": 4.0,
+        "smog": 0.0,
+        "source": "stackexchange",
+        "syllables_per_token_mean": 1.375,
+        "syllables_per_token_median": 1.0,
+        "syllables_per_token_std": 0.5994789404140899,
+        "symbol_to_word_ratio_#": 0.0,
+        "token_length_mean": 5.0625,
+        "token_length_median": 4.5,
+        "token_length_std": 2.461421083439402,
+        "top_ngram_chr_fraction_2": 0.0,
+        "top_ngram_chr_fraction_3": 0.0,
+        "top_ngram_chr_fraction_4": 0.0
+    },
+    "responses": [],
+    "suggestions": [
+        {
+            "agent": null,
+            "question_name": "response",
+            "score": null,
+            "type": null,
+            "value": "The question is relatively broad and one should take into account that the brain not only consists of neurons, but also glial cells (supportive cells) and pre-mitotic neuronal stem cells. Furthermore, as critical fellow-scientists have indicated, developmental stage is very important, as the developing embryonic brain is very different from the adult brain.\nHowever, after sifting through various publications, the answer to the question is actually remarkably simple: Yes, brain cells migrate.\nIn  the adult brain glial cells migrate in the brain (Kl\u00e4mbt, 2009). Glial cells are involved in a myriad of functions, but a notable example of migrating glial cells are the oligodendrocytes that migrate relative long distances to find their target axons onto which they wrap themselves to form the insulating myelin sheath (Tsai and Miller, 2002).\nNeuronal stem cells migrate over long distances in response to injury (Imitola et al., 2004) and they migrate from specific stem-cell locations (e.g., hippocampus and subventricular zone) to other regions (Clarke, 2003).\nPost-mitotic, but non-differentiated neurons have been shown to migrate in the adult brain in fish (Scott et al., 2012), and in mammals and non-human primates as well (Sawada et al., 2011).\nNot surprisingly, glial cells, stem cells and neurons also migrate during embryonic development. Most notably, post-mitotic neurons destined to fulfill peripheral functions have to migrate over relatively long distances from the neural crest to their target locations (Neuroscience, 2nd ed, Neuronal Migration)."
+        }
+    ]
+}
+```
+
+While the same record in HuggingFace `datasets` looks as follows:
+
+```json
+{
+    "context": null,
+    "external_id": null,
+    "metadata": "{\"pos_prop_adj\": 0.05, \"pos_prop_adp\": 0.1, \"pos_prop_adv\": 0.1, \"pos_prop_aux\": 0.05, \"pos_prop_cconj\": 0.0, \"pos_prop_det\": 0.05, \"pos_prop_intj\": 0.0, \"pos_prop_noun\": 0.3, \"pos_prop_num\": 0.0, \"pos_prop_part\": 0.0, \"pos_prop_pron\": 0.05, \"pos_prop_propn\": 0.0, \"pos_prop_punct\": 0.2, \"pos_prop_sconj\": 0.0, \"pos_prop_sym\": 0.0, \"pos_prop_verb\": 0.1, \"pos_prop_x\": 0.0, \"passed_quality_check\": \"True\", \"n_stop_words\": 7.0, \"alpha_ratio\": 0.8, \"mean_word_length\": 4.25, \"doc_length\": 20.0, \"symbol_to_word_ratio_#\": 0.0, \"proportion_ellipsis\": 0.0, \"proportion_bullet_points\": 0.0, \"duplicate_line_chr_fraction\": 0.0, \"duplicate_ngram_chr_fraction_5\": 0.0, \"duplicate_ngram_chr_fraction_6\": 0.0, \"duplicate_ngram_chr_fraction_7\": 0.0, \"duplicate_ngram_chr_fraction_8\": 0.0, \"duplicate_ngram_chr_fraction_9\": 0.0, \"duplicate_ngram_chr_fraction_10\": 0.0, \"top_ngram_chr_fraction_2\": 0.0, \"top_ngram_chr_fraction_3\": 0.0, \"top_ngram_chr_fraction_4\": 0.0, \"oov_ratio\": 0.0, \"entropy\": 0.4352176404374839, \"perplexity\": 1.5452993419804504, \"per_word_perplexity\": 0.07726496709902252, \"dependency_distance_mean\": 2.0, \"dependency_distance_std\": 0.7999999999999999, \"prop_adjacent_dependency_relation_mean\": 0.5333333333333333, \"prop_adjacent_dependency_relation_std\": 0.06666666666666665, \"flesch_reading_ease\": 82.39000000000001, \"flesch_kincaid_grade\": 3.7550000000000026, \"smog\": 0.0, \"gunning_fog\": 5.7, \"automated_readability_index\": 6.414375, \"coleman_liau_index\": 10.267499999999998, \"lix\": 33.0, \"rix\": 2.0, \"token_length_mean\": 5.0625, \"token_length_median\": 4.5, \"token_length_std\": 2.461421083439402, \"sentence_length_mean\": 8.0, \"sentence_length_median\": 8.0, \"sentence_length_std\": 4.0, \"syllables_per_token_mean\": 1.375, \"syllables_per_token_median\": 1.0, \"syllables_per_token_std\": 0.5994789404140899, \"n_tokens\": 16, \"n_unique_tokens\": 15, \"proportion_unique_tokens\": 0.9375, \"n_characters\": 85, \"n_sentences\": 2, \"first_order_coherence\": 0.2952488958835602, \"second_order_coherence\": 0.0, \"pos_prop_space\": 0.0, \"source\": \"stackexchange\"}",
+    "prompt": "Can brain cells move? By movement I mean long distance migration (preferably within the brain only).",
+    "response": [],
+    "response-suggestion": "The question is relatively broad and one should take into account that the brain not only consists of neurons, but also glial cells (supportive cells) and pre-mitotic neuronal stem cells. Furthermore, as critical fellow-scientists have indicated, developmental stage is very important, as the developing embryonic brain is very different from the adult brain.\nHowever, after sifting through various publications, the answer to the question is actually remarkably simple: Yes, brain cells migrate.\nIn  the adult brain glial cells migrate in the brain (Kl\u00e4mbt, 2009). Glial cells are involved in a myriad of functions, but a notable example of migrating glial cells are the oligodendrocytes that migrate relative long distances to find their target axons onto which they wrap themselves to form the insulating myelin sheath (Tsai and Miller, 2002).\nNeuronal stem cells migrate over long distances in response to injury (Imitola et al., 2004) and they migrate from specific stem-cell locations (e.g., hippocampus and subventricular zone) to other regions (Clarke, 2003).\nPost-mitotic, but non-differentiated neurons have been shown to migrate in the adult brain in fish (Scott et al., 2012), and in mammals and non-human primates as well (Sawada et al., 2011).\nNot surprisingly, glial cells, stem cells and neurons also migrate during embryonic development. Most notably, post-mitotic neurons destined to fulfill peripheral functions have to migrate over relatively long distances from the neural crest to their target locations (Neuroscience, 2nd ed, Neuronal Migration).",
+    "response-suggestion-metadata": {
+        "agent": null,
+        "score": null,
+        "type": null
+    }
+}
+```
+
+### Data Fields
+
+Among the dataset fields, we differentiate between the following:
+
+* **Fields:** These are the dataset records themselves, for the moment just text fields are supported. These are the ones that will be used to provide responses to the questions.
+    
+    * **prompt** is of type `text`.
+    * (optional) **context** is of type `text`.
+
+* **Questions:** These are the questions that will be asked to the annotators. They can be of different types, such as `RatingQuestion`, `TextQuestion`, `LabelQuestion`, `MultiLabelQuestion`, and `RankingQuestion`.
+    
+    * **response** is of type `text`.
+
+* **Suggestions:** As of Argilla 1.13.0, the suggestions have been included to provide the annotators with suggestions to ease or assist during the annotation process. Suggestions are linked to the existing questions, are always optional, and contain not just the suggestion itself, but also the metadata linked to it, if applicable.
+    
+    * (optional) **response-suggestion** is of type `text`.
+
+Additionally, we also have two more fields that are optional and are the following:
+
+* **✨ NEW** **metadata:** This is an optional field that can be used to provide additional information about the dataset record. This can be useful to provide additional context to the annotators, or to provide additional information about the dataset record itself. For example, you can use this to provide a link to the original source of the dataset record, or to provide additional information about the dataset record itself, such as the author, the date, or the source. The metadata is always optional, and can be potentially linked to the `metadata_properties` defined in the dataset configuration file in `argilla.yaml`.
+* **external_id:** This is an optional field that can be used to provide an external ID for the dataset record. This can be useful if you want to link the dataset record to an external resource, such as a database or a file.
+
+### Data Splits
+
+The dataset contains a single split, which is `train`.
+
+## Dataset Creation
+
+### Curation Rationale
+
+[More Information Needed]
+
+### Source Data
+
+#### Initial Data Collection and Normalization
+
+[More Information Needed]
+
+#### Who are the source language producers?
+
+[More Information Needed]
+
+### Annotations
+
+#### Annotation guidelines
+
+This is a supervised fine-tuning dataset that contains instructions. Please write the response to the instruction in the response field. Take the context into account when writing the response.
+
+#### Annotation process
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+[More Information Needed]
+
+### Personal and Sensitive Information
+
+[More Information Needed]
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+[More Information Needed]
+
+### Discussion of Biases
+
+[More Information Needed]
+
+### Other Known Limitations
+
+[More Information Needed]
+
+## Additional Information
+
+### Dataset Curators
+
+[More Information Needed]
+
+### Licensing Information
+
+[More Information Needed]
+
+### Citation Information
+
+[More Information Needed]
+
+### Contributions
+
+[More Information Needed]