Create README.md

README.md

@@ -0,0 +1,138 @@
+---
+license: mit
+task_categories:
+- text-generation
+tags:
+- human-feedback
+- rlhf
+- preferences
+- reddit
+size_categories:
+- 100K<n<1M
+language:
+- en
+---
+# 🚢  Stanford Human Preferences Dataset (SHP)
+
+## Summary
+
+SHP is a dataset of **220K human preferences** over Reddit comments in 18 different subject areas, from cooking to legal advice.
+It is primarily intended to be used for training reward models for RLHF and automatic evaluation models for NLG.
+Each example is a Reddit post and a pair of top-level comments for that post, where one comment is more preferred by Reddit users. 
+
+Specifically, given a post P and two comments (A,B) we only included the preference A > B in the dataset if 
+1. A was written *no later than* B.
+2. Despite being written later, A has a score that is at least 2 times as high as B's.
+3. Both comments have a score >= 2 and the post has a score >= 10.
+4. The post is a self-post (i.e., a body of text and not a link to another page) made before 2023, was not edited, and is not NSFW (over 18).
+5. Neither comment was made by a deleted user, a moderator, or the post creator. The post was not made by a deleted user or moderator.
+
+Since comments made earlier get more visibility, the first condition is needed to ensure that A's higher score is not the result of a first-mover advantage.
+Since the comment score is also a noisy estimate of the comment's utility, the second and third conditions were enforced to ensure that the preference is genuine.
+We did not allow edited posts, since that opens the possibility of one comment being written with more context than another.
+
+SHP compares favorably to other preference datasets. 
+The input in SHP contains X bits of [FLANT5-usable information](https://icml.cc/virtual/2022/oral/16634) about the preference label, compared to only Y bits in [Anthropic's HH-RLHF dataset](https://huggingface.co/datasets/Anthropic/hh-rlhf).
+This may be due to the aggregate human preferences in SHP being easier to predict than the individual human preferences in the Anthropic data, as well as the strict data filtering described above.
+
+
+## Files
+
+SHP contains a train, validation, and test split for comments scraped from 18 different subreddits: 
+`askculinary`, `askhr`, `askdocs`, `askanthropology`, `asksciencefiction`, `askacademia`, `askengineers`, `legaladvice`, `explainlikeimfive`, `askbaking`, `askphysics`, `askscience`, `askphilosophy`, `askvet`, `changemyview`, `askcarguys`, `askhistorians`, `asksocialscience`.
+
+We chose subreddits based on:
+1. whether they were well-known (subscriber count >= 50K)
+2. whether they were actively moderated
+3. whether comments had to be rooted in some objectivity, instead of being entirely about personal experiences (e.g., `askscience` vs. `AskAmericans`)
+
+The train/validation/test splits were created by splitting the post IDs of a subreddit in 90%/5%/5% proportions respectively, so that no post would appear in multiple splits.
+Since different posts have different numbers of comments, the number of preferences in each split is not exactly 90%/5%/5%, but fairly close to it.
+
+|                    |    train | validation | test | total |
+|--------------------|---------:|-----------:|-----:|-------:
+| Number of Examples |   198556 |      10555 |10454 | 219565|
+
+
+## Data Structure
+
+Here's an example from the training data:
+```
+{
+    `post_id`: "qt3nxl",
+    `domain`: "askculinary_train",
+    `upvote_ratio`: 0.98,
+    `history`: "What's the best way to disassemble raspberries? Like this, but down to the individual seeds: https:\/\/i.imgur.com\/Z0c6ZKE.jpg\n\nI've been pulling them apart with tweezers and it's really time consuming. I have about 10 pounds to get through this weekend.",
+    `c_root_id_A`: "hkh25lp",
+    `c_root_id_B`: "hkh25sc",
+    `created_at_utc_A`: 1636822110,
+    `created_at_utc_B`: 1636822112,
+    `score_A`: 166,
+    `score_B`: 340,
+    `human_ref_A`: "Raspberry juice will make a bright stain at first, but in a matter of weeks it will start to fade away to almost nothing. It is what is known in the natural dye world as a fugitive dye, it will fade even without washing or exposure to light. I hope she gets lots of nice photos of these stains on her dress, because soon that will be all she has left of them!",
+    `human_ref_B`: "Pectinex, perhaps?\n\nIt's an enzyme that breaks down cellulose. With citrus, you let it sit in a dilute solution of pectinex overnight to break down the connective tissues. You end up with perfect citrus supremes. If you let the raspberries sit for a shorter time, I wonder if it would separate the seeds the same way...?\n\nHere's an example: https:\/\/www.chefsteps.com\/activities\/perfect-citrus-supreme",
+    `labels`: 0,
+    `seconds_difference`: 2.0,
+    `score_ratio`: 2.0481927711
+}
+```
+
+where the fields are:
+- ```post_id```: the ID of the Reddit post (string)
+- ```domain```: the subreddit and split the example is drawn from, separated by an underscore (string)
+- ```upvote_ratio```: the upvote ratio of the Reddit post (float)
+- ```history```: the post title concatented to the post body (string)
+- ```c_root_id_A```: the ID of comment A (string)
+- ```c_root_id_B```: the ID of comment B (string)
+- ```created_at_utc_A```: utc timestamp of when comment A was created (integer)
+- ```created_at_utc_B```: utc timestamp of when comment B was created (integer)
+- ```score_A```: score of comment A (integer)
+- ```score_B```: score of comment B (integer)
+- ```human_ref_A```: text of comment A (string)
+- ```human_ref_B```: text of comment B (string)
+- ```labels```: the preference label -- it is 1 if A is preferred to B; 0 if B is preferred to A. This was randomized such that the label distribution is roughly 50/50. (integer)
+- ```seconds_difference```: how many seconds after the less preferred comment the more preferred one was created (will always be positive) (integer)
+- ```score_ratio```: the ratio score_A:score B (will be >= 2) (float)
+
+
+## Disclaimer
+
+Although we filtered out posts with NSFW (over 18) content, some of the data may contain discriminatory or harmful language.
+The data does not reflect the views of the dataset creators.
+Please only engage with the data in accordance with your own personal risk tolerance. 
+
+Reddit users on these subreddits are also not necessarily representative of the broader population, which one should keep in mind before using any models trained on this data.
+As always, remember to evaluate!
+
+
+## FAQs
+
+**Q**: *I'm trying to train a FLAN-T5/T5 model on these preferences, but the loss won't converge. Help!*
+
+**A**: The most likely problem is that you're feeding the post text AND one or both comments as input, which is a lot larger than the 512 tokens these models can support.
+Even though they use relative position embeddings, in our experience, this is not helpful when training a preference/reward model on this data.
+To avoid this, truncate the post text as much as possible, such that the whole input is under 512 tokens (do not truncate the comment(s) however). If this is still over 512 tokens, simply skip the example.
+This should allow you to still train on most of the examples and get a preference model that is still ~75% accurate at predicting human preferencess.
+We are currently training a preference model on this data and will make it available shortly.
+
+**Q**: *Why did you use threshold the score ratio rather than the score difference when filtering preferences?*
+
+**A**: Some Reddit posts get far less traffic than others, which means their comments have lower absolute scores. 
+An absolute difference threshold would disproportionately exclude comments from these posts, a kind of bias that we didn't want to introduce.
+
+**Q**: *Did you scrape every post on those 18 subreddits?*
+
+**A**: No. Reddit makes it very difficult to get anything beyond the top 1000 posts. 
+We started with the top-scoring 1000 posts (of all time) and searched for the 25 most similar posts to each one using the Reddit search function.
+By doing this recursively, we scraped up to 7500 post IDs for each subreddit and then used the AsyncPRAW API to scrape the top 50 comments from each post.
+We limited the scraping to 50 comments per post because the number of comments per post is Pareto-distributed, and we did not want a relatively small number of posts dominating the data.
+
+**Q**: *How did you preprocess the text?*
+
+**A**: We tried to keep preprocessing to a minimum. Subreddit-specific abbreviations were expanded ("CMV" to "Change my view that"). 
+In hyperlinks, only the referring text was kept and the URL was removed (if the URL was written out, then it was kept).
+
+
+## Contact
+
+Please contact kawin@stanford.edu if you have any questions about the data.