tonereader

A Python library that detects sarcasm in text.

https://img.shields.io/github/license/DavidNguyen2002/tonereaderGitHub https://img.shields.io/github/issues/DavidNguyen2002/tonereaderGitHub issues https://github.com/DavidNguyen2002/tonereader/workflows/Build%20Status/badge.svg?branch=mainBuild Status https://codecov.io/gh/DavidNguyen2002/tonereader/branch/main/graph/badge.svg?token=58NMOY5XZEcodecov https://img.shields.io/pypi/v/tonereaderPyPI https://img.shields.io/readthedocs/tonereaderRead the Docs

Overview

Have you ever read a message from someone and were unsure about whether they were being serious or not? Is it difficult for you to figure out of someone is being sarcastic through text? Now, tonereader can help you with that!

Using training data from Reddit, tonereader can analyze text and determine whether or not the speaker is being sarcastic. So far, this library uses an ngram model which does not yield great results; however, I would like to make this project more sophisticated in the future.

Installation

To install tonereader, simply run

pip install tonereader

Usage

Right now, most of the methods written are used to train the model. These methods allow you to pass in more training data into the model.

To use the sarcasm-detecting function, simply run

is_sarcastic(text)

which will return a boolean.