Skip to main content

A clean, extensible fuzzy-logic toolkit in pure Python + NumPy

Project description

PyPI CI Docs Python versions License: MIT

fuzzytool

A clean, extensible fuzzy-logic toolkit in pure Python + NumPy. Its design priorities are a composable API, algorithm comparison, visualization and code clarity — a modern alternative to the verbose control API of scikit-fuzzy.

import fuzzytool as fz

# Credit-risk premium: a lender turns a credit score + debt-to-income ratio
# into the risk points it adds on top of its base interest rate.
score   = fz.Variable("score", (300, 850), terms=["poor", "fair", "good", "excellent"])
dti     = fz.Variable("dti", (0, 50), terms=["low", "moderate", "high"])
premium = fz.Variable("premium", (0, 12), terms=["low", "medium", "high"])

sys = fz.Mamdani(defuzz="centroid")
sys.rule(score["poor"] | dti["high"], premium["high"])        # |=OR  &=AND  ~=NOT
sys.rule(score["fair"] & dti["moderate"], premium["medium"])
sys.rule(score["good"] | score["excellent"], premium["low"])

print(sys(score=800, dti=10))    # the system is just callable -> a low premium

The design idea (extensibility)

The inference loop knows nothing about any concrete variant. Everything that changes lives behind small Python Protocols:

  • MembershipFunction (fuzzytool/membership.py) — a callable x -> degree. A new shape = a new callable.
  • Norm (fuzzytool/norms.py) — t-norms (AND) and s-norms (OR), resolved by name. A new connective = one registered function.
  • defuzzifiers (fuzzytool/defuzz.py) — centroid, bisector, MOM/SOM/LOM, resolved by name.

Rules read like logic thanks to operator overloading: & is the t-norm, | the s-norm, ~ the complement.

What it includes / roadmap

Phase Content Status
1 Core: membership functions, t-/s-norms, Variable, operator rules, Mamdani + defuzzification, tipper example, tests
2 Takagi-Sugeno (TSK) inference + viz (membership plots, control surface) ✅ (TSK + viz)
3 Type-2 / interval type-2 sets (footprint of uncertainty) + Karnik-Mendel type reduction
4 Fuzzy clustering: fuzzy c-means, Gustafson-Kessel, possibilistic
5 ANFIS (trainable TSK) + F-transform (direct/inverse)
6 Notebooks, JOSS paper.md, Zenodo DOI, PyPI release

See ROADMAP.md.

Install

pip install fuzzytool            # core (NumPy only)
pip install fuzzytool[viz]       # + matplotlib visualization

From source, for development:

python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev,viz,docs]"
pytest -q
python examples/tipper.py

Documentation

A documentation portal (narrative guide + API reference from docstrings) is built with MkDocs Material and published to GitHub Pages: https://fuzzytool.github.io/.

pip install -e ".[docs]"
mkdocs serve        # live portal at http://127.0.0.1:8000

License

MIT. See LICENSE.

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

fuzzytool-0.1.0.tar.gz (384.9 kB view details)

Uploaded Source

Built Distribution

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

fuzzytool-0.1.0-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

Details for the file fuzzytool-0.1.0.tar.gz.

File metadata

  • Download URL: fuzzytool-0.1.0.tar.gz
  • Upload date:
  • Size: 384.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for fuzzytool-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f3ee3d958066fffa3e6133ba40206864bca606cc565a731aee4e7866d61d1cdb
MD5 d1861b71c17c39d7f97505fc6310d497
BLAKE2b-256 97814d51e3ae024b3ac8e43f155d8f0020817f8399b9d9ccca59fa6dd1e9795a

See more details on using hashes here.

Provenance

The following attestation bundles were made for fuzzytool-0.1.0.tar.gz:

Publisher: release-pypi.yml on fuzzytool/fuzzytool.github.io

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

File details

Details for the file fuzzytool-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: fuzzytool-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 30.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for fuzzytool-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fe517deaf914ed12707b5f021d3b14fcde739dfd1161adf6d30e0c50e00cee8b
MD5 98afb35ca590fe2a87dbef9f58dcb4eb
BLAKE2b-256 435e6b84fdb6bd1495eb817a7fd274e3b219d6f5cb34cd40a947b2e605174f95

See more details on using hashes here.

Provenance

The following attestation bundles were made for fuzzytool-0.1.0-py3-none-any.whl:

Publisher: release-pypi.yml on fuzzytool/fuzzytool.github.io

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