Upload README.md with huggingface_hub

README.md

@@ -4,73 +4,6 @@ tags:
 - rlfh
 - argilla
 - human-feedback
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-dataset_info:
-  features:
-  - name: id
-    dtype: string
-  - name: _server_id
-    dtype: string
-  - name: text
-    dtype: string
-  - name: label.responses
-    sequence: string
-  - name: label.responses.users
-    sequence: string
-  - name: label.suggestion
-    dtype: string
-  - name: label.suggestion.score
-    dtype: 'null'
-  - name: label.suggestion.agent
-    dtype: 'null'
-  - name: topics.suggestion
-    sequence: string
-  - name: topics.suggestion.score
-    sequence: float64
-  - name: topics.suggestion.agent
-    dtype: 'null'
-  - name: rating.suggestion.score
-    dtype: 'null'
-  - name: span.suggestion.score
-    dtype: 'null'
-  - name: comment.suggestion.score
-    dtype: float64
-  - name: rating.suggestion
-    dtype: int64
-  - name: ranking.suggestion.score
-    dtype: 'null'
-  - name: span.suggestion.agent
-    dtype: 'null'
-  - name: comment.suggestion.agent
-    dtype: 'null'
-  - name: comment.suggestion
-    dtype: string
-  - name: span.suggestion
-    list:
-    - name: end
-      dtype: int64
-    - name: label
-      dtype: string
-    - name: start
-      dtype: int64
-  - name: ranking.suggestion
-    sequence: string
-  - name: ranking.suggestion.agent
-    dtype: 'null'
-  - name: comment_score
-    dtype: float64
-  - name: rating.suggestion.agent
-    dtype: 'null'
-  splits:
-  - name: train
-    num_bytes: 924
-    num_examples: 3
-  download_size: 15392
-  dataset_size: 924
 ---
 
 # Dataset Card for test-argilla-dataset
@@ -157,9 +90,17 @@ The **suggestions** are human or machine generated recommendations for each ques
 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`.
 
 
+**✨ NEW** The **vectors** are different columns that contain a vector in floating point, which is constraint to the pre-defined dimensions in the **vectors_settings** when configuring the vectors within the dataset itself, also the dimensions will always be 1-dimensional. The **vectors** are optional and identified by the pre-defined vector name in the dataset configuration file in `argilla.yaml`.
+
+| Vector Name | Title | Dimensions |
+|-------------|-------|------------|
+| vector | vector | [1, 3] |
+
+
 
 | Metadata Name | Title | Type | Values | Visible for Annotators |
 | ------------- | ----- | ---- | ------ | ---------------------- |
+ | comment_score | comment_score |  | None - None | True |
 
 
 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.
@@ -169,24 +110,28 @@ The **guidelines**, are optional as well, and are just a plain string that can b
 An example of a dataset instance in Argilla looks as follows:
 
 ```json
-"{\"id\":\"c384826c-19ef-41bf-a8d8-b9ac7c1d1e1a\",\"inserted_at\":null,\"updated_at\":null,\"fields\":{\"text\":\"Hello World, how are you?\"},\"metadata\":{},\"vectors\":{},\"responses\":[{\"values\":{\"label\":{\"value\":\"positive\"}},\"status\":\"draft\",\"user_id\":\"1a4d1b86-4392-41f4-8e17-4a9a635c3e81\"}],\"suggestions\":[{\"value\":\"I\u0027m doing great, thank you!\",\"question_name\":\"comment\",\"type\":null,\"score\":null,\"agent\":null,\"id\":\"1aeab5cf-3905-4cea-9c5d-25c1c69ec937\",\"question_id\":\"8b4538da-0f6b-4ccd-a4e2-5309ec5756cf\"},{\"value\":[\"topic1\",\"topic2\"],\"question_name\":\"topics\",\"type\":null,\"score\":[0.9,0.8],\"agent\":null,\"id\":\"ad077b9f-1b06-4b02-b305-f11d9811e967\",\"question_id\":\"c0f10135-b3b4-45c2-b745-1cc166fa1402\"}],\"external_id\":\"f9a02dda-dd95-4a93-b73b-d25bbfe66015\"}"
+"{\"id\":\"243559eb-09a7-4a6c-a5f3-6e1eef18591d\",\"inserted_at\":null,\"updated_at\":null,\"fields\":{\"text\":\"Hello World, how are you?\"},\"metadata\":{},\"vectors\":{},\"responses\":[{\"values\":{\"label\":{\"value\":\"positive\"}},\"status\":\"draft\",\"user_id\":\"1a4d1b86-4392-41f4-8e17-4a9a635c3e81\"}],\"suggestions\":[{\"value\":\"positive\",\"question_name\":\"label\",\"type\":null,\"score\":null,\"agent\":null,\"id\":\"6a623501-7c1c-4a1d-9ba8-446fba262c8a\",\"question_id\":\"0211b24a-4e1f-4a09-80ca-b47927179d32\"},{\"value\":[\"topic1\",\"topic2\"],\"question_name\":\"topics\",\"type\":null,\"score\":[0.9,0.8],\"agent\":null,\"id\":\"6fc0b3dc-6492-41a3-863d-1d07a34d1d08\",\"question_id\":\"8117d31c-5722-49f3-a2f2-80a10ebd8207\"}],\"external_id\":\"8c368dd5-29c9-4507-abe7-80b032676016\"}"
 ```
 
 While the same record in HuggingFace `datasets` looks as follows:
 
 ```json
 {
-    "_server_id": "c384826c-19ef-41bf-a8d8-b9ac7c1d1e1a",
-    "comment.suggestion": "I\u0027m doing great, thank you!",
+    "_server_id": "243559eb-09a7-4a6c-a5f3-6e1eef18591d",
+    "comment.suggestion": null,
     "comment.suggestion.agent": null,
     "comment.suggestion.score": null,
-    "id": "f9a02dda-dd95-4a93-b73b-d25bbfe66015",
+    "comment_score": null,
+    "id": "8c368dd5-29c9-4507-abe7-80b032676016",
     "label.responses": [
         "positive"
     ],
     "label.responses.users": [
         "1a4d1b86-4392-41f4-8e17-4a9a635c3e81"
     ],
+    "label.suggestion": "positive",
+    "label.suggestion.agent": null,
+    "label.suggestion.score": null,
     "ranking.suggestion": null,
     "ranking.suggestion.agent": null,
     "ranking.suggestion.score": null,
@@ -236,6 +181,10 @@ Among the dataset fields, we differentiate between the following:
     * (optional) **span-suggestion** is of type `span`.
 
 
+* **✨ NEW** **Vectors**: As of Argilla 1.19.0, the vectors have been included in order to add support for similarity search to explore similar records based on vector search powered by the search engine defined. The vectors are optional and cannot be seen within the UI, those are uploaded and internally used. Also the vectors will always be optional, and only the dimensions previously defined in their settings.
+    
+    * (optional) **vector** is of type `float32` and has a dimension of (1, `3`).
+
 
 Additionally, we also have two more fields that are optional and are the following: