Update README.md

README.md

@@ -12,4 +12,174 @@ tags:
 pretty_name: 'Reddit Loneliness: Causes and intensity'
 size_categories:
 - n<1K
----
+---
+# Reddit Loneliness: Causes and intensity 
+
+## Dataset Description
+
+### Dataset Summary
+The Loneliness- cause and intensity dataset is an English-language compilation of posts focused on loneliness among individuals and the different types of loneliness they experience. . The primary objective of this dataset is to aid various NLP models in predicting loneliness and its causes from text, which may be useful in the fields of mental health, NLP contextual understanding, and emotional classification
+The data was gathered from two subreddits:
+[r/lonely]( https://www.reddit.com/r/lonely/) and 
+[r/offmychest]( https://www.reddit.com/r/offmychest/)
+
+#### Supported tasks
+- `text-classification`: This dataset can be used to train a text classification model that categorizes posts into multiple labels of loneliness, including "Not Lonely." The model should consider the context of the post and its title, allowing for overlapping labels to capture different aspects of loneliness..
+- `Natural Language Inference`: The model should determine how lonely an individual feels based on their post and title, rating the intensity on a scale from 1 to 5. The model needs to accurately evaluate the emotional tone of the content to provide this rating.
+
+### Languages
+
+The text in the dataset is in English
+#### Data instances
+Each data point includes a title, a post, a label indicating the causes of loneliness described in the post (first task), and a separate label rating the intensity of loneliness on a scale from 1 to 5.
+
+### Data Fields
+- `example_id`: Index of the example, ranged between 1 and 509
+- `title`: The Title's text
+- `post`: The post text
+- `annotator{i}_t1_label`: Label assigned by annotator i for the relevant categories of loneliness (first task).
+- `annotator{i}_t2_label`: Label assigned by annotator i indicating the intensity of loneliness on a scale from 1 to 5 (second task).
+- `t1_label`: The final label for the first task, determined by the most frequently chosen labels among annotators.
+- `t2_label`: The final label for the second task, calculated as the average of the annotators' ratings for this task.
+- `batch`: The annotation batch this datapoint belong to. One of "exploration", "evaluation" and "part 3"
+
+
+### Data Splits
+The data is split into a training, validation and test set. The samples are picked at random according to the following scheme:
+
+ The test set (153) consists of samples only from the "part 3" batch since these are the samples that were annotated by the external annotators, thus giving it the highest quality.
+
+ The validation set (45) consists of samples only from the "evaluation" batch, which is the second highest quality batch.
+
+ The training set (300), consists of all the rest.
+
+| | Train   | Dev   | Test  |
+| ------------ | :-------: | :-----: | :-----: |
+| exploration  | 80      | 0     | 0     |
+| evaluation   | 40      | 40    | 0     |
+| part 3       | 90      | 0     | 150   |
+
+
+- **Curated by:** [More Information Needed]
+- **Funded by [optional]:** [More Information Needed]
+- **Shared by [optional]:** [More Information Needed]
+- **Language(s) (NLP):** [More Information Needed]
+- **License:** [More Information Needed]
+
+### Dataset Sources [optional]
+
+<!-- Provide the basic links for the dataset. -->
+
+- **Repository:** [More Information Needed]
+- **Paper [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed]
+
+## Uses
+
+<!-- Address questions around how the dataset is intended to be used. -->
+
+### Direct Use
+
+<!-- This section describes suitable use cases for the dataset. -->
+
+[More Information Needed]
+
+### Out-of-Scope Use
+
+<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+
+[More Information Needed]
+
+## Dataset Structure
+
+<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
+
+[More Information Needed]
+
+## Dataset Creation
+
+### Curation Rationale
+
+<!-- Motivation for the creation of this dataset. -->
+
+[More Information Needed]
+
+### Source Data
+
+<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+
+#### Data Collection and Processing
+
+<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
+
+[More Information Needed]
+
+#### Who are the source data producers?
+
+<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
+
+[More Information Needed]
+
+### Annotations [optional]
+
+<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
+
+#### Annotation process
+
+<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
+
+[More Information Needed]
+
+#### Who are the annotators?
+
+<!-- This section describes the people or systems who created the annotations. -->
+
+[More Information Needed]
+
+#### Personal and Sensitive Information
+
+<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
+
+[More Information Needed]
+
+## Bias, Risks, and Limitations
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+
+[More Information Needed]
+
+### Recommendations
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+
+Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
+
+## Citation [optional]
+
+<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+
+**BibTeX:**
+
+[More Information Needed]
+
+**APA:**
+
+[More Information Needed]
+
+## Glossary [optional]
+
+<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
+
+[More Information Needed]
+
+## More Information [optional]
+
+[More Information Needed]
+
+## Dataset Card Authors [optional]
+
+[More Information Needed]
+
+## Dataset Card Contact
+
+[More Information Needed]