Skip to content

VERSO-UVM/Heard-and-Understood-App

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

149 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HEARD & UNDERSTOODtm App

DOI

The HEARD & UNDERSTOODtm App provides a way to explore and classify silence and gaps in conversations.

Description

This is an Open Community Research Accelerator (ORCA) project in collaboration with the Vermont Conversation Lab and their GitHub organization HEARD & UNDERSTOODtm. This supports the exploration and adoption of the CONSert (Connectional Silence Ensemble-BERT) algorithm which uses a combination of Random Forests, Convolutional Neural Networks, OpenAI Whisper Transcriptions and a BERT ML model to detect, locate and classify pauses. Pauses will be classified as either Non-Connectional, Emotional, or Invitational.

Pause Types:

  • Non-Connectional - a pause that does not provide connectional context for the rest of the conversation
  • Emotional - a pause which provides time for emotional reflection
  • Invitational - a pause that invites another speaker to interact with the conversation

The methods used in this package are based on the methods used in Matt et al. 2023.

Matt et al. 2023: Matt, Jeremy E et al. “An Acoustical and Lexical Machine-Learning Pipeline to Identify Connectional Silences.” Journal of palliative medicine, 10.1089/jpm.2023.0087. 13 Jul. 2023, doi:10.1089/jpm.2023.0087

Getting Started

Installing

You will need Python 3.10 or earlier installed.

To install for development, clone this repository, navigate to it, and run pip install -e . (don't miss the period at the end)

To install for production/testing, download the .whl file for the appropriate version from the releases tab and run pip install hua-1.0.0-py2.py3-none-any.whl replacing the version to match your downloaded file.

If you want to use CONSert, follow the steps in the Consert Install Guide

Executing program

Make sure you have serviceAccountKey.json and email_credentials.py. If you installed from source for development, they'll need to be in the project's root directory. if you installed from a .whl for production/testing, they'll simply need to be in whatever directory you run the app from.

Run flask --app hua run

Building program

If you haven't already, install build by running pip install build

Then, whenever you'd like to build a new .whl file, run python -m build --wheel in the project's root directory. The .whl file will appear in the dist directory.

Help

Team

Fall 2024

  • Fernanda De Oliveira Girelli (Team Lead)
  • Johnna Schulz
  • Adrien Monks
  • Tucker Schulz
  • Felix Walberg
  • Grace Kinney (Designer/UX)

Spring 2025

  • Fernanda De Oliveira Girelli (Team Lead)
  • Johnna Schulz
  • Tucker Schulz
  • Shiloh Chiu
  • Aurelia Kornheiser
  • Grace Kinney (Designer/UX)

Version History

TBD

License

This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details

Acknowledgments

This project would not be possible without Robert "Bob" Gramling, MD and Donna Rizzo and the work by the Vermont Conversation Lab at the University of Vermont (UVM) and funding through the EpsCor SOCKS grant.

About

The Heard and Understood App provides a way to explore and classify silence and gaps in conversations.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

 
 
 

Contributors