Upload README.md with huggingface_hub

README.md

@@ -1,58 +1,56 @@
 ---
-dataset_info:
-  features:
-  - name: id
-    dtype: string
-    id: field
-  - name: category
-    dtype: string
-    id: field
-  - name: original-instruction
-    dtype: string
-    id: field
-  - name: original-context
-    dtype: string
-    id: field
-  - name: original-response
-    dtype: string
-    id: field
-  - name: new-instruction
-    sequence:
-    - name: user_id
-      dtype: string
-    - name: value
-      dtype: string
-    - name: status
-      dtype: string
-    id: question
-  - name: new-context
-    sequence:
-    - name: user_id
-      dtype: string
-    - name: value
-      dtype: string
-    - name: status
-      dtype: string
-    id: question
-  - name: new-response
-    sequence:
-    - name: user_id
-      dtype: string
-    - name: value
-      dtype: string
-    - name: status
-      dtype: string
-    id: question
-  - name: external_id
-    dtype: string
-    id: external_id
-  splits:
-  - name: train
-    num_bytes: 25502887
-    num_examples: 15015
-  download_size: 15556858
-  dataset_size: 25502887
+{}
 ---
-# Dataset Card for "databricks-dolly-15k-curated-en"
+## Guidelines
+
+In this dataset, you will find a collection of records that show a category, an instruction, a context and a response to that instruction. The aim of the project is to correct the instructions, intput and responses to make sure they are of the highest quality and that they match the task category that they belong to. All three texts should be clear and include real information. In addition, the response should be as complete but concise as possible.
+
+To curate the dataset, you will need to provide an answer to the following text fields:
+
+1 - Final instruction:
+The final version of the instruction field. You may copy it using the copy icon in the instruction field. Leave it as it is if it's ok or apply any necessary corrections. Remember to change the instruction if it doesn't represent well the task category of the record.
+
+2 - Final context:
+The final version of the instruction field. You may copy it using the copy icon in the context field. Leave it as it is if it's ok or apply any necessary corrections. If the task category and instruction don't need of an context to be completed, leave this question blank.
+
+3 - Final response:
+The final version of the response field. You may copy it using the copy icon in the response field. Leave it as it is if it's ok or apply any necessary corrections. Check that the response makes sense given all the fields above.
+
+You will need to provide at least an instruction and a response for all records. If you are not sure about a record and you prefer not to provide a response, click Discard.
+
+## Fields
+
+* `id` is of type <class 'str'>
+* `category` is of type <class 'str'>
+* `original-instruction` is of type <class 'str'>
+* `original-context` is of type <class 'str'>
+* `original-response` is of type <class 'str'>
+
+
+## Questions
+
+* `new-instruction` : Write the final version of the instruction, making sure that it matches the task category. If the original instruction is ok, copy and paste it here.
+* `new-context` : Write the final version of the context, making sure that it makes sense with the task category. If the original context is ok, copy and paste it here. If an context is not needed, leave this empty.
+* `new-response` : Write the final version of the response, making sure that it matches the task category and makes sense for the instruction (and context) provided. If the original response is ok, copy and paste it here.
+
+
+## Load with Argilla
+
+To load this dataset 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/databricks-dolly-15k-curated-en')
+```
+
+## 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/databricks-dolly-15k-curated-en')
+```
 
-[More Information needed](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)