rulelearn-ripper-interactive 0.2.3__tar.gz

rulelearn_ripper_interactive-0.2.3/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

rulelearn_ripper_interactive-0.2.3/NOTICE

@@ -0,0 +1,11 @@
+rulelearn-ripper-interactive
+Copyright 2026 Aaron Kurz, Hagen Voelzer
+
+This product is derived from rulelearn (https://github.com/IBM/rulelearn),
+originally released as part of AI Explainability 360
+(https://github.com/Trusted-AI/AIX360), Copyright IBM Corporation,
+licensed under the Apache License, Version 2.0.
+
+Modifications in this fork include constrained single-rule RIPPER optimization
+(optimize_single_rule), pandas 3 compatibility, and renaming of the import
+package to rulelearn_ri.

rulelearn_ripper_interactive-0.2.3/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.4
+Name: rulelearn-ripper-interactive
+Version: 0.2.3
+Summary: Rule induction toolkit (fork of IBM rulelearn) with interactive, constrained single-rule RIPPER optimization
+Author-email: Aaron Kurz <aaron.kurz@unisg.ch>, Hagen Voelzer <hagen.voelzer@unisg.ch>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/aaronkurz/rulelearn-ripper-interactive
+Project-URL: Upstream, https://github.com/IBM/rulelearn
+Keywords: rule induction,ripper,interpretable machine learning,explainability,rule learning
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: scikit-learn
+Requires-Dist: numba
+Requires-Dist: nyoka==5.4.0
+Provides-Extra: rbm
+Requires-Dist: cvxpy; extra == "rbm"
+Requires-Dist: ecos; extra == "rbm"
+Requires-Dist: matplotlib; extra == "rbm"
+Provides-Extra: r2n
+Requires-Dist: torch; extra == "r2n"
+Provides-Extra: all
+Requires-Dist: rulelearn-ripper-interactive[r2n,rbm]; extra == "all"
+Dynamic: license-file
+
+# rulelearn-ripper-interactive
+
+A rule induction toolkit for learning readable, editable rules from data. It is a fork of
+[IBM's rulelearn](https://github.com/IBM/rulelearn) that adds **interactive, constrained
+single-rule optimization** for RIPPER. You can grow and prune a single conjunctive rule
+while forcing some features or predicates into it and keeping others out.
+
+The package installs as `rulelearn_ri`, so it can be installed side by side with the
+upstream `rulelearn` package.
+
+## Installation
+
+```bash
+pip install rulelearn-ripper-interactive
+```
+
+or, to add it to a [uv](https://docs.astral.sh/uv/) project:
+
+```bash
+uv add rulelearn-ripper-interactive
+```
+
+The core install covers RIPPER and TRXF (rule interchange, metrics and PMML export).
+The other algorithms need heavier dependencies, available as extras:
+
+```bash
+pip install "rulelearn-ripper-interactive[rbm]"   # BRCG / GLRM (cvxpy, ecos, matplotlib)
+pip install "rulelearn-ripper-interactive[r2n]"   # Relational Rule Network (torch)
+pip install "rulelearn-ripper-interactive[all]"   # everything
+```
+
+With uv, use `uv add "rulelearn-ripper-interactive[rbm]"` (or `[r2n]`, `[all]`) instead.
+
+Requires Python 3.10 or newer.
+
+## Single-rule optimization
+
+`optimize_single_rule` learns one conjunctive rule for a target label and returns it as a
+TRXF `Conjunction`:
+
+```python
+import pandas as pd
+from rulelearn_ri.algorithms.ripper import optimize_single_rule
+
+df = pd.DataFrame({
+    'x': [1.0, 2.0, 3.0, 4.0],
+    'target': ['True', 'True', 'False', 'False'],
+})
+X, y = df.drop(columns='target'), df['target']
+
+rule = optimize_single_rule(X, y, target_label='True')
+print(rule)
+```
+
+Constraints let you steer the rule:
+
+```python
+from rulelearn_ri.trxf.core import Feature, Predicate, Relation
+
+# Force the feature `x` to appear in the rule (the boundary is still optimized)
+optimize_single_rule(X, y, target_label='True', fixed_attributes=['x'])
+
+# Force a specific predicate, with a fixed boundary, into the rule
+optimize_single_rule(
+    X, y, target_label='True',
+    fixed_predicates=[Predicate(Feature('x'), Relation.LE, 2.5)],
+)
+
+# Keep a feature out of the rule (must not clash with any forced feature or predicate)
+optimize_single_rule(X, y, target_label='True', forbidden_attributes=['x'])
+```
+
+Further options: `pruning_threshold` (minimum number of instances for the grow/prune
+split, default 20), `random_state` (seed for the split, default 0) and `ratio`
+(fraction of the data used for growing, default 2/3).
+
+## Included algorithms
+
+- Fast Effective Rule Induction (RIPPER) ([William W Cohen, 1995](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.107.2612&rep=rep1&type=pdf)),
+  including the full rule-set learner `RipperExplainer`
+- Boolean Decision Rules via Column Generation (Light Edition) ([Dash et al., 2018](https://papers.nips.cc/paper/7716-boolean-decision-rules-via-column-generation)), extra `rbm`
+- Generalized Linear Rule Models ([Wei et al., 2019](http://proceedings.mlr.press/v97/wei19a.html)), extra `rbm`
+- Relational Rule Network (R2N) ([Kusters et al., 2022](https://arxiv.org/abs/2201.06515)), extra `r2n`
+- TRXF (Technical Rule Interchange Format): a common rule-set representation with evaluation tools
+  and PMML export
+
+Example notebooks are in the [`examples/`](https://github.com/aaronkurz/rulelearn-ripper-interactive/tree/main/examples) directory of the repository.
+
+## Development
+
+This project uses [uv](https://docs.astral.sh/uv/):
+
+```bash
+git clone git@github.com:aaronkurz/rulelearn-ripper-interactive.git
+cd rulelearn-ripper-interactive
+uv sync --all-extras
+uv run pytest
+```
+
+### Releasing
+
+1. Bump `version` in `pyproject.toml`.
+2. Build and check the distributions:
+   ```bash
+   rm -rf dist && uv build
+   uvx twine check --strict dist/*
+   ```
+3. Upload to TestPyPI first, then check it installs in a clean environment:
+   ```bash
+   uv publish --publish-url https://test.pypi.org/legacy/ --token <testpypi-token>
+   ```
+4. Upload to PyPI and tag the release:
+   ```bash
+   uv publish --token <pypi-token>
+   git tag v<version> && git push origin v<version>
+   ```
+
+## Acknowledgements
+
+This package is derived from [rulelearn](https://github.com/IBM/rulelearn) by IBM,
+originally released as part of [AI Explainability 360](https://github.com/Trusted-AI/AIX360).
+See [NOTICE](https://github.com/aaronkurz/rulelearn-ripper-interactive/blob/main/NOTICE) for details.
+
+## License
+
+Apache License 2.0. See [LICENSE](https://github.com/aaronkurz/rulelearn-ripper-interactive/blob/main/LICENSE).

rulelearn_ripper_interactive-0.2.3/README.md

@@ -0,0 +1,126 @@
+# rulelearn-ripper-interactive
+
+A rule induction toolkit for learning readable, editable rules from data. It is a fork of
+[IBM's rulelearn](https://github.com/IBM/rulelearn) that adds **interactive, constrained
+single-rule optimization** for RIPPER. You can grow and prune a single conjunctive rule
+while forcing some features or predicates into it and keeping others out.
+
+The package installs as `rulelearn_ri`, so it can be installed side by side with the
+upstream `rulelearn` package.
+
+## Installation
+
+```bash
+pip install rulelearn-ripper-interactive
+```
+
+or, to add it to a [uv](https://docs.astral.sh/uv/) project:
+
+```bash
+uv add rulelearn-ripper-interactive
+```
+
+The core install covers RIPPER and TRXF (rule interchange, metrics and PMML export).
+The other algorithms need heavier dependencies, available as extras:
+
+```bash
+pip install "rulelearn-ripper-interactive[rbm]"   # BRCG / GLRM (cvxpy, ecos, matplotlib)
+pip install "rulelearn-ripper-interactive[r2n]"   # Relational Rule Network (torch)
+pip install "rulelearn-ripper-interactive[all]"   # everything
+```
+
+With uv, use `uv add "rulelearn-ripper-interactive[rbm]"` (or `[r2n]`, `[all]`) instead.
+
+Requires Python 3.10 or newer.
+
+## Single-rule optimization
+
+`optimize_single_rule` learns one conjunctive rule for a target label and returns it as a
+TRXF `Conjunction`:
+
+```python
+import pandas as pd
+from rulelearn_ri.algorithms.ripper import optimize_single_rule
+
+df = pd.DataFrame({
+    'x': [1.0, 2.0, 3.0, 4.0],
+    'target': ['True', 'True', 'False', 'False'],
+})
+X, y = df.drop(columns='target'), df['target']
+
+rule = optimize_single_rule(X, y, target_label='True')
+print(rule)
+```
+
+Constraints let you steer the rule:
+
+```python
+from rulelearn_ri.trxf.core import Feature, Predicate, Relation
+
+# Force the feature `x` to appear in the rule (the boundary is still optimized)
+optimize_single_rule(X, y, target_label='True', fixed_attributes=['x'])
+
+# Force a specific predicate, with a fixed boundary, into the rule
+optimize_single_rule(
+    X, y, target_label='True',
+    fixed_predicates=[Predicate(Feature('x'), Relation.LE, 2.5)],
+)
+
+# Keep a feature out of the rule (must not clash with any forced feature or predicate)
+optimize_single_rule(X, y, target_label='True', forbidden_attributes=['x'])
+```
+
+Further options: `pruning_threshold` (minimum number of instances for the grow/prune
+split, default 20), `random_state` (seed for the split, default 0) and `ratio`
+(fraction of the data used for growing, default 2/3).
+
+## Included algorithms
+
+- Fast Effective Rule Induction (RIPPER) ([William W Cohen, 1995](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.107.2612&rep=rep1&type=pdf)),
+  including the full rule-set learner `RipperExplainer`
+- Boolean Decision Rules via Column Generation (Light Edition) ([Dash et al., 2018](https://papers.nips.cc/paper/7716-boolean-decision-rules-via-column-generation)), extra `rbm`
+- Generalized Linear Rule Models ([Wei et al., 2019](http://proceedings.mlr.press/v97/wei19a.html)), extra `rbm`
+- Relational Rule Network (R2N) ([Kusters et al., 2022](https://arxiv.org/abs/2201.06515)), extra `r2n`
+- TRXF (Technical Rule Interchange Format): a common rule-set representation with evaluation tools
+  and PMML export
+
+Example notebooks are in the [`examples/`](https://github.com/aaronkurz/rulelearn-ripper-interactive/tree/main/examples) directory of the repository.
+
+## Development
+
+This project uses [uv](https://docs.astral.sh/uv/):
+
+```bash
+git clone git@github.com:aaronkurz/rulelearn-ripper-interactive.git
+cd rulelearn-ripper-interactive
+uv sync --all-extras
+uv run pytest
+```
+
+### Releasing
+
+1. Bump `version` in `pyproject.toml`.
+2. Build and check the distributions:
+   ```bash
+   rm -rf dist && uv build
+   uvx twine check --strict dist/*
+   ```
+3. Upload to TestPyPI first, then check it installs in a clean environment:
+   ```bash
+   uv publish --publish-url https://test.pypi.org/legacy/ --token <testpypi-token>
+   ```
+4. Upload to PyPI and tag the release:
+   ```bash
+   uv publish --token <pypi-token>
+   git tag v<version> && git push origin v<version>
+   ```
+
+## Acknowledgements
+
+This package is derived from [rulelearn](https://github.com/IBM/rulelearn) by IBM,
+originally released as part of [AI Explainability 360](https://github.com/Trusted-AI/AIX360).
+See [NOTICE](https://github.com/aaronkurz/rulelearn-ripper-interactive/blob/main/NOTICE) for details.
+
+## License
+
+Apache License 2.0. See [LICENSE](https://github.com/aaronkurz/rulelearn-ripper-interactive/blob/main/LICENSE).

rulelearn_ripper_interactive-0.2.3/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rulelearn-ripper-interactive"
+version = "0.2.3"
+description = "Rule induction toolkit (fork of IBM rulelearn) with interactive, constrained single-rule RIPPER optimization"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+authors = [
+    { name = "Aaron Kurz", email = "aaron.kurz@unisg.ch" },
+    { name = "Hagen Voelzer", email = "hagen.voelzer@unisg.ch" },
+]
+keywords = ["rule induction", "ripper", "interpretable machine learning", "explainability", "rule learning"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+dependencies = [
+    "numpy",
+    "pandas",
+    "scikit-learn",
+    "numba",
+    "nyoka==5.4.0",
+]
+
+[project.optional-dependencies]
+rbm = ["cvxpy", "ecos", "matplotlib"]
+r2n = ["torch"]
+all = ["rulelearn-ripper-interactive[rbm,r2n]"]
+
+[project.urls]
+Repository = "https://github.com/aaronkurz/rulelearn-ripper-interactive"
+Upstream = "https://github.com/IBM/rulelearn"
+
+[dependency-groups]
+dev = ["pytest", "xmltodict"]
+
+[tool.setuptools.packages.find]
+include = ["rulelearn_ri*"]

rulelearn_ripper_interactive-0.2.3/rulelearn_ri/__init__.py

@@ -0,0 +1,6 @@
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("rulelearn-ripper-interactive")
+except PackageNotFoundError:
+    pass

rulelearn_ripper_interactive-0.2.3/rulelearn_ri/algorithms/r2n/base.py

@@ -0,0 +1,28 @@
+from abc import ABC, abstractmethod
+
+from torch import nn
+
+
+class RuleNetwork(nn.Module, ABC):
+    """
+    Encapsulates a neural network that corresponds syntactically to some ruleset.
+    """
+
+    @abstractmethod
+    def extract_ruleset(self):
+        """ Extract a symbolic representation of the learned ruleset. The semantics of the ruleset must be provided
+        externally.
+
+        :return: A 2D list representing a ruleset in Disjunctive Normal Form. An inner list takes values from {-1, 0, 1}
+         representing a single rule, indicating the inclusion of the negated condition, exclusion,
+         and inclusion of the condition, respectively.
+         E.g. [[1, 0, 0, -1], [0, 1, 0, 0]] represents the ruleset
+         "(condition0 ^ not condition3) v condition1" for a rule network with 4 input conditions.
+        """
+        raise NotImplementedError
+
+
+class PredicateLearningLayer(nn.Module, ABC):
+    @abstractmethod
+    def get_predicates(self, *args, **kwargs):
+        raise NotImplementedError

rulelearn_ripper_interactive-0.2.3/rulelearn_ri/algorithms/r2n/functions.py

@@ -0,0 +1,25 @@
+import torch
+
+
+class DifferentiableHeaviside(torch.autograd.Function):
+    @staticmethod
+    def forward(ctx, input):
+        ctx.save_for_backward(input)
+        return torch.heaviside(input, torch.ones_like(input))
+
+    @staticmethod
+    def backward(ctx, grad_output):
+        input, = ctx.saved_tensors
+        return grad_output * torch.sigmoid(input) * (1 - torch.sigmoid(input))
+
+
+class DifferentiableClamp(torch.autograd.Function):
+    @staticmethod
+    def forward(ctx, input):
+        ctx.save_for_backward(input)
+        return torch.clamp(input, max=1)
+
+    @staticmethod
+    def backward(ctx, grad_output):
+        input, = ctx.saved_tensors
+        return grad_output

rulelearn_ripper_interactive-0.2.3/rulelearn_ri/algorithms/r2n/mask.py

@@ -0,0 +1,58 @@
+from abc import ABC, abstractmethod
+
+import torch
+from torch import nn
+
+from rulelearn_ri.algorithms.r2n.functions import DifferentiableHeaviside
+
+
+class WeightMask(nn.Module, ABC):
+    """
+    Abstract class for the mask that is applied to the weight matrix of the NN. 
+    """
+
+    def __init__(self, dim_out, dim_in):
+        super(WeightMask, self).__init__()
+        self.dim_out = dim_out
+        self.dim_in = dim_in
+        self.loc = torch.nn.Parameter(torch.randn(self.dim_out, self.dim_in), requires_grad=True)
+
+    @abstractmethod
+    def forward(self):
+        pass
+
+
+class SimpleWeightMask(WeightMask):
+    """
+    Binary weight mask that is used in the AND/OR layer. Note that depening of the Boolean value cooling, we either implement a cooled sigmoid or stricly binary differentiable heavyside function. 
+    """
+
+    def __init__(self, dim_out, dim_in, temp, cooling):
+        super(SimpleWeightMask, self).__init__(dim_out, dim_in)
+        self.cooling = cooling
+        self.temp = temp
+
+    def forward(self):
+        if self.cooling is True:
+            return torch.sigmoid((1 / self.temp) * self.loc)
+        else:
+            return DifferentiableHeaviside.apply(self.loc)
+
+    def set_temp(self, temp):
+        self.temp = temp
+
+    def get_temp(self):
+        return self.temp
+
+
+class DeterministicWeightMask(WeightMask):
+    """
+    Simple deterministic weight mask. 
+    """
+
+    def __init__(self, mask):
+        super(DeterministicWeightMask, self).__init__(mask.size()[0], mask.size()[1])
+        self.mask = mask
+
+    def forward(self):
+        return self.mask