Skip to main content

logo koolsla

https://github.com/abdullahselek/koolsla/workflows/koolsla%20ci/badge.svg https://img.shields.io/pypi/v/koolsla.svg https://img.shields.io/pypi/pyversions/koolsla.svg https://readthedocs.org/projects/koolsla/badge/?version=latest https://codecov.io/gh/abdullahselek/koolsla/branch/master/graph/badge.svg

Linux

Windows

https://travis-ci.org/abdullahselek/koolsla.svg?branch=master https://ci.appveyor.com/api/projects/status/l5bt8yw7n35cvsov?svg=true

Description

koolsla (Coleslaw) is a recommendation tool based on Machine Learning with contents. Developed with the power of tf-idf and Cosine Similarity.

The user gives a natural number that corresponds to the ID of a unique dish name. Through tf-idf the plot summaries of 424508 different dishes that reside in the dataset, are analyzed and vectorized. Set of dishes (number set by user) is chosen as recommendations based on their cosine similarity with the vectorized input.

koolsla is mainly an educational project.

Installation

You can install koolsla using:

$ pip install koolsla

Getting the code

The code is hosted at https://github.com/abdullahselek/koolsla

Check out the latest development version anonymously with:

$ git clone git://github.com/abdullahselek/koolsla.git
$ cd koolsla

To install test dependencies, run either:

$ pip install -Ur requirements.testing.txt

Running Tests

The test suite can be run against a single Python version which requires pip install pytest and optionally pip install pytest-cov (these are included if you have installed dependencies from requirements.testing.txt)

To run the unit tests with a single Python version:

$ py.test -v

To also run code coverage:

$ py.test --cov=koolsla

To run the unit tests against a set of Python versions:

$ tox

Sample Usage

Import recommender:

from koolsla import recommender

Getting recommendations with dish id and recommendation count:

// Returns dictionary of tuples [(dish_id_1, similarity_ratio1), (dish_id_2, similarity_ratio2), (dish_id_3, similarity_ratio3)]
recommendatons = recommender.recommend(82, 3)

CLI

After getting the code from https://github.com/abdullahselek/koolsla, run command:

$ pip install -r requirements.txt

And it’s ready to use, there is detailed help menu which you can follow. One of the most used function for recommendation:

$ python koolsla.py -d 25 --recommend 3

For the help menu:

$ python koolsla.py --help

Metadata

Release files for koolsla 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for koolsla 0.3.0
File Interpreter ABI Platform
koolsla-0.3.0-py3-none-any.whl Python 3 none any Details

Release files / koolsla-0.3.0-py3-none-any.whl

Download URL koolsla-0.3.0-py3-none-any.whl
Size 6.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
02b530927c1befaf6b90248d2f8f6d048249aca7059d77d4232c5b8244419ca3
BLAKE2b-256 checksum
How to use checksums
ea1301679bc353a7b7c94d5a8637dd028e4be78e6b3c0b343b33909f626924c0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

Release history Release notifications | RSS feed

This release

0.3.0 This release

1 release file

0.2.1

2 release files

0.2

1 release file

0.1.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page