Upload README.md with huggingface_hub

README.md

@@ -1,49 +1,248 @@
 ---
-dataset_info:
-  features:
-  - name: source
-    dtype: string
-    id: field
-  - name: target
-    list:
-    - name: user_id
-      dtype: string
-      id: question
-    - name: value
-      dtype: string
-      id: question
-    - name: status
-      dtype: string
-      id: question
-  - name: target-suggestion
-    dtype: string
-    id: suggestion
-  - name: target-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: 28938
-    num_examples: 26
-  download_size: 26555
-  dataset_size: 28938
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+size_categories: n<1K
+tags:
+- rlfh
+- argilla
+- human-feedback
 ---
+
+# Dataset Card for MPEP_MALAGASY
+
+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("DIBT/MPEP_MALAGASY")
+```
+
+### 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("DIBT/MPEP_MALAGASY")
+```
+
+### 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**, **vectors**, 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 |
+| ---------- | ----- | ---- | -------- | -------- |
+| source | Source | text | True | 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 |
+| ------------- | ----- | ---- | -------- | ----------- | ------------- |
+| target | Target | text | True | Translate the text. | 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".
+
+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`.
+
+
+
+| Metadata Name | Title | Type | Values | Visible for Annotators |
+| ------------- | ----- | ---- | ------ | ---------------------- |
+
+
+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": "944",
+    "fields": {
+        "source": "I need a cv for this job\nJunior PHP Engineer (f/m/d)\nAbout the job\nAnstellungsdetails\n\nPermanent contract, full-time or part-time, Cologne / D\u00fcsseldorf / Darmstadt / Remote (in Germany)\n\nInfo\n\nWho We Are\n\nWe operate Kaufland.de: Several thousand sellers and millions of products make us one of the fastest growing online marketplaces. Our work is characterised by a dynamic corporate culture, with a start-up mentality and the power of a big corporate group. We combine knowledge and many years of experience in e-commerce with flat hierarchies and a highly motivated team. Whether it\u0027s from an intern: We take every idea seriously, because we want to work together in shaping the future of e-commerce!\n\nWe love flexibility! We offer you the best environment to work in a flexible and focused way: You decide whether you want to work in our office in Cologne // Darmstadt while at the same time having the opportunity to work remotely. We want to offer you the most attractive workplace in e-commerce and a maximum of flexibility for your personal work-life balance.\n\nDay-by-day, our development team of over 300 experts pursues the goal of creating the best-possible customer shopping experience for the Kaufland marketplace. We are here to inspire millions of customers, to help them find, purchase and get the things they love. To enrich the lives of our customers, we collaborate in cross-functional teams, in which product managers, product designers, frontend and backend engineers, data scientists and lean managers join forces. Details regarding the challenges of the respective product areas can be found here: https://kaufland-ecommerce.com/team/tech/.\n\nAufgaben\n\nYour tasks \u2013 this is what awaits you in detail\nAs a Junior PHP Engineer (f/m/d) you proactively develop the Kaufland Marketplace and internal services further\nIn our cross-functional teams, independent teams, you regularly work with colleagues from other disciplines to develop products that make our customers happy\nYou learn about cutting edge technologies and innovative processes and stay up-to-date on current trends in the engineering world\nIn pair-programming sessions, you have the opportunity to gain and share knowledge with your team and continuously learn new things\nYou actively contribute in planning \u0026 building scalable and reliable software solutions\n\nYour Profile \u2013 This Is What We Expect From You\nYou have an educational level that corresponds to completed university studies in (business) information technology, (business) engineering, mathematics or physics, or you finished an IT relevant apprenticeship, or you have equivalent professional experience\nIdeally, you have gained some previous insights into object-oriented programming, preferably with PHP, modern frameworks (Symfony, Laravel or similar), and knowledge of relational databases (MySQL or similar)\nYou understand clean coding principles and best practices to ensure sustainable, reliable and extendable code\nYou have the drive to continuously develop both yourself and your team further in order to become a little bit better every day\nYou are passionate about what you do and have a strong interest in current e-commerce trends and developments\nYou have excellent communication skills, are willing to embrace our company culture and values and enjoy working in an international, english-speaking team\n\nWhat We Offer\nCreate your own work-life! We offer you the best possible flexibility in terms of working hours and location\nA highly-motivated and qualified team from different fields and numerous nations\nYou would like to move to Germany? No problem - we offer you an attractive relocation package for a smooth start\nThe future is digital - Develop the e-commerce of the future with us and work on a product with millions of users with a broadly-based technology stack\nPower meets dynamic - flat hierarchies and start-up mentality meet and the power of a big corporate group and offers you an agile and secure working environment at the same time\nFree choice of hardware \u2013 we provide you with the development environment of your choice\nPersonal \u0026 team growth: We love to have flexibility in terms of working location, but we also believe that personal interactions are important. That\u2019s why we organize company events, and cover the costs to bring you there and to other (approved) get togethers with your peers. The same applies to conferences and other learning opportunities. We want everybody to grow personally and professionally, as a team and as a company\nTop conditions at the Urban Sports Club for fitness, team sports, yoga and more\n\nCheck out our Principles \u0026 our blog for even more insights into our company culture!\n\nRefer an Engineer Program\n\nYou want to work for us, but not without your dearest colleague? Join us as a team and earn money by referring your buddy for one of our open Tech positions! Depending on the level we offer a bonus up to 1.300,- \u20ac per referral, which will be paid after successful recruitment (the first part with your first salary, the second part after your buddy passes the trial period).\n\nBewerben\n\nWhy are you the perfect fit for this position? Don\u0027t bother with cover letters - we\u0027re interested in facts and figures!\n\nAnsprechpartner\n\n\\_\\_Your contact person: Alina Asmus\n\nKaufland e-commerce\n\nKaufland e-commerce Services GmbH \u0026 Co. KG\n\nPostal address:\n\nHabsburgerring 2\n\n50674 K\u00f6ln\n\nWe\u0027re looking forward to your application!\\_\\_"
+    },
+    "metadata": {
+        "evolved_from": null,
+        "kind": "human",
+        "source": "ewof/sharegpt-instruct-unfiltered-deduped"
+    },
+    "responses": [
+        {
+            "status": "submitted",
+            "user_id": "d2dae990-2c5e-4871-8d40-1f3ded82b14d",
+            "values": {
+                "target": {
+                    "value": "Mila CV aho ho an\u0027ity asa ity\r\nJunior PHP injeniera (f / m / d)\nMomba ny asa\nAnstellungsdetails\n\nFifanekena maharitra, fotoana feno na tapak\u0027andro, Cologne / D\u00fcsseldorf / Darmstadt / Remote (any Alemaina)\n\nInfo\n\nIza moa isika\n\nMiasa Kaufland.de izahay: mpivarotra an\u0027arivony sy vokatra an-tapitrisany no mahatonga antsika ho iray amin\u0027ireo tsena an-tserasera mitombo haingana indrindra. Ny asanay dia miavaka amin\u0027ny kolontsain\u0027ny orinasa mavitrika, miaraka amin\u0027ny toe-tsaina manomboka sy ny herin\u0027ny vondrona orinasa lehibe. Manambatra ny fahalalana sy ny traikefa an-taonany maro amin\u0027ny e-varotra miaraka amin\u0027ny ambaratongam-pahefana sy ekipa tena manosika izahay. Na avy amin\u0027ny intern: Raisinay ho zava-dehibe ny hevitra rehetra, satria te-hiara-hiasa amin\u0027ny famolavolana ny hoavin\u0027ny e-varotra izahay!\n\n\n\r\n\n"
+                }
+            }
+        }
+    ],
+    "suggestions": [
+        {
+            "agent": null,
+            "question_name": "target",
+            "score": null,
+            "type": null,
+            "value": "Mila CV ho an\u0027ity asa ity aho Junior Commerce Engineer (f/m/d) Inona no asa momba ny asa Anstellungsdetails Fampidirana ny asa Anstellungsdetails Fifanarahana maharitra, manontolo andro na ampahany andro, Cologne / D\u00fcsseldorf / Darmstadt / Remote (amin\u0027ny Alemaina) Info Izahay miasa Kaufland.de: Mpivarotra an\u0027arivony sy vokatra an-tapitrisany maro no mahatonga antsika ho iray amin\u0027ireo tsena an-tserasera mitombo haingana indrindra. Ny asa ataonay dia miavaka amin\u0027ny kolontsaina mavitrika, miaraka amin\u0027ny toe-tsaina fanombohana ary ny herin\u0027ny vondrona orinasa lehibe. Manambatra ny fahalalana sy ny traikefa nandritra ny taona maro amin\u0027ny e-varotra amin\u0027ny laharan-tsoratra feno fahalemem-panahy sy ny ekipa tena mavitrika (ao amin\u0027ny"
+        }
+    ],
+    "vectors": {}
+}
+```
+
+While the same record in HuggingFace `datasets` looks as follows:
+
+```json
+{
+    "external_id": "944",
+    "metadata": "{\"source\": \"ewof/sharegpt-instruct-unfiltered-deduped\", \"kind\": \"human\", \"evolved_from\": null}",
+    "source": "I need a cv for this job\nJunior PHP Engineer (f/m/d)\nAbout the job\nAnstellungsdetails\n\nPermanent contract, full-time or part-time, Cologne / D\u00fcsseldorf / Darmstadt / Remote (in Germany)\n\nInfo\n\nWho We Are\n\nWe operate Kaufland.de: Several thousand sellers and millions of products make us one of the fastest growing online marketplaces. Our work is characterised by a dynamic corporate culture, with a start-up mentality and the power of a big corporate group. We combine knowledge and many years of experience in e-commerce with flat hierarchies and a highly motivated team. Whether it\u0027s from an intern: We take every idea seriously, because we want to work together in shaping the future of e-commerce!\n\nWe love flexibility! We offer you the best environment to work in a flexible and focused way: You decide whether you want to work in our office in Cologne // Darmstadt while at the same time having the opportunity to work remotely. We want to offer you the most attractive workplace in e-commerce and a maximum of flexibility for your personal work-life balance.\n\nDay-by-day, our development team of over 300 experts pursues the goal of creating the best-possible customer shopping experience for the Kaufland marketplace. We are here to inspire millions of customers, to help them find, purchase and get the things they love. To enrich the lives of our customers, we collaborate in cross-functional teams, in which product managers, product designers, frontend and backend engineers, data scientists and lean managers join forces. Details regarding the challenges of the respective product areas can be found here: https://kaufland-ecommerce.com/team/tech/.\n\nAufgaben\n\nYour tasks \u2013 this is what awaits you in detail\nAs a Junior PHP Engineer (f/m/d) you proactively develop the Kaufland Marketplace and internal services further\nIn our cross-functional teams, independent teams, you regularly work with colleagues from other disciplines to develop products that make our customers happy\nYou learn about cutting edge technologies and innovative processes and stay up-to-date on current trends in the engineering world\nIn pair-programming sessions, you have the opportunity to gain and share knowledge with your team and continuously learn new things\nYou actively contribute in planning \u0026 building scalable and reliable software solutions\n\nYour Profile \u2013 This Is What We Expect From You\nYou have an educational level that corresponds to completed university studies in (business) information technology, (business) engineering, mathematics or physics, or you finished an IT relevant apprenticeship, or you have equivalent professional experience\nIdeally, you have gained some previous insights into object-oriented programming, preferably with PHP, modern frameworks (Symfony, Laravel or similar), and knowledge of relational databases (MySQL or similar)\nYou understand clean coding principles and best practices to ensure sustainable, reliable and extendable code\nYou have the drive to continuously develop both yourself and your team further in order to become a little bit better every day\nYou are passionate about what you do and have a strong interest in current e-commerce trends and developments\nYou have excellent communication skills, are willing to embrace our company culture and values and enjoy working in an international, english-speaking team\n\nWhat We Offer\nCreate your own work-life! We offer you the best possible flexibility in terms of working hours and location\nA highly-motivated and qualified team from different fields and numerous nations\nYou would like to move to Germany? No problem - we offer you an attractive relocation package for a smooth start\nThe future is digital - Develop the e-commerce of the future with us and work on a product with millions of users with a broadly-based technology stack\nPower meets dynamic - flat hierarchies and start-up mentality meet and the power of a big corporate group and offers you an agile and secure working environment at the same time\nFree choice of hardware \u2013 we provide you with the development environment of your choice\nPersonal \u0026 team growth: We love to have flexibility in terms of working location, but we also believe that personal interactions are important. That\u2019s why we organize company events, and cover the costs to bring you there and to other (approved) get togethers with your peers. The same applies to conferences and other learning opportunities. We want everybody to grow personally and professionally, as a team and as a company\nTop conditions at the Urban Sports Club for fitness, team sports, yoga and more\n\nCheck out our Principles \u0026 our blog for even more insights into our company culture!\n\nRefer an Engineer Program\n\nYou want to work for us, but not without your dearest colleague? Join us as a team and earn money by referring your buddy for one of our open Tech positions! Depending on the level we offer a bonus up to 1.300,- \u20ac per referral, which will be paid after successful recruitment (the first part with your first salary, the second part after your buddy passes the trial period).\n\nBewerben\n\nWhy are you the perfect fit for this position? Don\u0027t bother with cover letters - we\u0027re interested in facts and figures!\n\nAnsprechpartner\n\n\\_\\_Your contact person: Alina Asmus\n\nKaufland e-commerce\n\nKaufland e-commerce Services GmbH \u0026 Co. KG\n\nPostal address:\n\nHabsburgerring 2\n\n50674 K\u00f6ln\n\nWe\u0027re looking forward to your application!\\_\\_",
+    "target": [
+        {
+            "status": "submitted",
+            "user_id": "d2dae990-2c5e-4871-8d40-1f3ded82b14d",
+            "value": "Mila CV aho ho an\u0027ity asa ity\r\nJunior PHP injeniera (f / m / d)\nMomba ny asa\nAnstellungsdetails\n\nFifanekena maharitra, fotoana feno na tapak\u0027andro, Cologne / D\u00fcsseldorf / Darmstadt / Remote (any Alemaina)\n\nInfo\n\nIza moa isika\n\nMiasa Kaufland.de izahay: mpivarotra an\u0027arivony sy vokatra an-tapitrisany no mahatonga antsika ho iray amin\u0027ireo tsena an-tserasera mitombo haingana indrindra. Ny asanay dia miavaka amin\u0027ny kolontsain\u0027ny orinasa mavitrika, miaraka amin\u0027ny toe-tsaina manomboka sy ny herin\u0027ny vondrona orinasa lehibe. Manambatra ny fahalalana sy ny traikefa an-taonany maro amin\u0027ny e-varotra miaraka amin\u0027ny ambaratongam-pahefana sy ekipa tena manosika izahay. Na avy amin\u0027ny intern: Raisinay ho zava-dehibe ny hevitra rehetra, satria te-hiara-hiasa amin\u0027ny famolavolana ny hoavin\u0027ny e-varotra izahay!\n\n\n\r\n\n"
+        }
+    ],
+    "target-suggestion": "Mila CV ho an\u0027ity asa ity aho Junior Commerce Engineer (f/m/d) Inona no asa momba ny asa Anstellungsdetails Fampidirana ny asa Anstellungsdetails Fifanarahana maharitra, manontolo andro na ampahany andro, Cologne / D\u00fcsseldorf / Darmstadt / Remote (amin\u0027ny Alemaina) Info Izahay miasa Kaufland.de: Mpivarotra an\u0027arivony sy vokatra an-tapitrisany maro no mahatonga antsika ho iray amin\u0027ireo tsena an-tserasera mitombo haingana indrindra. Ny asa ataonay dia miavaka amin\u0027ny kolontsaina mavitrika, miaraka amin\u0027ny toe-tsaina fanombohana ary ny herin\u0027ny vondrona orinasa lehibe. Manambatra ny fahalalana sy ny traikefa nandritra ny taona maro amin\u0027ny e-varotra amin\u0027ny laharan-tsoratra feno fahalemem-panahy sy ny ekipa tena mavitrika (ao amin\u0027ny",
+    "target-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.
+    
+    * **source** 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`.
+    
+    * **target** is of type `text`, and description "Translate the 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) **target-suggestion** is of type `text`.
+
+
+
+Additionally, we also have two more fields that are optional and are the following:
+
+* **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 translation dataset that contains texts. Please translate the text in the text field.
+
+#### 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]