jniimi commited on
Commit
3e64999
1 Parent(s): 74eb89f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +99 -0
README.md CHANGED
@@ -45,4 +45,103 @@ configs:
45
  data_files:
46
  - split: train
47
  path: data/train-*
 
 
 
 
 
 
 
48
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
45
  data_files:
46
  - split: train
47
  path: data/train-*
48
+ task_categories:
49
+ - text-classification
50
+ language:
51
+ - en
52
+ pretty_name: sentiment
53
+ size_categories:
54
+ - 10K<n<100K
55
  ---
56
+ # Dataset Card for Dataset Name
57
+
58
+ This repository contains a dataset of hotel reviews and ratings collected from TripAdvisor, which has been processed by us. The dataset includes reviews of various hotels along with metadata such as multiple-aspect ratings and review texts.
59
+ Please refer to our [GitHub repo](https://github.com/jniimi/tripadvisor_dataset).
60
+
61
+ The data is originally distributed by Jiwei Li et al. (2013) and is hosted on his website [http://www.cs.cmu.edu/~jiweil/html/hotel-review.html](http://www.cs.cmu.edu/~jiweil/html/hotel-review.html).
62
+
63
+ ## Dataset Details
64
+
65
+ ### Dataset Description
66
+
67
+ The contents of the two datasets (.csv and .pkl) are same; however, we recommend using pickle file (.pkl) which retains information on pandas variable types and np.nan for missing values, especially datetime. In the original data, the various variables were stored in JSON format, but we have reorganised them so that the reviews and ratings are combined in one line as a pandas data set.
68
+
69
+ Since the original dataset has various language, we used machine learning to extract posts where reviews are written in English. Specifically, we adopted \`fastText\` ([https://fasttext.cc](https://fasttext.cc)) by Meta, utilizing the pre-trained model [\`lid.176.bin\`](https://dl.fbaipublicfiles.com/fasttext/supervised-models/lid.176.bin).
70
+
71
+ - **Curated by:** [More Information Needed]
72
+ - **Language(s) (NLP):** English
73
+ - **License:** [More Information Needed]
74
+
75
+ ### Dataset Sources [optional]
76
+
77
+ <!-- Provide the basic links for the dataset. -->
78
+
79
+ - **Repository:** [More Information Needed]
80
+ - **Paper [optional]:** [More Information Needed]
81
+ - **Demo [optional]:** [More Information Needed]
82
+
83
+ ## Uses
84
+
85
+ You can load data using datasets package as:
86
+ ```python
87
+ from datasets import load_dataset
88
+ df = load_dataset("jniimi/tripadvisor")
89
+ ```
90
+
91
+ ### Direct Use
92
+
93
+ This data is suitable for Aspect-based Sentiment Analysis (AbSA), as the same way that TripAdvisor data has already been used in many previous studies.
94
+
95
+ ### Out-of-Scope Use
96
+
97
+ Please follow the policy of the original data source.
98
+
99
+ ## Dataset Structure
100
+
101
+ The dataset includes the following columns in each line:
102
+ - `hotel_id`: Unique identifier for hotels.
103
+ - `user_id`: Unique identifier for users.
104
+ - `title`: Heading of the user review.
105
+ - `text`: Actual text of the review.
106
+ - `review`: reviews combined as follows: `title` \n `text`
107
+ - `overall`: The rating given by the user.
108
+ - `cleanliness`: The rating regarding the cleanliness.
109
+ - `value`: The rating regarding the value.
110
+ - `location`: The rating regarding the location.
111
+ - `rooms`: The rating regarding the rooms.
112
+ - `sleep_quality`: The rating regarding the sleep quality.
113
+ - `date_stayed`: The date when the user stayed.
114
+ - `date`: The date when the review was posted.
115
+
116
+ ## Dataset Creation
117
+
118
+ <!--### Curation Rationale
119
+
120
+ Motivation for the creation of this dataset.
121
+
122
+ [More Information Needed] -->
123
+
124
+ ## Citation
125
+
126
+ **BibTeX:**
127
+
128
+ @misc{tripadvisor_dataset,
129
+ author = {Junichiro, Niimi},
130
+ title = {Hotel Review Dataset (English)},
131
+ year = {2024},
132
+ howpublished = {\url{https://github.com/jniimi/tripadvisor_dataset}}
133
+ }
134
+
135
+ **APA:**
136
+
137
+ Original paper:
138
+ - Li, J., Ott, M., & Cardie, C. (2013, October). Identifying manipulated offerings on review portals. In Proceedings of the 2013 conference on empirical methods in natural language processing (pp. 1933-1942). [https://aclanthology.org/D13-1199/](https://aclanthology.org/D13-1199/)
139
+
140
+
141
+ ## More Information [optional]
142
+
143
+ [More Information Needed]
144
+
145
+ ## Dataset Card Authors [optional]
146
+
147
+ jniimi (@JvckAndersen)