Update README.md

README.md

@@ -33,139 +33,131 @@ task_categories:
 size_categories:
 - 10K<n<100K
 ---
-# Dataset Card for Dataset Name
+
+# Dataset Card for Llama3-Naija_v1
 
 <!-- Provide a quick summary of the dataset. -->
 
-This Dataset is a Question (Post) - Answer (Response  dataset webscraped from Nairaland.
+This Dataset is a Question (Post) - Answer (Response) dataset webscraped from Nairaland.
 The Dataset involves Questions on various sections from **Nairaland ("Politics","Romance","Career","Business","Education","Religion","Sports","Literature","Fashion","TV-Movies","Travel",
 "Programming","Phones","Music-Radio","Food","Family","Health")** and the most liked response to those posts.
 
 The data was built with the aim of training or fine-tuning an LLM to chat like a Nigerian.
+
 ## Dataset Details
 
 ### Dataset Description
 
-<!-- Provide a longer summary of what this dataset is. -->
-
-
+This dataset contains questions and answers from Nairaland, a popular Nigerian online community. The questions cover various topics relevant to Nigerians, and the answers are the most liked responses to those questions. The dataset aims to capture the linguistic and cultural nuances of Nigerian English and Pidgin English, making it suitable for training language models that understand and generate text in these languages.
 
 - **Developed by:** [Saheedniyi](https://linkedin.com/in/azeez-saheed)
 - **Language(s):** English, Pidgin English 
 
-### Dataset Sources [optional]
-
-<!-- Provide the basic links for the dataset. -->
+### Dataset Sources
 
 - **[Nairaland.com](https://www.nairaland.com/):** Africa's largest internet Forum 
 - **[GitHub Repository](https://github.com/saheedniyi02/Llama3-8b-Naija_v1)**
 
 ## Uses
 
-<!-- Address questions around how the dataset is intended to be used. -->
-
 ### Direct Use
 
-<!-- This section describes suitable use cases for the dataset. -->
+This dataset is intended for training or fine-tuning language models to generate or understand Nigerian English and Pidgin English. Suitable use cases include:
 
-[More Information Needed]
+- Chatbots tailored for Nigerian audiences
+- Sentiment analysis specific to Nigerian contexts
+- Cultural and context-aware text generation
 
 ### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+This dataset is not suitable for:
 
-[More Information Needed]
+- Generating non-Nigerian context-specific content
+- Highly sensitive applications without proper ethical review
+- Any use that violates Nairaland's terms of service or privacy policies
 
 ## 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. -->
+The dataset consists of two main fields for each entry:
+
+- **Question:** The original post or question from a Nairaland thread.
+- **Answer:** The most liked response to that post or question.
 
-[More Information Needed]
+Data splits and additional structuring information are not provided in this basic version but can be customized as needed for specific applications.
 
 ## Dataset Creation
 
 ### Curation Rationale
 
-<!-- Motivation for the creation of this dataset. -->
-
-[More Information Needed]
+The dataset was created to provide a resource for developing AI models that can understand and generate text in a way that is culturally and contextually relevant to Nigerians. This helps in building more effective and relatable AI applications for Nigerian users.
 
 ### 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]
+Data was collected by web scraping Nairaland, focusing on the most liked responses to posts across various sections. The data was then cleaned to remove any HTML tags, advertisements, and irrelevant content. Tools and libraries used include Python, BeautifulSoup, and pandas.
 
 #### 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]
+The source data producers are the users of Nairaland who create posts and responses. Demographic information about these users is not collected, but they represent a wide range of Nigerian society.
 
-<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
+### Annotations
 
 #### 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]
+No additional annotations were made beyond the original likes on responses. The most liked response was automatically selected as the answer.
 
 #### Who are the annotators?
 
-<!-- This section describes the people or systems who created the annotations. -->
-
-[More Information Needed]
+The annotators are the users of Nairaland whose likes determine the most relevant responses.
 
 #### 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]
+The dataset does not include any personal identifiable information (PII). Usernames and other identifiers have been anonymized or removed to protect privacy.
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+The dataset reflects the views and biases of the Nairaland community, which may not be representative of the entire Nigerian population. Users should be cautious of these biases, especially for applications that require high accuracy and fairness.
 
 ### Recommendations
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+Users should:
 
-Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
+- Be aware of potential biases and limitations.
+- Consider the ethical implications of their applications.
+- Use the dataset in accordance with Nairaland's terms of service and privacy policies.
 
-## 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. -->
+## Citation
 
 **BibTeX:**
 
-[More Information Needed]
+```bibtex
+@dataset{saheedniyi2024llama3naija,
+  author       = {Azeez Saheed},
+  title        = {Llama3-Naija_v1: A Nairaland Question-Answer Dataset},
+  year         = 2024,
+  url          = {https://github.com/saheedniyi02/Llama3-8b-Naija_v1},
+}
+```
 
 **APA:**
 
-[More Information Needed]
-
-## Glossary [optional]
+Azeez Saheed. (2024). Llama3-Naija_v1: A Nairaland Question-Answer Dataset. Retrieved from https://github.com/saheedniyi02/Llama3-8b-Naija_v1
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
+## Glossary
 
-[More Information Needed]
+- **LLM:** Large Language Model
+- **Nairaland:** A popular Nigerian online community
+- **Pidgin English:** A creole language spoken across Nigeria
 
-## More Information [optional]
+## More Information
 
-[More Information Needed]
+For more details and updates, visit the [GitHub Repository](https://github.com/saheedniyi02/Llama3-8b-Naija_v1).
 
-## Dataset Card Authors [optional]
+## Dataset Card Authors
 
-[More Information Needed]
+This dataset card was prepared by Azeez Saheed.
 
 ## Dataset Card Contact
 
-[More Information Needed]
+For any questions or issues, please contact [Azeez Saheed](https://linkedin.com/in/azeez-saheed).