Skip to content

BloomTech-Labs/tagger-ds

Repository files navigation

Tagger - Smarter Email

Maintainability Test Coverage MIT PEP8

Labs 24 Contributors

Brandon Mulas Monica Bustamante
Chris Filkins Jack Lindberg

Project Overview

The idea of this project was to develop an email app similar to Gmail, Edison mail, Yahoo mail, etc. but with better organization to help you find emails easier. For the DS, we built an API that generates tags for all emails so they can be put into folders by the BE.

Trello Board

Product Canvas

Tagger - Smarter Email

Tech Stack

Models & APIs

The Tagger Data Science team put together 2 API points: one which resides in the cloud on a flask application within Amazon Web Services and the other, which lies internally within a stand-alone desktop Electron application. The Tagger cloud-based API pulls emails from the Google API. Our API then cleans these emails and runs them through an NLP (Spacy) pipeline using a latent Dirichlet allocation (a Gensim LDAMulticore modeler) to derive a topic set. Those topics are then weighted by frequency and paired with concurrent VADER Sentiment Analysis. All of this is packaged up in JSON for retrieval by the desktop application. The data science API for the desktop application, in turn, receives search requests from the end-user and searches the database of email "smart tags" to find a list of relevant email IDs, which are then output to the desktop application for presentation at the user level.

Data Sources

  • Private User E-mails within Gmail accounts. The developer can apply their own credentials using googleAuth.js. Instructions

Explanatory Variables

  • Text of the emails

Python Notebooks

Smart Tag Model Hyperparameter Optimization and Training

This notebook contains 3 working models for producing smart tags.

How to get emails from the API

You can find the data science web API endpoint for retrieving emails at: http://taggermail-env.eba-ip2ksqmm.us-east-1.elasticbeanstalk.com/api/

Please note there is also a data science application API endpoint internal to the desktop application.

METHOD: POST

Type: application/json

Data:

{
   	"provider": "gmail",
	"recent_id": "<recent_id>",
   	"token": {
        "refresh_token": "<google_auth_token>",
        "client_id": "<client_id>",
        "client_secret": "<client_secret>"
    }
}

Labs 20 Contributors

Rosie Lasota Jean Fraga

Labs 18 Contributors

Avraham Jacobsohn John Morrison Samuel Hepner

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

  • Check first to see if your issue has already been reported.
  • Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
  • Create a live example of the problem.
  • Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
  • Ensure that your code conforms to our existing code conventions and test coverage.
  • Include the relevant issue number, if applicable.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.

Additional Notes:

More info on using badges here

About

No description or website provided.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages