Skip to main content

Implements the various versions of Ripple Down Rules (RDR) for knowledge representation and reasoning.

Project description

Ripple Down Rules (RDR)

A python implementation of the various ripple down rules versions, including Single Classification (SCRDR), Multi Classification (MCRDR), and Generalised Ripple Down Rules (GRDR).

SCRDR, MCRDR, and GRDR are rule-based classifiers that are built incrementally, and can be used to classify data cases. The rules are refined as new data cases are classified.

SCRDR, MCRDR, and GRDR implementation were inspired from the book: "Ripple Down Rules: An Alternative to Machine Learning" by Paul Compton, Byeong Ho Kang.

Installation

sudo apt-get install graphviz graphviz-dev
pip install ripple_down_rules

For GUI support, also install:

sudo apt-get install libxcb-cursor-dev
## Example Usage

Fit the SCRDR to the data, then classify one of the data cases to check if its correct,
and render the tree to a file:
from ripple_down_rules.datastructures.dataclasses import CaseQuery
from ripple_down_rules.rdr import SingleClassRDR
from ripple_down_rules.datasets import load_zoo_dataset
from ripple_down_rules.utils import render_tree

all_cases, targets = load_zoo_dataset()

scrdr = SingleClassRDR()

# Fit the SCRDR to the data
case_queries = [CaseQuery(case, 'species', type(target), True, _target=target)
                for case, target in zip(all_cases[:10], targets[:10])]
scrdr.fit(case_queries, animate_tree=True)

# Render the tree to a file
render_tree(scrdr.start_rule, use_dot_exporter=True, filename="scrdr")

cat = scrdr.classify(all_cases[50])
assert cat == targets[50]

To Cite:

@software{bassiouny2025rdr,
author = {Bassiouny, Abdelrhman},
title = {Ripple-Down-Rules},
url = {https://github.com/AbdelrhmanBassiouny/ripple_down_rules},
version = {0.4.1},
}

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.

Source Distribution

ripple_down_rules-0.4.85.tar.gz (3.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ripple_down_rules-0.4.85-py3-none-any.whl (89.1 kB view details)

Uploaded Python 3

File details

Details for the file ripple_down_rules-0.4.85.tar.gz.

File metadata

  • Download URL: ripple_down_rules-0.4.85.tar.gz
  • Upload date:
  • Size: 3.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ripple_down_rules-0.4.85.tar.gz
Algorithm Hash digest
SHA256 e6c8f7e6153ab4c484041a8f23a2f069d92e00cf62c6009b480c78f4af98ddae
MD5 d124eaadc8979e9ee00f82488b94d4ff
BLAKE2b-256 96bfc05b1b1adb7017e3057730a029722b8964d337e5604286d5dc9ff5d99ea7

See more details on using hashes here.

Provenance

The following attestation bundles were made for ripple_down_rules-0.4.85.tar.gz:

Publisher: publish-to-test-pypi.yml on AbdelrhmanBassiouny/ripple_down_rules

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ripple_down_rules-0.4.85-py3-none-any.whl.

File metadata

File hashes

Hashes for ripple_down_rules-0.4.85-py3-none-any.whl
Algorithm Hash digest
SHA256 ef4dd7933736f90f1d4836b8965d7ce450dda494dc6c53c3cc74b210b45d9fe8
MD5 0a16e00ebabba61631ebce7bd157f9e8
BLAKE2b-256 68f35ee02dea2e411bab98c89fe8b8a37387b06d65b6c1c84ca0fa86f132e0d1

See more details on using hashes here.

Provenance

The following attestation bundles were made for ripple_down_rules-0.4.85-py3-none-any.whl:

Publisher: publish-to-test-pypi.yml on AbdelrhmanBassiouny/ripple_down_rules

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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