DK-FA-Cosmetics / README.md
Acidmanic's picture
update read me from template
80ab4c4
---
license: mit
language:
- fa
tags:
- e-commerce
- Online-Shop
- Comments
pretty_name: Dk-Fa-Cosmetics
size_categories:
- 100K<n<1M
---
# Dataset Card for Dataset Name
<!-- Provide a quick summary of the dataset. -->
This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
## Dataset Details
### Dataset Description
<!-- Provide a longer summary of what this dataset is. -->
- **Curated by:** Mani Moayedi
- **Language(s) (NLP):** Farsi (Persian)
- **License:** MIT
## Uses
The samples of this dataset are user comments about products of an online shop website. Each comment contains some
additional data alongside the comments body, like star-rating value (0-5). This dataset can be used to train or generate
different data-models for NLP tasks like opinion mining and sentiment analysis.
### Out-of-Scope Use
<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
This dataset is the result of crawling 7 categories of cosmetic products from a perisan online-shop's product pages. The vocabulary
mostly revolves around the cosmetics subjects, therefore it might not be suitable for use cases which needs a generic collection of
words and phrases.
## Dataset Structure
Each comment is represented
in structured format and contains comment's body, comment's title, star-rating value (0-5), Other users reactions to
each comment in terms of number-of-likes and number-of-dislikes. and a list of advantages and dis-advantages that user
might have specified. title field and advantages/disadvantages fields can be null or empty in many comments.
For more details please check out the file [Dataset Description](https://huggingface.co/datasets/Acidmanic/DK-FA-Cosmetics/resolve/main/Dataset%20Description.pdf).
## Dataset Creation
The dataset is created using a crawler agains an online shop's website. Comments are scraped from product pages and stored as json, jsonl and csv files.
#### Personal and Sensitive Information
The dataset contains the username of userse who has posted the comments. All the information in the dataset, including these usernames, are
present on the products web-page whithout any login or authentication.
## Bias, Risks, and Limitations
From Npl prespective, the dataset might mostly contain information about the the consmetic products and the quality
of sellers and resellers service. Therefore considering this dataset as a general source of language might introduce
some issues, depending on the use-case.
## Glossary
| Set | Number Of Comments | Number Of Products | Average Comments Per Product |
| ----------- | ----------- | ----------- |----------- |
| **dk-fa-cosmetics** (Full dataset) | 421078 | 8325 | 51 |
| dkfacs-eyeliner (sub-set) | 30824 | 284 | 109 |
| dkfacs-stand (sub-set) | 83197 | 1738 | 48 |
| dkfacs-mascara (sub-set) | 47961 | 338 | 142 |
| dkfacs-sun-screen (sub-set) | 118699 | 772 | 154 |
| dkfacs-eye-shadow (sub-set) | 14532 | 634 | 23 |
| dkfacs-nails (sub-set) | 75209 | 3260 | 23 |
| dkfacs-lipsticks (sub-set) | 50656 | 1299 | 39 |
## Dataset Card Authors
Mani Moayedi
## Dataset Card Contact
[email protected]
https://github.com/Acidmanic