Customizable Case-Based Reasoning (CBR) toolkit for Python with a built-in API and CLI.
Project description
CBRkit
Customizable Case-Based Reasoning (CBR) toolkit for Python with a built-in API and CLI.
CBRkit
[!caution] The project is under active development and does not yet adhere to semantic versioning. Breaking changes may occur at any time for versions
0.x.y
. Once the project reaches version1.0
, semantic versioning will be applied.
Installation
The library is available on PyPI, so you can install it with pip
:
pip install cbrkit
It comes with several optional dependencies for certain tasks like NLP which can be installed with:
pip install cbrkit[EXTRA_NAME,...]
where EXTRA_NAME
is one of the following:
nlp
: Natural Language Processing (NLP), includingspacy
,openai
, andsentence-transformers
cli
: Command Line Interface (CLI)api
: REST API Serverall
: All of the above
Usage
CBRkit allows the definition of similarity metrics through composition. This means that you can easily build even complex similarities by mixing built-in and/or custom measures. CBRkit also includes predefined aggregation functions. A working retrieval example can be found as part of our testing suite.
The following modules are part of CBRkit:
sim
: Similarity generator functions for various data types (e.g., strings, numbers).global_sim
: Similarity generator functions for aggregating the above ones.retrieval
: Functions for retrieving cases based on a query.typing
: Generic type definitions for defining custom functions.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.