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.82.tar.gz (101.0 kB 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.82-py3-none-any.whl (88.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ripple_down_rules-0.4.82.tar.gz
  • Upload date:
  • Size: 101.0 kB
  • 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.82.tar.gz
Algorithm Hash digest
SHA256 eb72ef1eddd4a10ed094cf55431c64469cee6af902677597d39455f661cbe031
MD5 bfaa2e65ae5b38ba863ccca036db001b
BLAKE2b-256 d0dcc8e3c917ccca7238181314ad5f05a1cc1bbb49b619f0a1a8949ce8103563

See more details on using hashes here.

Provenance

The following attestation bundles were made for ripple_down_rules-0.4.82.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.82-py3-none-any.whl.

File metadata

File hashes

Hashes for ripple_down_rules-0.4.82-py3-none-any.whl
Algorithm Hash digest
SHA256 411912107e8e15251fbf43a2a6fd6cb152dfdb991da910854e50bb245c969f3c
MD5 abc91a9d46f92f2cb0653621e261498d
BLAKE2b-256 ec656a338310b160bcf1e619d73275a9c21a3a336ad0057b602d02de1fc5c966

See more details on using hashes here.

Provenance

The following attestation bundles were made for ripple_down_rules-0.4.82-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