ruleminer
Python package to discover association rules in Pandas DataFrames.
This package implements the code of the paper Discovering and ranking validation rules in supervisory data.
-
Free software: MIT/X license
-
Documentation: https://ruleminer.readthedocs.io/en/latest.
Features
Here is what the package does:
-
Generate human-readable validation rules using rule templates containing regular expressions and a Pandas DataFrame dataset
- available functions: min, max, abs, quantile, sum, substr, split, count, sumif and countif
- including parameters for metric filters and rule precisions (including XBRL tolerances)
-
Evaluate rules and calculate association rules metrics
- available metrics: abs support, abs exceptions, confidence, support, added value, casual confidence, casual support, conviction, lift and rule power factor
Here are some examples of rule templates with regexes with which you can generate validation rules:
-
if ({"Type"} == ".") then ({"."} > 0)
-
if ({"."} > 0) then (({"."} == 0) & ({"."} > 0))*
-
(({"."} + {"."} + {"."}) == {"."})
-
({"Own funds"} <= quantile({"Own funds"}, 0.95))
-
(substr({"Type"}, 0, 1) in ["a", "b"])
The first template generates (with the dataset described in the Usage section) rules like
- if ({"Type"} == "non-life_insurer") then ({"TP-nonlife"} > 0)
- if ({"Type"} == "life_insurer") then ({"TP-life"} > 0)
These generated validation rules can then be used to validate new datasets.
Contributors
- Willem Jan Willemse https://github.com/wjwillemse
1 maintainer
Metadata
1 maintainer
Release files for ruleminer 1.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| ruleminer-1.0.3.tar.gz | 36.2 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ruleminer-1.0.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 75.7 kB
Release files / ruleminer-1.0.3.tar.gz
| Download URL | ruleminer-1.0.3.tar.gz |
|---|---|
| Size | 36.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c6b64e1a8b8817117b6f936e372e889037bb0cd228121d3c7d0aebc2714e1187
|
|
BLAKE2b-256 checksum How to use checksums |
889434e78814fb18bacfa6a6c238dd3b94563b8531e99f8be405b5e2d7401f4b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
Release files / ruleminer-1.0.3-py3-none-any.whl
| Download URL | ruleminer-1.0.3-py3-none-any.whl |
|---|---|
| Size | 39.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
87cba897abebd22a17f1c7c705e431da8688478046ba29185052e31dbbb61e6c
|
|
BLAKE2b-256 checksum How to use checksums |
1e21d87bc5a9c52c73c3373ad80fd87ec2f61d87b5e9e6ead853c97866c5b961
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.3
|
Security for ruleminer 1.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
