README.md

   1 ---
   2 title: Utilities for Reddit Data Science
   3 ---
   4
   5 The reddit_cdsc project contains tools for working with Reddit data.  The project is designed for the hyak super computing system at The University of Washington.  It consists of a set of python and bash scripts and uses the [Pyspark](https://spark.apache.org/docs/latest/api/python/index.html "Pyspark documentation") and [pyarrow](https://arrow.apache.org/docs/python/ "documentation of python arrow bindings") to process large datasets.  As of November 1st 2020, the project is under active development by [Nate TeBlunthuis](https://wiki.communitydata.science/People#Nathan_TeBlunthuis_.28University_of_Washington.29 "Nate's profile on the Community Data Science Collective Wiki") and provides scripts for:
   6
   7 - Pulling and updating dumps from [Pushshift](https://pushshift.io "Pushshift.io") in `pull_pushshift_comments.sh` and `pull_pushshift_submissions.sh`.
   8 - Uncompressing and parsing the dumps into [Parquet](https://parquet.apache.org/ "apahce parquet website") [datasets](https://wiki.communitydata.science/CommunityData:Hyak_Datasets#Reading_Reddit_parquet_datasets "Wikilink to documentation on the Reddit parquet datasets").
   9 - Running text analysis based on [TF-IDF](https://en.wikipedia.org/wiki/Tf%E2%80%93idf "Wikipedia article on tf-idf") including
  10   - Extracting terms from Reddit comments in `tf_comments.py`
  11   - Detecting common phrases based on [Pointwise mutual information](https://en.wikipedia.org/wiki/Pointwise_mutual_information) "Wikipedia article on pointwise mutual information")
  12   - Building TF-IDF vectors for each subreddit `idf_comments.py` and (more experimentally) at the subreddit-week level `idf_comments_weekly.py`
  13   - Computing cosine similarities between subreddits based on TF-IDF `term_cosine_similarity.py`.
  14
  15
  16 Right now, two steps are still in earlier stages of progress:
  17
  18 - Approach comparable to tf-idf for similarity between subreddits in terms of comment authors.
  19 - Clustering subreddits based on cosine-similarities using [power iteration clustering (PIC)](http://www.cs.cmu.edu/~wcohen/postscript/icml2010-pic-final.pdf "Paper on power iteration clustering")
  20
  21 The TF-IDF for comments still has some kinks to iron out to remove hyper links and bot comments. Right now subreddits that have similar automoderation messages appear very similar.
  22
  23 The user interfaces for most of the scripts are pretty crappy and need to be refined for re-use by others.
  24
  25 ## Pulling data from [Pushshift](https://pushshift.io "Pushshift.io") ##
  26
  27 - `pull_pushshift_comments.sh` uses wget to download comment dumps to  `/gscratch/comdata/raw_data/reddit_dumps/comments`. It doesn't download files that already exists and runs `check_comments_shas.sh` to verify the files downloaded correctly.
  28
  29 - `pull_pushshift_submissions.sh` does the same for submissions and puts them in `/gscratch/comdata/raw_data/reddit_dumps/comments`.
  30
  31 ## Building Parquet Datasets ##
  32
  33 Pushshift dumps are huge compressed json files with a lot of metadata that we may not need. It isn't indexed so it's expensive to pull data from just a handful of subreddits. It also turns out that it's a pain to read these compressed files straight into spark. Extracting useful variables from the dumps and building parquet datasets will make them easier to work with.  This happens in two steps:
  34
  35 1. Extracting json into (temporary, unpartitioned) parquet files using pyarrow.
  36 2. Repartitioning and sorting the data using pyspark.
  37
  38 The final datasets are in `/gscratch/comdata/output.`
  39
  40 - `reddit_comments_by_author.parquet` has comments partitioned and sorted by username (lowercase).
  41 - `reddit_comments_by_subreddit.parquet` has comments partitioned and sorted by subreddit name (lowercase).
  42 - `reddit_submissions_by_author.parquet` has submissions partitioned and sorted by username (lowercase).
  43 - `reddit_submissions_by_subreddit.parquet` has submissions partitioned and sorted by subreddit name (lowercase).
  44
  45 Breaking this down into two steps is useful because it allows us to decompress and parse the dumps in the backfill queue and then sort them in spark. Partitioning the data makes it possible to efficiently read data for specific subreddits or authors.  Sorting it means that you can efficiently compute agreggations at the subreddit or user level. More documentation on using these files is available [here](https://wiki.communitydata.science/CommunityData:Hyak_Datasets#Reading_Reddit_parquet_datasets "Wikilink to documentation on the Reddit parquet datasets").
  46
  47 ## TF-IDF Subreddit Similarity ##
  48
  49 [TF-IDF](https://en.wikipedia.org/wiki/Tf%E2%80%93idf "Wikipedia article on tf-idf") is common and simple information retrieval technique that we can use to quantify the topic of a subreddit.  The goal of TF-IDF is to build a vector for each subreddit that scores every term (or phrase) according to how characteristic it is of the overall lexicon used in that subreddit. For example, the most characteristic terms in the subreddit /r/christianity in the current version of the TF-IDF model are:
  50
  51 | Term         | tf_idf |
  52 |:------------:|:------:|
  53 | christians   | 0.581  |
  54 | christianity | 0.569  |
  55 | kjv          | 0.568  |
  56 | bible        | 0.557  |
  57 | scripture    | 0.55   |
  58
  59 TF-IDF stands for "term frequency - inverse document frequency" because it is the product of two terms "term frequency" and "inverse document frequency." Term frequency quantifies the amount that a term appears in a subreddit (document). Inverse document frequency quantifies how much that term appears in other subreddits (documents). As you can see on the Wikipedia page, there are many possible ways of constructing and combining these terms.
  60
  61 $x + y = z_{1,d}$
  62
  63 I chose to normalize term frequency by the maximum (raw) term frequency for each subreddit:
  64 $\mathrm{tf}_{t,d} = \frac{f_{t,d}}{\sum_{t^{'} \in d}{f_{t^{'},d}}}$
  65
  66 I use the log inverse document frequency:
  67 $\mathrm{idf}_{t} = log\frac{N}{| {d \in D : t \in d} |}$
  68
  69 I then combine them using some smoothing to get:
  70
  71 $\mathrm{tfidf}_{t,d} = (0.5 + 0.5 \cdot \mathrm{tf}_{t,d}) \cdot \mathrm{idf}_{t}$
  72