Skip to main content

A small API to load and search for similar products based on TF-IDF algorithm

Project description

online-retail-app

This is a FastAPI application that accepts a product description as input and returns the top 10 most similar products that are in the transaction data. The dataset used in this application is located at the following URL

Install

pip install clippie

Install the application from the local directory

pip install -e .

Run

Run the application with the following command

clippie

or

python3 src/clippie/main.py

Upon start the application loads sample dataset that is located in the data folder

API endpoints

Application listens on http://localhost:8000

Available endpoints:

  • /docs - GET - API documentation
  • /product - GET - displays list of products
  • /product?search=coala - GET - find relevant products to the provided description
  • /pipeline - POST

TODO

  • package Java jar file in order to open excel with pyspark
  • enable tempfile
  • add history of pipeline execution to GET pipeline
  • GET pipeline to see the number of pipeline that has been executed
  • the collision will happen if pipelines run in parallel?
  • Github action
  • Stop Spark on program termination
  • BUG - spark is loaded twice!
  • add debug mode with reload=True

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clippie-0.0.2.tar.gz (3.4 kB view hashes)

Uploaded Source

Built Distribution

clippie-0.0.2-py3-none-any.whl (3.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page