Skip to content

Latest commit

 

History

History
144 lines (101 loc) · 2.72 KB

README.md

File metadata and controls

144 lines (101 loc) · 2.72 KB
Raw

tslr.io - NLP api

NLP text summarization, analysis, and classification pipelines built using TensorFlow and Transformers with a Flask api


Table of Contents
  1. About The Project
  2. Roadmap
  3. Getting Started
  4. Usage
  5. Contributing
  6. License
  7. Contact

About The Project

Built With

Roadmap

Getting Started

Prerequisites

Python >= 3.5

Installation

  1. Clone the repo 
    git clone https://github.com/tslr/ml
cd ml
  2. Install Virtualenv 
    pip install virtualenv
  3. Create virtualenv 
    virtualenv venv --python=3.8
    or 
    python3 -m virtualenv venv --python=3.8
  4. Activate Virtualenv 
    source ./venv/bin/activate
  5. Install all dependencies 
    pip install -r requirements.txt

Usage

-> Run the flask app

cd app
python app.py

-> Run as a docker container

./start.sh

The api runs at localhost:5000/.

Contributing

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/{feature})
  3. Commit your Changes (git commit -m 'Add some feature')
  4. Push to the Branch (git push origin feature/feature)
  5. Open a Pull Request

License

Contact

Zayaan Moez - @zayaanmoez | Malcolm Yeh - @malcolmyeh

Project Link: https://github.com/tlsrio/ml