Awesome
Allay
The Allay project is deployed on Heroku.
The data science content moderation API is deployed on Heroku.
Contributors
Project Overview
Tech Stack
We use Python in Jupyter Notebooks to explore and model the data. We then save that model and implement it within a FastAPI app, which is deployed to Heroku for live classification of Allay user generated content.
We use Weights & Biases for machine learning tracking and to automate and report hyperparameter tuning for model optimization.
We use Keras with Tensorflow for modeling.
Predictions
We implement Natural Language Processing using a text classifier model to categorize whether reviews posted to the Allay website are appropriate.
<img src="https://i.imgur.com/ccUMIze.png" width="500"> <img src="https://i.imgur.com/BW4K5W9.png" width="500">Explanatory Variables
Ultimately, the explanatory variable is the text that is posted to the website. This gets broken down into numerical features which are then modeled.
Data Sources
- Hate and Abusive Speech on Twitter (code)
- Large Scale Crowdsourcing and Characterization of Twitter Abusive Behavior (paper)
- Automated Hate Speech Detection and the Problem of Offensive Language (code)
- Automated Hate Speech Detection and the Problem of Offensive Language (paper)
- Twitter Hate Speech
- Allay user content
Python Notebooks
Baseline Traditional ML models
Baseline Neural Network models
How to connect to the web API
How to connect to the data API
Allay DS API Redoc Documentation
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.
Please note we have a code of conduct. Please follow it in all your interactions with the project.
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 Allay backend for details on the backend of our project.
See Allay frontend for details on the front end of our project.
See API Documentation for details on the data science API of our project.
See Exploration readme for details on Weights and Biases hyperparameter sweeps.