fuzzytool 0.1.0__py3-none-any.whl

fuzzytool-0.1.0.dist-info/METADATA

@@ -0,0 +1,126 @@
+Metadata-Version: 2.4
+Name: fuzzytool
+Version: 0.1.0
+Summary: A clean, extensible fuzzy-logic toolkit in pure Python + NumPy
+Project-URL: Homepage, https://fuzzytool.github.io
+Project-URL: Documentation, https://fuzzytool.github.io
+Project-URL: Repository, https://github.com/fuzzytool/fuzzytool.github.io
+Project-URL: Issues, https://github.com/fuzzytool/fuzzytool.github.io/issues
+Author: Jose L. Salmeron
+License: MIT
+License-File: LICENSE
+Keywords: anfis,fuzzy inference,fuzzy logic,mamdani,takagi-sugeno,type-2
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.9
+Requires-Dist: numpy>=1.21
+Provides-Extra: dev
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material; extra == 'docs'
+Requires-Dist: mkdocstrings[python]; extra == 'docs'
+Provides-Extra: notebooks
+Requires-Dist: ipykernel; extra == 'notebooks'
+Requires-Dist: jupyter; extra == 'notebooks'
+Requires-Dist: matplotlib>=3.4; extra == 'notebooks'
+Requires-Dist: nbconvert; extra == 'notebooks'
+Requires-Dist: nbformat; extra == 'notebooks'
+Provides-Extra: viz
+Requires-Dist: matplotlib>=3.4; extra == 'viz'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <a href="https://pypi.org/project/fuzzytool/"><img src="https://img.shields.io/pypi/v/fuzzytool?logo=pypi&logoColor=white" alt="PyPI"></a>
+  <a href="https://github.com/fuzzytool/fuzzytool.github.io/actions/workflows/ci.yml"><img src="https://github.com/fuzzytool/fuzzytool.github.io/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://fuzzytool.github.io/"><img src="https://img.shields.io/badge/docs-fuzzytool.github.io-3f51b5" alt="Docs"></a>
+  <img src="https://img.shields.io/pypi/pyversions/fuzzytool?logo=python&logoColor=white" alt="Python versions">
+  <img src="https://img.shields.io/badge/license-MIT-blue" alt="License: MIT">
+</p>
+
+# 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.
+
+```python
+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`](ROADMAP.md).
+
+## Install
+
+```bash
+pip install fuzzytool            # core (NumPy only)
+pip install fuzzytool[viz]       # + matplotlib visualization
+```
+
+From source, for development:
+
+```bash
+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/>.
+
+```bash
+pip install -e ".[docs]"
+mkdocs serve        # live portal at http://127.0.0.1:8000
+```
+
+## License
+
+MIT. See [`LICENSE`](LICENSE).

fuzzytool-0.1.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+fuzzytool/__init__.py,sha256=l8b2zG9RUvyzK6BgLgYREI0AOZF381c7_jTvc7dOvqE,1879
+fuzzytool/anfis.py,sha256=6z5447OH_QewKrq9aruS67xlJKyXRbUDc9ejao-gAqI,6271
+fuzzytool/cluster.py,sha256=nmvlEhyID4I4ezLrUvaXKclm59tDzJEiA9mTYVk8zDY,8187
+fuzzytool/datasets.py,sha256=2xy4eUtka_Q19VNNplXIsu0ebFYFgYERt2EJuilG_Sc,3768
+fuzzytool/defuzz.py,sha256=BWNIVL-P-uSoN8fhmFW8fU0c_h2GYOO3FsvZ1c_hgsI,2500
+fuzzytool/ftransform.py,sha256=TtHzhn1ALQuyvpx-wts6LkpYBHVSdGj7zSvWZ2gD5ms,2976
+fuzzytool/membership.py,sha256=g8frbFTo7PCrzczCbdLfi_4Zl9aXvOz3Ma091ZbQY0Q,5214
+fuzzytool/norms.py,sha256=_uBvWslpMA8NiTM-_plAFaoDcJeeXXd_XkMs86rRYYo,2678
+fuzzytool/rules.py,sha256=63u5sUqi-R78eemyVy8VIzly-l7CnrvPPLlyyspJC_Y,966
+fuzzytool/sets.py,sha256=FmvzP_KX4scelCXG6Sov42WvyAWIcqb7hx8bJdtIENA,7864
+fuzzytool/viz.py,sha256=FBpvSG_sFC9fX7-_L2Ib4deTgYgZ4Hsm2_MLexYYIGg,4026
+fuzzytool/inference/__init__.py,sha256=d1IvwMUQ7DKy53zZJT4ER3OVIVrcmNk2HlGqv0yOHG4,112
+fuzzytool/inference/mamdani.py,sha256=-j46PC80ZBIrXMCGD1PQabWmW3teaLpAqp3_opJT0nU,3691
+fuzzytool/inference/tsk.py,sha256=eJ_c2LnQkkvVDOKaV6IMP2XzzkxRgFxWh96hx7xptqQ,2720
+fuzzytool/type2/__init__.py,sha256=t9j46DuP317_THKCEZpBJzRR8GlQfGwv4XCGjYkklLE,972
+fuzzytool/type2/inference.py,sha256=tUTKFzwV_mHoRERrjIcxxtdPH0m0Cshep2JEBik0ec0,5098
+fuzzytool/type2/reduction.py,sha256=kKzBcq-8Ob-oOzX3c_OL4Kzh-FNSxf8RtBYmN28xotw,3046
+fuzzytool/type2/sets.py,sha256=dekOs6SCExHKD9xcDE8FmHFbkB5qmBQqBEHbenwPjbE,3558
+fuzzytool-0.1.0.dist-info/METADATA,sha256=EAlXtENPTHsBI1w1pwCIpTgqhloIQwjeuClgmv4vvTg,5156
+fuzzytool-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+fuzzytool-0.1.0.dist-info/licenses/LICENSE,sha256=ZZJGlkdgWur4Vvv8cAZI_xYZKnOB9rI2jV5nkNJXn7w,1073
+fuzzytool-0.1.0.dist-info/RECORD,,

fuzzytool-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

fuzzytool-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jose L. Salmeron
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.