fp-persistence-audit 0.1.2__tar.gz

fp_persistence_audit-0.1.2/CITATION.cff

@@ -0,0 +1,11 @@
+cff-version: 1.2.0
+message: "If you use fp-persistence-audit in research, please cite this software."
+title: fp-persistence-audit
+type: software
+authors:
+  - family-names: Zhang
+    given-names: Tongchen
+    orcid: https://orcid.org/0009-0003-9076-0678
+version: 0.1.2
+license: Apache-2.0
+repository-code: https://github.com/tzhangaca/fp-persistence-audit

fp_persistence_audit-0.1.2/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.

fp_persistence_audit-0.1.2/MANIFEST.in

@@ -0,0 +1,3 @@
+include CITATION.cff
+include PROVENANCE.md
+recursive-include examples *.py

fp_persistence_audit-0.1.2/PKG-INFO

@@ -0,0 +1,450 @@
+Metadata-Version: 2.4
+Name: fp-persistence-audit
+Version: 0.1.2
+Summary: A model-agnostic audit of repeated false-positive concentration
+Author: Tongchen Zhang
+License:                                  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.
+        
+Project-URL: Homepage, https://github.com/tzhangaca/fp-persistence-audit
+Project-URL: Repository, https://github.com/tzhangaca/fp-persistence-audit
+Project-URL: Issues, https://github.com/tzhangaca/fp-persistence-audit/issues
+Requires-Python: <3.14,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<2.3,>=2.2
+Requires-Dist: pandas<2.4,>=2.3
+Provides-Extra: test
+Requires-Dist: pytest>=7.4; extra == "test"
+Requires-Dist: python-dateutil>=2.8.2; extra == "test"
+Requires-Dist: pytz>=2024.1; extra == "test"
+Dynamic: license-file
+
+# fp-persistence-audit
+
+[![DOI](https://zenodo.org/badge/1413689835.svg)](https://doi.org/10.5281/zenodo.23288628)
+
+`fp-persistence-audit` audits whether false-positive decisions repeatedly concentrate on the same entities beyond a fixed-count, context-conditioned reference.
+
+Two fraud systems may have the same total false-positive rate while one repeatedly false-positives the same legitimate entities. This package measures that repeated entity-level concentration relative to a fixed-count, context-conditioned reference.
+
+`entity` is the repeated unit being audited, such as a customer, account, card, or payment instrument.
+
+It is a retrospective, model-agnostic auditing tool. It accepts either externally supplied binary false-positive flags or externally generated scores converted to an explicit exact number of flags. It is not a fraud model.
+
+## What it does not do
+
+This package does not:
+
+- train a fraud model or improve detection automatically;
+- choose an optimal production threshold;
+- establish causality;
+- establish fairness or discrimination;
+- prove consumer harm.
+
+## Installation
+
+Install the release from PyPI:
+
+```bash
+python -m pip install fp-persistence-audit
+```
+
+From a local source checkout:
+
+```bash
+python -m pip install .
+```
+
+For development and tests:
+
+```bash
+python -m pip install -e '.[test]'
+```
+
+Python `3.10` through `3.13` is the declared compatibility range.
+
+## Legitimate audit population
+
+> **Important:** If `legitimate_col` is omitted, every input row is treated as legitimate. For datasets that contain fraudulent or otherwise positive events, users should normally provide a strict binary legitimate indicator or pre-filter the data to legitimate audit events. The package does not infer ground truth, and a false-positive flag is meaningful only on the legitimate audit population.
+
+## Five-minute quick start
+
+Each row is an event. The two scenarios below use the same 12 legitimate events, four entities, four total false-positive flags, and two flags inside each final context stratum. Only the entity-level concentration of those flags changes.
+
+`final_stratum` is a caller-supplied, prespecified resolved context bucket. The generic package does not construct the Persistence paper's context hierarchy.
+
+```python
+import json
+
+import pandas as pd
+
+from fp_persistence import ExposureSpec, PermutationSpec, audit
+
+events = pd.DataFrame(
+    {
+        "event_id": [f"e{i:02d}" for i in range(12)],
+        "entity_id": ["A"] * 3 + ["B"] * 3 + ["C"] * 3 + ["D"] * 3,
+        "legitimate": [1] * 12,
+        "final_stratum": ["day-1"] * 6 + ["day-2"] * 6,
+    }
+)
+
+flags_dispersed = [
+    1, 0, 0,  # A
+    1, 0, 0,  # B
+    1, 0, 0,  # C
+    1, 0, 0,  # D
+]
+flags_concentrated = [
+    1, 1, 0,  # A
+    0, 0, 0,  # B
+    1, 1, 0,  # C
+    0, 0, 0,  # D
+]
+
+summaries = {}
+for scenario, flags in {
+    "dispersed": flags_dispersed,
+    "concentrated": flags_concentrated,
+}.items():
+    scenario_events = events.assign(fp_flag=flags)
+    result = audit(
+        scenario_events,
+        entity_col="entity_id",
+        event_id_col="event_id",
+        final_stratum_col="final_stratum",
+        legitimate_col="legitimate",
+        flag_col="fp_flag",
+        exposure=ExposureSpec(3, 3),
+        permutation=PermutationSpec(500, 2026091601),
+        metadata={
+            "entity_semantics": "payment instrument",
+            "context_definition": "prespecified example strata",
+        },
+    )
+    summaries[scenario] = {
+        "total_false_positive_flags": int(scenario_events["fp_flag"].sum()),
+        "flags_by_final_stratum": {
+            str(stratum): int(count)
+            for stratum, count in scenario_events.groupby(
+                "final_stratum", sort=True
+            )["fp_flag"].sum().items()
+        },
+        "eligible_entity_count": result.population.eligible_entity_count,
+        "observed_persistence": result.estimates.observed_repeat_fp_proportion,
+        "reference_expectation": result.estimates.reference_expected_repeat_fp_proportion,
+        "excess_persistence_percentage_points": result.estimates.excess_repeat_fp_percentage_points,
+    }
+
+print(json.dumps(summaries, indent=2, sort_keys=True))
+```
+
+With the documented seed and settings, this produces:
+
+```json
+{
+  "concentrated": {
+    "eligible_entity_count": 4,
+    "excess_persistence_percentage_points": 31.0,
+    "flags_by_final_stratum": {"day-1": 2, "day-2": 2},
+    "observed_persistence": 0.5,
+    "reference_expectation": 0.19,
+    "total_false_positive_flags": 4
+  },
+  "dispersed": {
+    "eligible_entity_count": 4,
+    "excess_persistence_percentage_points": -19.0,
+    "flags_by_final_stratum": {"day-1": 2, "day-2": 2},
+    "observed_persistence": 0.0,
+    "reference_expectation": 0.19,
+    "total_false_positive_flags": 4
+  }
+}
+```
+
+The dispersed scenario gives each entity one flag, so no entity has a repeated false positive. The concentrated scenario places repeated flags on A and C, producing observed persistence of `0.5`. Because both scenarios retain four total flags and exactly two flags in both `day-1` and `day-2`, the contrast illustrates the mechanics of entity-level concentration rather than a change in overall flag burden or context-level flag counts.
+
+The exact conditional reference expectation for this toy fixture is `0.20`; the displayed `0.19` is the documented 500-replicate Monte Carlo estimate. The documented run's conditional reference interval is `[0, 0.5]`. This toy example is pedagogical and is not evidence of statistical significance.
+
+Entity semantics and context definitions materially affect interpretation and should always be documented.
+
+## Score-based usage
+
+Scores must be generated outside this package. The caller supplies the exact selection count:
+
+```python
+from fp_persistence import audit, flags_from_scores
+
+selection = flags_from_scores(
+    events.assign(score=[0.99, 0.95, 0.40, 0.90, 0.30, 0.20, 0.15, 0.10, 0.08, 0.05, 0.03, 0.01]),
+    score_col="score",
+    event_id_col="event_id",
+    legitimate_col="legitimate",
+    n_select=3,
+)
+
+result = audit(
+    events,
+    entity_col="entity_id",
+    event_id_col="event_id",
+    final_stratum_col="final_stratum",
+    legitimate_col="legitimate",
+    flag_selection=selection,
+    exposure=ExposureSpec(3, 3),
+    permutation=PermutationSpec(500, 2026091601),
+)
+```
+
+`n_select` is always explicit and is the exact number selected among the legitimate rows passed to `flags_from_scores()`. It is not automatically the production system's total alert count or alert rate. The helper never infers an alert fraction or threshold and does not automatically impose the Persistence paper's 2% operating point. To reproduce actual system alerts or declines across all transactions, generate those system decision flags upstream and audit them with `flag_col`.
+
+## Choosing final context strata
+
+`final_stratum` should be a prespecified context bucket whose event-level conditions should be held fixed by the reference procedure. A good example is calendar period crossed with coarse amount bands, channel, region, or other prespecified event-level context variables. Entity ID itself—or customer ID, card ID, or another almost-unique bucket tied to the entity—is a bad final stratum because it conditions away the entity-level concentration being audited.
+
+Overly fine strata can mechanically constrain the fixed-count permutation reference and suppress apparent excess persistence. Define and document the context specification before interpreting the audit.
+
+## Interpreting the output
+
+- **Observed persistence** is the proportion of exposure-eligible entities with at least two false-positive events.
+- **Reference expectation** is the mean persistence after repeatedly permuting the fixed realized flag count within each supplied final context stratum.
+- **Excess persistence** is observed persistence minus the reference expectation, reported in percentage points.
+- **Observed/expected ratio** compares observed persistence with the reference expectation when that ratio is defined.
+- **Reference interval** is the configured quantile interval of the conditional permutation reference distribution.
+- **Eligible entity count** is the denominator defined by the supplied legitimate-exposure bounds.
+- **Context diagnostics** report the final-stratum count and lossless stratum-size structure used by the reference procedure.
+
+> **Excess persistence is conditional on the supplied entity definition and context stratification. Report and interpret it together with those definitions and structural diagnostics.**
+
+Report observed persistence, reference expectation, excess persistence in percentage points, the observed/expected ratio when defined, and the reference interval together with the entity definition, exposure bounds, and final-stratum definition. The reference interval is a conditional reference-distribution interval—not a confidence interval for excess persistence and not a p-value. Excess persistence in percentage points can also depend on the underlying false-positive operating point or base rate, so comparisons across very different operating points should be made cautiously.
+
+An estimable zero is a completed audit whose defined persistence value is zero. `NOT_ESTIMABLE` instead means the completed, well-formed audit had zero exposure-eligible entities, so the scientific estimand is undefined. Validation failures and interrupted executions produce no completed result.
+
+## Supported input domain
+
+The public API deliberately supports a finite, deterministic input domain; arbitrary hashable Python objects are not accepted. Event IDs and entity IDs may be `str`, non-Boolean `int`, `bytes`, `UUID`, `date`, timezone-naive `datetime`/`pandas.Timestamp`, UTC or `datetime.timezone` fixed-offset `datetime`/`pandas.Timestamp`, finite `float`, finite `Decimal`, losslessly normalized NumPy scalar equivalents, or recursively valid tuples made only from those types. Dynamic timezone-rule values (including `zoneinfo`, pytz regional zones, dateutil regional zones, and custom `tzinfo` implementations) are intentionally unsupported in v0.1.2; normalize them to UTC, a `datetime.timezone` fixed offset, or a stable string before calling the audit. Values within each event-ID or entity-ID column must use one consistent representation. Event IDs must also be nonmissing, unique, and totally ordered; dataframe index and incoming row order are never identifiers or tie breakers.
+
+Final-stratum labels use the same supported value types and datetime timezone restriction, but may mix supported representations when their equality is deterministic; equality-equivalent numeric or supported datetime labels form one stratum. Unsupported containers (`list`, `dict`, `set`, `frozenset`), nonfinite numbers, Booleans used as identifiers, dynamic/custom timezone values, and arbitrary custom objects are rejected with `AuditValidationError`.
+
+Scores may be finite Python or NumPy integers/floats, or finite `Decimal` values. They are ranked without lossy float coercion, and mixed numeric ordering is independent of the caller's mutable `Decimal` precision and `FloatOperation` trap settings. Complex values, Booleans, nonfinite values, strings, and custom numeric-like objects are rejected. Flag and legitimate-indicator columns accept only Python/NumPy Booleans or integer `0`/`1`; generic truthiness and floating `0.0`/`1.0` are not accepted.
+
+## Reproducibility
+
+The public API requires deterministic event IDs and an explicit random seed. Permutations use canonical event ordering, so dataframe row order alone cannot change scientific outputs. The implementation is covered by synthetic tests, dataframe row-shuffle invariance tests, and an exact known-answer regression fixture.
+
+From a source checkout, run the public known-answer regression directly with:
+
+```bash
+pytest tests/test_known_answer_reference.py -v
+```
+
+No claim of external adoption or independent validation is made.
+
+## Citation
+
+Use the repository's `CITATION.cff` metadata when citing this software. The DOI badge at the top of this README links to the archived software/version series.
+
+## Version status
+
+Version `0.1.2` is the current generic audit release. Paper-reproduction and RQ2 workflows are not part of this release.
+
+The archived v0.1.0 release is available at [https://doi.org/10.5281/zenodo.23288629](https://doi.org/10.5281/zenodo.23288629).