Spaces:
Runtime error
Runtime error
File size: 3,498 Bytes
7a514e6 c900913 7a514e6 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
---
license: apache-2.0
title: FastAPI-Docker-Very-Basic-Sentiment-Analysis
sdk: docker
emoji: 💻
colorFrom: blue
colorTo: purple
short_description: This API utilizes a machine learning model to analyze text.
---
# Very Basic Sentiment Analysis API
## Table of Contents
- [Introduction](#introduction)
- [Overview](#overview)
- [Dependencies](#dependencies)
- [Installation](#installation)
- [Usage](#usage)
- [Testing](#testing)
- [Hugging Face Space](#hugging-face-space)
- [Contributors](#contributors)
- [License](#license)
## Introduction
This API utilizes a machine learning model to analyze text for sentiment, categorizing input as positive, negative, or neutral. It leverages a pre-trained BERT model from Hugging Face Transformers, integrated within a FastAPI framework to provide quick and reliable sentiment analysis.
## Overview
This project was developed to demonstrate the ability to deploy a machine learning model using FastAPI and Docker, making it accessible as a web API. The sentiment analysis model used is based on BERT, a transformer model pre-trained on a large corpus of text and fine-tuned for sentiment analysis.
## Dependencies
- **FastAPI**: A modern, fast (high-performance) web framework for building APIs with Python 3.7+ based on standard Python type hints.
- **Docker**: A set of platform-as-a-service products that use OS-level virtualization to deliver software in packages called containers.
- **Pydantic**: Data validation and settings management using python type annotations.
- **Hugging Face Transformers**: Provides thousands of pre-trained models to perform tasks on texts such as classification, information extraction, question answering, summarization, translation, text generation, etc in 100+ languages. This project specifically utilizes the [Sentiment Analysis BERT model by MarieAngeA13](https://huggingface.co/MarieAngeA13/Sentiment-Analysis-BERT?text=I+like+you.+I+love+you) for analyzing text sentiment.
- **pytest**: A framework that makes it easy to write simple tests yet scales to support complex functional testing.
## Installation
Follow these instructions to set up the API locally:
### Clone the repository
```bash
git clone https://github.com/abdoolamunir/very-basic-sentiment-analysis.git
cd very-basic-sentiment-analysis
```
### Build the Docker Container
This command builds the Docker container, which includes installing all the necessary dependencies from 'requirements.txt'.
```bash
docker build -t sentiment-analysis-api .
```
### Run the Docker container
```bash
docker run -p 8000:8000 sentiment-analysis-api
```
## Usage
After Launching the API, you can use it as follows:
### Open Swagger UI
```bash
http://localhost:8000/docs
```
## Analyze text sentiment
To analyze the text sentiment, send a POST requent:
```bash
curl -X 'POST' \
'http://localhost:8000/analyze' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{"text": "This product is great!"}'
```
## Example Response
```json
{
"result": [
{
"label": "POSITIVE",
"score": 0.9999
}
]
}
```
## Testing
To run the tests, execute the following command:
```bash
pytest
```
## Hugging Face Space
The API is also deployed on Hugging Face Spaces. You can access it here: []()
## Contributors
Abdullah Munir & anyone who wants to use this basic framework and add onto it :)
## License
This project is released under the Apache License 2.0. See the LICENSE file in the repository for more details. |