# General

Heat detector is a StackApp whose goal is to catch offensive, rude, snarky comments and comments that leads to abusive content (offensive, spam posts or previous offensive comments). It is running a bot that queries [comments from the Stack Exchange API](https://api.stackexchange.com/docs/comments) and retrieves all comments posted on [Stack Overflow](https://stackoverflow.com/).

The automatic detection is based on a mix of regular expressions and NLP (Natural Language Processing). When a comment is classified as "rude" by the system, it is sent in a dedicated chat room for manual review and feedback.

**Example**

[![output][1]][1]


To avoid storing comments in chat transcript (unearth buried fights), the comment is automatically deleted from chat before the timeout (which is a 2 minute window).

The bot also has a **test function** and a **report function**, that enables the possibility to test different comments and to train the classifiers on uncaught content.

# Implementation

The comments API is queried every 1.5 to 3 minutes depending on the traffic, the objective being to get all last comments within 1 page result (max 100 comments), to reduce API calls to a minimum.

All comments are processed both by regex and machine learning algorithms (NLP) and they all contributes to a final score. If the score is above a defined threshold then the comment is send to chat.

## Pre-processing
Before applying a regex detection, the comment is pre-processed, removing usernames, HTML tags and repetitive characters. In the same way, before NLP classification, code blocks, links and non normal ASCII characters are removed.

## Regular expressions
The regex system is divided in three external text files; high, medium and low scoring regex. 

## Natural language processing (NLP)
Currently 2 different NLP systems are used. On the basis of the predicated value the score is increased.

### NLP Feed

The classifier has a feed divided in 2 categories, the good feed that is a download of old (>90 days) comments from the comment API and a bad feed that is a composition of:

 1. [Feed provided by SE](http://meta.stackoverflow.com/a/327148/5292302), these comments have been reviewed manually and almost 50% removed as they did not seem to be within scope
 2. Comments captured incorrectly or correctly during testing
 3. [Twitter feed](http://meta.stackoverflow.com/a/326617/5292302) provided by [Laurel](http://meta.stackoverflow.com/users/6083675/laurel)

Currently the feed contains 2000 good SO comments and 2000 (1000 SO, 1000 Twitter) bad comments.

### [NaiveBayesMultinomialText][2]

The classifier runs with these primary settings:

> **useWordFrequency**: false (comments are to short to use word frequency)<br/> 
> **lowercaseTokens**: true<br/>
> **NormalizeDocLenght**: false<br/>
> **Stemmer**: IteratedLovinsStemmer<br/>
> **Stopwords**: [Standard english stopwords][3]<br/>
> **Tokenizer:** NGramTokenizer (min 1, max 3)

The settings have been chosen on the basis of cross validation and classification result on the training set. Testing on the training set has correctly classified instances at 99.075%.

[![Classifier result][4]][4]

### [Apache OpenNLP][5]

Apache Open NLP standard `DocumentCategorizerME`, is used with these non default settings:

> **FeatureGenerator**: BagOfWordsFeatureGenerator<br/>
> **WhitespaceTokenizer**: WhitespaceTokenizer.INSTANCE<br/>
> **CUTOFF_PARAM**: 0<br/>
> **ITERATIONS_PARAM**: 4000<br/>

Testing on training set has correctly classified instances at 99.823%, with 7 comments out of 4000 not classified correctly.

[![OpenNLP result][6]][6]

### Other classifiers

Other classifiers as [J48][7], [SMO][8] and [SGDText][9] have been tested, but didn't provide good enough results.

## Accounts

The bot runs under the user [Queen](http://stackoverflow.com/users/6294609/queen), which is the same as [SOCVFinder](http://stackapps.com/questions/6910/socvfinder-providing-enjoyable-reviewing-live-duplicate-notifications-and-cher). The main reason for this is to leverage calls to the comments API, since SOCVFinder is already querying it to fetch possible duplicates.

## Source code

Source code is available on [GitHub](https://github.com/jdd-software/SOCVFinder).

## Status

This StackApp is currently in **testing phase**, to understand correct regex and especially to improve feed, including new bad SO comments replacing the Twitter feed comments. The objective is to run on 3000 good/bad only SO comments. 


  [1]: https://i.sstatic.net/yOsWX.png
  [2]: http://weka.sourceforge.net/doc.dev/weka/classifiers/bayes/NaiveBayesMultinomialText.html
  [3]: https://github.com/SOCVFinder/SOCVFinder/blob/master/SOCVDBService/ini/stop_word.txt
  [4]: https://i.sstatic.net/IKIg9.png
  [5]: https://opennlp.apache.org/
  [6]: https://i.sstatic.net/Dkh39.png
  [7]: http://weka.sourceforge.net/doc.dev/weka/classifiers/trees/J48.html
  [8]: http://weka.sourceforge.net/doc.dev/weka/classifiers/functions/SMO.html
  [9]: http://javadox.com/nz.ac.waikato.cms.weka/weka-dev/3.7.10/weka/classifiers/functions/SGDText.html