An end-to-end pipeline based on Jupyter notebooks to detect, extract, process and anlayze emotion over time in text.
Explore the docs »
Quick Video Overview
·
Cambridge University Press Elements by Katherine Elkins
·
Report a Bug or Request a Feature
·
More Research by Jon Chun and Katherine Elkins
·
References on Sentiment Analysis, AffectiveAI and Related Topics
Table of Contents
- Welcome
- Background
- Features
- Sentiment Analysis Models
- Notebooks and Dataflow
- Reference Corpora
- Installation
- Examples
- License
- Contact and Contribute
Fig 2: Efficient Exploratory Data Analysis (EDA) by Domain Expert to customize Models, Hyperparameters and Time Series Processing
Fig 3: Automatic Peak/Valley detection and Text Extraction around Crux Points
SentimentArcs is a novel methodology and software framework for analyzing emotion in long texts or sequenced collections of shorter texts using Diachronic Sentiment Analysis. It segments any corpus of long text into semantic units (e.g. sentences, tweets, financial posts), applying an ensemble of over three dozen NLP sentiment analysis models from simple lexical models to state-of-the-art Transformer models. The resulting sentiment time series can be smoothed so key features like peaks and valleys can be detected and the surrounding text around these key crux points can be extracted for analysis by domain experts.
For literary experts features like peaks and valleys often correspond to key crux points in a narrative. For a financial analyst, these could represent regime changes or arbitrage opportunities. For a social media analysts, these swings in could represent shifting public opinion on key topics, public figures or even terrorist cell activities. SentimentArcs is built around a large ensemble of sentiment analysis models that surface interesting emotional arcs that domain experts can use to efficiently detect subtle and complex ground truths hidden within any sequenced body of text.
SentimentArcs is the result of many years of our experiences researching a wide variety of AI and machine learning techniques to assist human experts in the extremely challenging task of analyzing and generating natural language texts. This includes a focus on AffectiveAI approaches to analyzing diverse textual corpora including literature, social media, news, scripts, lyrics, speeches, poems, financial reports, legal documents, etc. Virtually all sequential long-form texts have detectable and measurable sentiment changes over time that reveal cohesive narrative elements. SentimentArcs helps domain experts efficiently arbitrate between competing machine learning and AI NLP models to quickly and efficiently identify, analyze and discover latent narratives elements and emotional arcs in text.
SentimentArcs is the novel software framework underlying Katherine Elkins upcoming Cambridge Elements book . This text speaks to the domain expert in Narrative Studies, Comparative Literature and English who want to learn how to use NLP sentiment analysis in general, and SentimentArcs in particular, for analyzing literature. The approach in this Cambridge Elements text is entirely generalizable to other fields. A more technical introduction to the core framework of SentimentArcs can be found in the October 2021 ArXiv paper by Jon Chun. The Abstract of this paper outlines the technical focus and practical goals of SentimentArcs:
SOTA Transformer and DNN short text sentiment classifiers report over 97% accuracy on narrow domains like IMDB movie reviews. Real-world performance is significantly lower because traditional models overfit benchmarks and generalize poorly to different or more open domain texts. This paper introduces SentimentArcs, a new self-supervised time series sentiment analysis methodology that addresses the two main limitations of traditional supervised sentiment analysis: limited labeled training datasets and poor generalization. A large ensemble of diverse models provides a synthetic ground truth for self-supervised learning. Novel metrics jointly optimize an exhaustive search across every possible corpus:model combination. The joint optimization over both the corpus and model solves the generalization problem. Simple visualizations exploit the temporal structure in narratives so domain experts can quickly spot trends, identify key features, and note anomalies over hundreds of arcs and millions of data points. To our knowledge, this is the first self-supervised method for time series sentiment analysis and the largest survey directly comparing real-world model performance on long-form narratives.
- The largest ensemble of open NLP sentiment analysis models that we know of (currently over 3 dozen)
- Efficient and Flexible Human-in-the-Loop to supervise, customize, tune the entire end-to-end process of sentiment analysis
- Flexible statistical, visualization and text customizations so Domain Experts can easily identify, extract and analyze key features and surrounding text from sentiment time series.
- Access to domain-specific baselines (Novels, Finance and Social Media) based upon carefully curated corpora
- Novel Time Series Synthesis and Data Augmentation for NLP Sentiment Analysis Time Series
- Novel Peak Detection Algorithms customized for NLP Sentiment Analysis Time Series
- Easy access via free Google Colab Jupyter notebooks with access to powerful GPU accelerators
- Minimal setup, training and support costs
- Text preprocessing (cleaning, advanced sentence segmentation, custom stopword sets, etc)
- An ensemble of over 3 dozen Sentiment Analysis Models including a diverse representation of major families (including the most popular sentiment analysis libraries and models from both R and Python as well as some AutoML techniques):
- Lexical
- Heuristics
- Linguistic
- GOFAI Machine Learning
- Deep Neural Networks & AutoML
- State of the Art Transformer Models
Concretely, SentimentArcs consists of a series of software modules embodied as Jupyter notebooks and supporting libraries designed to work on Google's free Colab service. Notebooks are executed in sequence reflecting different steps in the pipeline from text cleaning to sentiment time series analysis. Despite some shortcomings, Google Colab offers the lowest technical barrier for the widest range of non-technical domain experts as well as powerful-GPU backed Jupyter notebooks required for the most powerful state-of-the-art models in our ensemble. SentimentArc models/notebooks include:
SentimentArcs is best viewed as an ordered pipeline of Google Colab Jupyter Notebooks that are run in sequence as follows:
- Notebook 0: Copy SentimentArcs Github repo to your Google GDrive (run once at setup or to reset)
- Notebook 1: Preprocessing Text
- Notebook 2: Sentiment Analysis Models: R Lexicon and Heuristic using SyuzhetR(4) and SentimentR(8)
- Notebook 3: Sentiment Analysis Models: Python Lexicon, Heuristic and ML
- Notebook 4: Sentiment Analysis Models: DNN and AutoML
- Notebook 5: Sentiment Analysis Models: Transformers(11)
- Notebook 6: Analysis, Visualizations, Smoothing and Crux Extraction
Data flows through the project subdirectory structure in a corresponding manner:
- text_raw: minimally prepared textfiles for the corpus
- text_clean: text further cleaned by SentimentArcs
- sentiment_raw: raw sentiment values for all texts in the corpus
- sentiment_clean: processed sentiment time series
- graphs_cruxes: extracted key features/crux points with surrounding text
SentimentArcs can be viewed as an end-to-end pipeline to detect, extract, preprocess and analyze sentiment in any corpus of long-form texts. This includes both individual long-form texts as well as corpora compiled from individually time-sequenced smaller texts like compilations of specific authors, genres, or periods as well as tweets, financial reports, topical news articles, speeches, etc. Initially, SentimentArcs is focused on offering users both carefully curated reference corpora to provide a ground truth and a baseline reference for specific genres of text including novels, financial texts and social media. SentimentArcs also enables users to create new corpora of customized texts for specialized sentiment analysis tasks and analysis. Currently, SentimentArcs provides reference corpora for these types of texts (with more to be added in the future):
- Novels
- Financial Texts
- Social Media
For example, the reference corpus for novels consists of 25 narratives selected to create a diverse set of well-recognized novels that can serve as a benchmark for sentiment analysis of other texts. The novel corpora spans approximately 2300 years from Homer’s Odyssey to the 2019 Machines like Me by award-winning author Ian McEwan. Early 20th-century modernists are emphasized by authors like Marcel Proust and Virginia Woolf. In sum, the corpora include (1) the two most popular novels on Gutenberg.org (Project Gutenberg, 2021b), (2) eight of the fifteen most assigned novels at top US universities (EAB, 2021), and (3) three works that have sold over 20 million copies (Books, 2021). There are eight works by women, two by African-Americans and five works by two LGBTQ authors. Britain leads with 15 authors followed by 6 Americans and one each from France, Russia, North Africa and Ancient Greece.
SentimentArcs relies upon Google Colab to provide easy-to-use, ubiquitous and free access to powerful GPU-backed Jupyter Notebooks. Here are the free resources you should sign-up to use SentimentArcs:
- Google GMail Account (to have access to GDrive)
- Activate Colab Jupyter Notebooks to your GDrive from the Google Workspace Market
- Github account (to report issues or comments)
Colab Jupyter Notebooks offer several significant advantages including easy access via an intuitive web browser, low/no support costs and a powerful GPU backend VM for free. However, it comes with some limitations to be aware of including required sequential execution, latencies and limited interface design.
To set up SentimentArcs, please carefully follow the instructions below as each step depends upon the previous steps.
- Authenticate to gDrive: Login to Google, go to your GDrive and create a subfolder to hold your copy of the SentimentArc project (e.g. /MyDrive/sentimentarcs_notebooks/)
- Enable Colab Jupyter Notebooks: Be sure you have connected the Colab Notebooks app from the Google Workplace Market.
- Create SentimentArcs_Notebooks directory structure:
- Navigate to your SentimentArcs project subdirectory and create/open a new Colab Notebook.
- On the new blank Colab Notebook, to the top left corner and select [File]->[Open Notebook]. When a pop-up window appears, select the [Github] from the right side of the top horizontal menu.
- Enter 'https://github.com/jon-chun/sentimentarcs_notebooks/blob/main/notebooks/sentiment_arcs_part0_setup.ipynb' on the top line after the prompt [Enter a GitHub URL or search by organization or user], click the search icon, and select 'sentiment_arcs_part1_text_preprocessing.ipynb' from the list below.
- When the Colab notebook opens, select [File]->[Save a Copy in Drive] from the top left menu bar to create a copy of this notebook in a new browser tab and switch to the new copy titled 'Copy of...'
- Select the parent directory where to create the SentimentArcs_Notebooks subdirectories and execute all cells (Authorize this Colab notebook to connect to your gDrive).
- You should never run SentimentArcs Notebook #0 Setup again (unless deleting and reinstalling)
- Run the SentimentArcs Notebooks in order from #1 to #6
- Notebook #1: Clean Text (Required) Your starting raw text should be in plain text format, utf-8 encoded with blocks of text (titles, paragraphs) separated by two newlines.
- Notebook #2: Lexical R (Recommended) This notebook uses both Python and R Jupyter kernels to perform simple yet explainable sentiment analysis using the R Libraries SyuzhetR (lexical) and SentimentR (lexical with heuristic rules)
- Notebook #3: Lexical/ML (Optional, refactoring) This notebook uses simple lexical to simple stastistical machine learning sentiment analysis models in Python to calculate sentiment.
- Notebook #4: DNN/AutoML (Optional, refactoring) This notebook uses more sophisticated deep neural networks to calculate sentiment. It is uses both popular DNN architectures as well as AutoML approaches and can take longer to run.
- Notebook #5: Transformers (Recommended) This uses a variety Transfomer models to calculate sentiment. These are considered the best state-of-the-art (SOTA) sentiment analysis models, but our research shows this is not always the case. Our findings show performance needs to be optimized by jointly considering both each specific corpus and particular model.
- Notebook #6: Analysis (Required) This notebook combines the raw sentiment time series from all models run and then normalizes, smooths and plots them both individually and together. It also detects peaks/valleys, extracts corresponding text around these crux points and calculates metrics.
- Run the first code cell to 'Connect Google GDrive' and grant permission for this notebook to connect to your GDrive.
- Edit the input on the second code cell to point to the SentimentArcs project directory you defined in Step 1 and other information asked. Be sure to execute this code cell after entering this information.
- Executing the next cell should copy over the current SentimentArcs code from Github if it does not already exist in your GDrive.
At DHColab we use Sentiment Analysis to analyze and extract features from all kinds of texts including: novels, social media, news, filings financial filings, lyrics, speeches, research papers, lyrics, poems, etc. SentimentArcs is a formalization of many of the best practices we developed over the years. Each type of text (e.g. Novels, Social Media, News, Financial Texts, etc) shares common analysis techniques as well as requires customized methodologies tailored to each genre. For example, for novels we are seeking to surface latent features of narrative like plot, financial texts often reveal shifts in investor sentiment, and peaks/valleys in social media sentiment can reflect shifts in public opinion on current events, political candidates or new products/services.
In addition to Dr. Elkins' Cambridge Elements text referenced above, here are several examples from our DHColab that demonstrate the use of sentiment analysis to analyze various types of text.
Novels:
- Adapted Arcs: Sentiment Analysis and The Sorcerer's Stone by Erin Shaheen
- Doubles and Reflections: Sentiment Analysis and Vladimir Nabokov’s Pale Fire by Catherine Perloff
Financial Texts:
- Computational Approaches to Predicting Cryptocurrency Prices by Chris Pelletier
Social Media:
- Analyzing Covid-19 Through a Sentiment Analysis of Twitter Data by Cameron Catana
SentimentArcs arose from a multi-year collaboration between academia and industry and across disciplines including comparative literature, econometrics, social sciences, data analytics and ML/AI among others. The world is too interconnected, the interesting problems are too challenging and the solutions are both too complex as well as interdisciplinary in nature for any one domain expert.
As a result, we welcome collaboration and contributions that can help grow SentimentArcs into the premier NLP tool for sentiment analysis which includes experts from both technical and non-technical domains. Here are just a few ways you could contribute to SentimentArcs, the broader Digital Humanities, and NLP community:
- Use SentimentArcs to analyze existing reference corpora to identify strengths/limitations of various models, optimal hyperparameters, interpretations, etc
- Contribute new texts (e.g. novels, financial reports, social media compilations)
- Compile, expand upon the reference corpora for Finance, Social Media, or other text genres
- Suggest or contribute code to add new sentiment analysis models
- Help with documentation, training and interpretation
- Bug identification/fixes
- Suggestions or code for new features and improved performance