Skip to main content

A user-friendly Python library for fuzzy logic

Project description

Python package Documentation Status

simpful

A Python library for fuzzy logic reasoning, designed to provide a simple and lightweight API, as close as possible to natural language. Simpful supports Mamdani and Sugeno reasoning of any order, parsing any complex fuzzy rules involving AND, OR, and NOT operators, using arbitrarily shaped fuzzy sets. For more information on its usage, try out the example scripts in this repository or check our online documentation.

Installation

pip install simpful

Citing Simpful

If you find Simpful useful for your research, please cite our work as follows:

Spolaor S., Fuchs C., Cazzaniga P., Kaymak U., Besozzi D., Nobile M.S.: Simpful: a user-friendly Python library for fuzzy logic, International Journal of Computational Intelligence Systems, 13(1):1687–1698, 2020 DOI:10.2991/ijcis.d.201012.002

Usage example 1: controlling a gas burner with a Takagi-Sugeno fuzzy system

This example shows how to specify the information about the linguistic variables, fuzzy sets, fuzzy rules, and input values to Simpful. The last line of code prints the result of the fuzzy reasoning.

import simpful as sf

# A simple fuzzy model describing how the heating power of a gas burner depends on the oxygen supply.

FS = sf.FuzzySystem()

# Define a linguistic variable.
S_1 = sf.FuzzySet( points=[[0, 1.],  [1., 1.],  [1.5, 0]],          term="low_flow" )
S_2 = sf.FuzzySet( points=[[0.5, 0], [1.5, 1.], [2.5, 1], [3., 0]], term="medium_flow" )
S_3 = sf.FuzzySet( points=[[2., 0],  [2.5, 1.], [3., 1.]],          term="high_flow" )
FS.add_linguistic_variable("OXI", sf.LinguisticVariable( [S_1, S_2, S_3] ))

# Define consequents.
FS.set_crisp_output_value("LOW_POWER", 0)
FS.set_crisp_output_value("MEDIUM_POWER", 25)
FS.set_output_function("HIGH_FUN", "OXI**2")

# Define fuzzy rules.
RULE1 = "IF (OXI IS low_flow) THEN (POWER IS LOW_POWER)"
RULE2 = "IF (OXI IS medium_flow) THEN (POWER IS MEDIUM_POWER)"
RULE3 = "IF (NOT (OXI IS low_flow)) THEN (POWER IS HIGH_FUN)"
FS.add_rules([RULE1, RULE2, RULE3])

# Set antecedents values, perform Sugeno inference and print output values.
FS.set_variable("OXI", .51)
print (FS.Sugeno_inference(['POWER']))

Usage example 2: tipping with a Mamdani fuzzy system

This second example shows how to model a FIS using Mamdani inference. It also shows some facilities that make modeling more concise and clear: automatic Triangles (i.e., pre-baked linguistic variables with equally spaced triangular fuzzy sets) and the automatic detection of the inference method.

from simpful import *

FS = FuzzySystem()

TLV = AutoTriangle(3, terms=['poor', 'average', 'good'], universe_of_discourse=[0,10])
FS.add_linguistic_variable("service", TLV)
FS.add_linguistic_variable("quality", TLV)

O1 = TriangleFuzzySet(0,0,13,   term="low")
O2 = TriangleFuzzySet(0,13,25,  term="medium")
O3 = TriangleFuzzySet(13,25,25, term="high")
FS.add_linguistic_variable("tip", LinguisticVariable([O1, O2, O3], universe_of_discourse=[0,25]))

FS.add_rules([
	"IF (quality IS poor) OR (service IS poor) THEN (tip IS low)",
	"IF (service IS average) THEN (tip IS medium)",
	"IF (quality IS good) OR (quality IS good) THEN (tip IS high)"
	])

FS.set_variable("quality", 6.5) 
FS.set_variable("service", 9.8) 

tip = FS.inference()

Additional examples

Additional example scripts are available in the examples folder of this GitHub and in our Code Ocean capsule.

Further info

Created by Marco S. Nobile at the Eindhoven University of Technology and Simone Spolaor at the University of Milano-Bicocca.

If you need further information, please write an e-mail at: marco.nobile@unive.it.

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

simpful-2.6.2.tar.gz (30.3 kB view details)

Uploaded Source

Built Distribution

simpful-2.6.2-py3-none-any.whl (30.1 kB view details)

Uploaded Python 3

File details

Details for the file simpful-2.6.2.tar.gz.

File metadata

  • Download URL: simpful-2.6.2.tar.gz
  • Upload date:
  • Size: 30.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for simpful-2.6.2.tar.gz
Algorithm Hash digest
SHA256 8b6517e58b4ca024ffafe136a42978922e077098f5838a680f1cbccbcdbb01b6
MD5 a783244abf3b780691ecb88fd2da50cc
BLAKE2b-256 c53ef6bafe219b70665567408692f67a70e929620f774eec5ae29301a8997d3a

See more details on using hashes here.

File details

Details for the file simpful-2.6.2-py3-none-any.whl.

File metadata

  • Download URL: simpful-2.6.2-py3-none-any.whl
  • Upload date:
  • Size: 30.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for simpful-2.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a3c4bf8c9f35d181db18a890b054e3a98b3e6125008ed827259a5e018e734e36
MD5 f487334f4fae7cf40c04c558848c9793
BLAKE2b-256 5303b70e355f95fdb448a42763fca03a688c77438073dbdf1691cd9c12afb11d

See more details on using hashes here.

Supported by

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