burtenshaw HF Staff commited on
Commit
78cbd1c
·
verified ·
1 Parent(s): 7ef70de

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +11 -83
README.md CHANGED
@@ -4,98 +4,20 @@ tags:
4
  - rlfh
5
  - argilla
6
  - human-feedback
7
- configs:
8
- - config_name: default
9
- data_files:
10
- - split: train
11
- path: data/train-*
12
- dataset_info:
13
- features:
14
- - name: id
15
- dtype: string
16
- - name: _server_id
17
- dtype: string
18
- - name: text
19
- dtype: string
20
- - name: label.responses
21
- sequence: string
22
- - name: label.responses.users
23
- sequence: string
24
- - name: label.suggestion
25
- dtype: string
26
- - name: label.suggestion.score
27
- dtype: 'null'
28
- - name: label.suggestion.agent
29
- dtype: 'null'
30
- - name: topics.suggestion
31
- sequence: string
32
- - name: topics.suggestion.score
33
- sequence: float64
34
- - name: topics.suggestion.agent
35
- dtype: 'null'
36
- - name: rating.suggestion
37
- dtype: int64
38
- - name: comment.suggestion.agent
39
- dtype: 'null'
40
- - name: comment_score
41
- dtype: float64
42
- - name: ranking.suggestion.score
43
- dtype: 'null'
44
- - name: span.suggestion.score
45
- dtype: 'null'
46
- - name: comment.suggestion.score
47
- dtype: float64
48
- - name: span.suggestion
49
- list:
50
- - name: end
51
- dtype: int64
52
- - name: label
53
- dtype: string
54
- - name: start
55
- dtype: int64
56
- - name: ranking.suggestion.agent
57
- dtype: 'null'
58
- - name: span.suggestion.agent
59
- dtype: 'null'
60
- - name: ranking.suggestion
61
- sequence: string
62
- - name: rating.suggestion.agent
63
- dtype: 'null'
64
- - name: comment.suggestion
65
- dtype: string
66
- - name: rating.suggestion.score
67
- dtype: 'null'
68
- - name: vector
69
- sequence: float64
70
- splits:
71
- - name: train
72
- num_bytes: 1185
73
- num_examples: 4
74
- download_size: 16225
75
- dataset_size: 1185
76
  ---
77
 
78
  # Dataset Card for test-argilla-dataset
79
 
80
- This dataset has been created with [Argilla](https://argilla-io.github.io).
81
 
82
- - **Homepage:** https://argilla.io
83
- - **Repository:** https://github.com/argilla-io/argilla
84
- - **Paper:**
85
- - **Leaderboard:**
86
- - **Point of Contact:**
87
 
88
- 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).
89
 
90
- This dataset contains:
91
 
92
- * Dataset records in a format compatible with HuggingFace `datasets`. These records will be loaded automatically when using `rg.Dataset.from_hub` and can be loaded independently using the `datasets` library via `load_dataset`.
93
- * The [annotation guidelines](#annotation-guidelines) that have been used for building and curating the dataset, if they've been defined in Argilla.
94
- * A dataset configuration folder conforming to the Argilla dataset format in `.argilla`.
95
 
96
- ## Using this dataset
97
 
98
- ### Load with Argilla
 
 
 
99
 
100
  To load with Argilla, you'll just need to install Argilla as `pip install argilla --pre --upgrade` and then use the following code:
101
 
@@ -107,7 +29,7 @@ ds = rg.Dataset.from_hub("burtenshaw/test-argilla-dataset")
107
 
108
  This will load the settings and records from the dataset repository and push them to the Argilla instance.
109
 
110
- ### Load with `datasets`
111
 
112
  To load the records of this dataset with `datasets`, you'll just need to install `datasets` as `pip install datasets --upgrade` and then use the following code:
113
 
@@ -121,6 +43,12 @@ This will only load the records of the dataset, but not the Argilla settings.
121
 
122
  ## Dataset Structure
123
 
 
 
 
 
 
 
124
  ### Data in Argilla
125
 
126
  The dataset is created in Argilla with: **fields**, **questions**, **suggestions**, **metadata**, **vectors**, and **guidelines**.
 
4
  - rlfh
5
  - argilla
6
  - human-feedback
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  ---
8
 
9
  # Dataset Card for test-argilla-dataset
10
 
 
11
 
 
 
 
 
 
12
 
 
13
 
 
14
 
 
 
 
15
 
 
16
 
17
+ This dataset has been created with [Argilla](https://argilla-io.github.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).
18
+
19
+
20
+ ## Using this dataset with Argilla
21
 
22
  To load with Argilla, you'll just need to install Argilla as `pip install argilla --pre --upgrade` and then use the following code:
23
 
 
29
 
30
  This will load the settings and records from the dataset repository and push them to the Argilla instance.
31
 
32
+ ## Using this dataset with `datasets`
33
 
34
  To load the records of this dataset with `datasets`, you'll just need to install `datasets` as `pip install datasets --upgrade` and then use the following code:
35
 
 
43
 
44
  ## Dataset Structure
45
 
46
+ This dataset repo contains:
47
+
48
+ * Dataset records in a format compatible with HuggingFace `datasets`. These records will be loaded automatically when using `rg.Dataset.from_hub` and can be loaded independently using the `datasets` library via `load_dataset`.
49
+ * The [annotation guidelines](#annotation-guidelines) that have been used for building and curating the dataset, if they've been defined in Argilla.
50
+ * A dataset configuration folder conforming to the Argilla dataset format in `.argilla`.
51
+
52
  ### Data in Argilla
53
 
54
  The dataset is created in Argilla with: **fields**, **questions**, **suggestions**, **metadata**, **vectors**, and **guidelines**.