Update README.md

README.md

@@ -28,103 +28,45 @@ And finally, label 4 indicates the sentiment of intense emotions, such as Surpri
 
 
 
-- **Curated by:** [Mohammadali Mohammadkhani - Sina Elahimanesh]
-- **Funded by :** [Mohammadali Mohammadkhani - Sina Elahimanesh]
-- **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. -->
+- **Curated by:** Mohammadali Mohammadkhani - Sina Elahimanesh
+- **Funded by :** Mohammadali Mohammadkhani - Sina Elahimanesh
+- **Language(s) (NLP):** Persian
+- **License:** odbl
 
 ### 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]
+#### Transformers Dataset
+```
+from datasets import load_dataset
 
-## Dataset Structure
+# Login using e.g. `huggingface-cli login` to access this dataset
+ds = load_dataset("moali-mkh-2000/PersianTwitterDataset-SentimentAnalysis")
+```
 
-<!-- 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. -->
+#### Pandas
+```
+import pandas as pd
 
-[More Information Needed]
+# Login using e.g. `huggingface-cli login` to access this dataset
+df = pd.read_csv("hf://datasets/moali-mkh-2000/PersianTwitterDataset-SentimentAnalysis/PersianTwitterDataset.csv")
+```
 
 ## 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]
+Tweets are extracted from Persian-speaking accounts of X community.
 
 #### Who are the annotators?
 
-<!-- This section describes the people or systems who created the annotations. -->
-
-[Mohammadali Mohammadkhani - Sina Elahimanesh]
-
-#### 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. -->
+Mohammadali Mohammadkhani - Sina Elahimanesh
 
-[More Information Needed]
+#### Privacy and Ethical Concerns
 
-## 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.
+The tweets are collected from public accounts (at the time of dataset creation). We made sure to address all privacy concerns in the process of creating this dataset.
 
 ## Citation
 
-<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
-
 **BibTeX:**
 
 ```
@@ -137,9 +79,4 @@ Users should be made aware of the risks, biases and limitations of the dataset.
       primaryClass={cs.HC},
       url={https://arxiv.org/abs/2504.10662}, 
 }
-```
-
-
-## Dataset Card Contact
-
-[More Information Needed]
+```