Table of Contents

• About the Project
  • Requirements
• Getting Started
  • Prerequisites
  • Installation
  • Using Docker
• Usage
• License
• Contact

About The Project

Object classification using PyTorch as a web service

Requirements

See requirements.txt

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• virtualenv

pip/pip3 install virtualenv

Installation

1. Clone the repo

git clone https://github.com/tachillon/Object-Classification-PyTorch-Web-Service

2. Create a virtualenv

python3 -m venv .venv

3. Activate your virtualenv

source .venv/bin/activate

4. Install requirements

pip3 install -r requirements.txt

Using Docker

1. Build the Docker container

docker build -t <container_name>:<tag> .

Usage

1. Regular usage

python3 classificator.py

2. Using Docker

docker run --rm -p 8080:8080 <container_name>:<tag>

3. Do the POST request

POST request http://localhost:8080/classify*

*with the image encoded as base64

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Achille-Tâm GUILCHARD - achilletamguilchard@gmail.com

Project Link: https://github.com/tachillon/Object_Classification_PyTorch_Web_Service