https://github.com/bisohns/rudeboy-predictionengine

API endpoint to classify toxicity in a sentence
https://github.com/bisohns/rudeboy-predictionengine

Last synced: 10 months ago
JSON representation

API endpoint to classify toxicity in a sentence

• Host: GitHub
• URL: https://github.com/bisohns/rudeboy-predictionengine
• Owner: bisohns
• Created: 2019-11-26T12:41:50.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-12-04T18:51:47.000Z (over 6 years ago)
• Last Synced: 2025-03-17T22:59:58.266Z (over 1 year ago)
• Language: Python
• Size: 22.5 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Rudeboy-API

Categorizes toxicity levels in a sentence 

Dataset obtained from this [Kaggle competition](https://www.kaggle.com/c/jigsaw-toxic-comment-classification-challenge)

Models trained using [BigMl](https://bigml.com/accounts/register/recommendedby/deven96)

![Icon](flask_api/static/assets/point-and-shout.jpg)

[![Python flask](https://img.shields.io/badge/Python-flask-blue.svg)](https://http://flask.pocoo.org/)

![Docker Automated Build](https://img.shields.io/docker/automated/deven96/rudeboyapi.svg?style=flat)

![Docker Pulls](https://img.shields.io/docker/pulls/deven96/rudeboyapi.svg?style=flat)

[![Build Status](https://travis-ci.com/bisoncorps/Rudeboy-PredictionEngine.svg?branch=master)](https://travis-ci.com/bisoncorps/Rudeboy-PredictionEngine)[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

- [Rudeboy-API](#rudeboy-api)

  - [Getting Started](#getting-started)

    - [Installation](#installation)

  - [Running Locally](#running-locally)

  - [Deployed Version](#deployed-version)

## Getting Started

Clone the repo

```bash

    # SSH

    git clone git@github.com:bisoncorps/Rudeboy-PredictionEngine.git   

    # HTTPS

    git clone https://github.com/bisoncorps/Rudeboy-PredictionEngine.git

```

Activate virtual environment. All project work should be done in virtualenvs and virtualenv names must be added to gitignore

### Installation

- Install the requirements

```bash

    # install pipenv

    sudo pip3 install pipenv

    # install requirements

    pipenv install

```

## Running Locally

- With flask dev server

```bash

    python flask_api/server.py

```

- With Gunicorn (port 8008)

```bash

    gunicorn -b :8008 flask_api:app

```

- With deployed Docker image from docker hub

```bash

    docker run deven96/rudeboyapi

```

Upon running image, docker container port is bound to [localhost](http://localhost:8008)

## Deployed Version

Make use of the deployed version visit https://rudeboy.bisoncorps.com