thisness 0.1.0__tar.gz

thisness-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+env:
+  # Resolution must not depend on set or dict iteration order. A fixed seed makes
+  # any accidental dependence fail the same way every run instead of flaking.
+  PYTHONHASHSEED: "0"
+
+jobs:
+  lint:
+    name: Lint and format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - run: uv sync --dev
+      # Both, always: they catch different things.
+      - run: uv run ruff check .
+      - run: uv run ruff format --check .
+
+  test:
+    name: Tests (Python ${{ matrix.python }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          python-version: ${{ matrix.python }}
+      - run: uv sync --dev
+      - run: uv run pytest --cov --cov-report=term-missing

thisness-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,53 @@
+name: Publish
+
+# A version tag publishes to PyPI (tag-push, not a GitHub Release):
+#   git tag v0.1.0 && git push origin v0.1.0
+# Bump `version` in pyproject.toml and add a CHANGELOG.md entry first; the tag must match.
+#
+# One-time setup on pypi.org: add a trusted publisher for mfbaig35r/thisness, workflow
+# publish.yml, environment pypi. No API token is stored anywhere.
+on:
+  push:
+    tags: ["v*"]
+
+env:
+  PYTHONHASHSEED: "0"
+
+jobs:
+  build:
+    name: Test and build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+      - run: uv sync --dev
+      - run: uv run ruff check .
+      - run: uv run ruff format --check .
+      - run: uv run pytest
+      - name: The tag matches the version
+        run: |
+          version=$(uv run python -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+          test "v$version" = "$GITHUB_REF_NAME" || { echo "::error::tag $GITHUB_REF_NAME, pyproject $version"; exit 1; }
+      - run: uv build
+      - name: Metadata and README render for PyPI
+        run: uvx twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # trusted publishing (OIDC)
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

thisness-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+.DS_Store
+__pycache__/
+*.pyc
+.ruff_cache/
+.venv/
+.coverage
+htmlcov/
+.pytest_cache/
+dist/
+*.egg-info/
+
+# Private reference material (book chapters, drafts): kept locally, never committed.
+docs/reference/

thisness-0.1.0/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 0.1.0 (2026-10-10)
+
+The first release.
+
+- **Core** (design 01 to 03). Observations, stable entities, and a ledger of reversible merges and splits in DuckDB. Candidate generation by blocking keys, typed comparisons, Fellegi-Sunter weights fitted by EM with term-frequency adjustments, and validated-components consensus that commits only what the evidence supports and opens a review for the rest. Every decision is stored with its evidence and can be explained.
+- **Review and the Workbench** (design 04). Pair constraints, a review queue ranked by impact, dossiers, relationship candidates (a shared brand, a household), and a local web Workbench to browse entities, answer reviews by dragging records, relate or merge entities, and page through possible relationships.
+- **Three domains.** Organizations, people, and taxa (scientific plant names, with World Flora Online and the Catalogue of Life as authorities; design 06). Each ships a starter model for stores too small to fit their own.
+- **The language-model layer** (design 05). Anthropic and OpenAI-compatible providers, budgets, retries on transient errors, record and replay. An adjudicator for contested pairs (shadow or decide; a model's "same" yields to its own "different" and to cannot-link constraints), a review assistant that suggests answers, name-only resolution, and a per-profile `model_role`.
+- **Benchmarks.** Synthetic organizations and people, WFO plant names, and real UK companies from GLEIF and Companies House with company numbers as truth (design 07). `thisness eval` reports precision, recall, false-merge clusters, and a model's accuracy against the truth.
+- **Scale.** Tested to 46,565 real records: bounded boundary reviews and relationship neighborhoods, a paginated relationships page, penalty-only common-value adjustments for shared addresses.

thisness-0.1.0/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 2026 Fahad Baig
+
+   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.

thisness-0.1.0/PKG-INFO

@@ -0,0 +1,183 @@
+Metadata-Version: 2.5
+Name: thisness
+Version: 0.1.0
+Summary: Identity resolution for imperfect observations: evidence, stable identities, reversible history.
+Project-URL: Homepage, https://thisness.dev
+Project-URL: Repository, https://github.com/mfbaig35r/thisness
+Author: Fahad Baig
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: deduplication,entity resolution,identity resolution,record linkage
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: duckdb>=1.3
+Requires-Dist: pyarrow>=17
+Requires-Dist: pydantic>=2.9
+Requires-Dist: rapidfuzz>=3.9
+Provides-Extra: anthropic
+Requires-Dist: anthropic>=0.40; extra == 'anthropic'
+Provides-Extra: openai
+Requires-Dist: httpx>=0.27; extra == 'openai'
+Provides-Extra: ui
+Requires-Dist: fastapi>=0.115; extra == 'ui'
+Requires-Dist: jinja2>=3.1; extra == 'ui'
+Requires-Dist: python-multipart>=0.0.9; extra == 'ui'
+Requires-Dist: uvicorn>=0.30; extra == 'ui'
+Description-Content-Type: text/markdown
+
+# Thisness
+
+**Identity resolution for imperfect observations.**
+
+For centuries, Hesperus (the evening star) and Phosphorus (the morning star) were two things. Then observation showed they were the same planet. Two observations, from different times and contexts, of one underlying thing, and the identity established by evidence rather than by definition.
+
+Thisness does that for data. It takes observations from many sources ("IBM", "IBM Corp.", "International Business Machines Corporation", an invoice line, a contract party) and decides what they refer to, keeping the evidence, the decision, and the history behind every conclusion, so any of them can be explained, reviewed, or reversed.
+
+> Status: alpha. Three domains resolve end to end: organizations, people, and taxa (scientific plant names). Each has a review queue, dossiers, a local Workbench, and an optional language model that adjudicates contested pairs or suggests review answers. The API will change. The design is in [`docs/design/`](docs/design/).
+
+```bash
+pip install 'thisness[ui]'
+```
+
+```python
+import csv
+from thisness import Thisness
+from thisness.profiles.organization import organization
+
+engine = Thisness("identity.duckdb", profiles=[organization()])
+
+# Columns such as name, website, email, registration_ids, country, city, postal_code.
+with open("vendors.csv", newline="") as f:
+    engine.ingest(
+        [
+            engine.observe(
+                "organization", row, {"type": "csv", "id": "vendors.csv", "locator": {"row": i}}
+            )
+            for i, row in enumerate(csv.DictReader(f))
+        ]
+    )
+
+result = engine.resolve_many("organization")  # fits a model on first use, then resolves
+print(result.stats)  # pairs scored, clusters, reviews opened
+
+# Later records resolve against what already exists.
+outcome = engine.resolve(
+    "organization",
+    {"name": "IBM Corp.", "website": "https://www.ibm.com"},
+    {"type": "crm", "id": "account-17"},
+)
+print(outcome.outcome, outcome.entity_id)  # ATTACH_TO_EXISTING / CREATE_ENTITY / REQUIRES_REVIEW
+engine.explain(outcome.decision_id)  # the decision, its evidence, the pairs behind it
+```
+
+A store needs a few hundred records of a type to fit its own model. Below that, Thisness uses a shipped starter model, and replaces it with a fitted one on the first run with enough data.
+
+Every decision is stored with its evidence; merges and splits are reversible ledger events (`engine.merge_entities`, `engine.split_entity`, `engine.history`).
+
+## Domains
+
+A domain is a resolution profile: its attributes, normalizers, comparisons, constraints and the guidance a model is given. Three ship.
+
+- **Organizations** (`thisness.profiles.organization`): names with legal forms, abbreviations, acronyms and group-company qualifiers; websites, emails, registration IDs, addresses. A shared brand or a group's sibling companies are relationship candidates, never merges.
+- **People** (`thisness.profiles.person`): names with nicknames, initials and spelling variants; dates of birth, emails, phones, addresses. Same name at the same address (a household, a parent and child) stays a relationship until evidence says otherwise.
+- **Taxa** (`thisness.profiles.taxon`): scientific names parsed into genus, epithets, rank and authorship. Synonyms join their accepted taxon when an authority such as World Flora Online or the Catalogue of Life is loaded, and every label says which authority supplied it.
+
+## From the command line
+
+```bash
+thisness ingest vendors.csv --resolve   # into identity.duckdb
+thisness ui                              # the Workbench: entities, reviews, history, context
+thisness --store demo.duckdb demo && thisness ui demo.duckdb    # try it on synthetic data
+thisness --store people.duckdb demo --type person                # synthetic people
+thisness --store taxa.duckdb demo --type taxon --reference       # real plant names, labelled by WFO
+```
+
+The Workbench is a local web app over the same API: browse entities with the evidence for every value, answer the review queue by dragging records between entities, relate or merge entities that share a brand, page through possible relationships, and see exactly what a language model was given and what it answered.
+
+## With a language model
+
+A model is optional, and the engine never needs one. Where it helps, it is given the contested pairs or the open reviews, with the evidence for each, and its answers are recorded like any other decision.
+
+```bash
+pip install 'thisness[ui,openai]'   # or [ui,anthropic]; keys from OPENAI_API_KEY / ANTHROPIC_API_KEY
+
+thisness resolve --provider openai --model gpt-6-luna --budget 2   # contested pairs to the model
+thisness recommend --provider openai --model gpt-6-luna --limit 50 # suggested answers for reviews
+thisness ui --provider openai --model gpt-6-luna                   # ask from the Workbench
+```
+
+What the model does is set per profile (`model_role`): for organizations and taxa it decides contested pairs, and its "same" yields to its own "different" or to a cannot-link constraint; for people it only suggests review answers, since measured on people it was both too cautious and too credulous. `--model-role decide|suggest|shadow|off` overrides that for a run. `--record` keeps every exchange in a cassette and `--replay` answers from one, free and offline. Any OpenAI-compatible server works with `--base-url` (and `--local` when it is yours).
+
+Set `--budget`: there is no default limit.
+
+## How well it works
+
+`thisness eval` resolves a benchmark with known truth and reports precision, recall and false-merge clusters. Measured so far (design 07 §13; design 06 §10):
+
+| Benchmark | Records | P | R | False-merge clusters |
+|---|---|---|---|---|
+| Real UK companies (GLEIF + Companies House), identifiers hidden | 3,507 | .9992 | .912 | 1 |
+| The same, gpt-6-luna deciding contested pairs ($0.62) | 3,507 | .9965 | .938 | 5 |
+| Real UK companies, at scale | 46,565 | .9965 | .934 | 63 |
+| Synthetic organizations, 4,000 | | .9995 | .938 | 4 |
+
+```bash
+thisness eval --size 805 4000                     # synthetic organizations (or --type person)
+thisness eval --type taxon --reference            # WFO plant names, with WFO's own rows
+python -m thisness.benchmark uk-stage             # download GLEIF and Companies House (~1 GB, once)
+thisness eval --source uk --size 400              # real UK companies, identifiers hidden
+thisness eval --source uk --adjudicator openai --model gpt-6-luna --mode decide --budget 2
+```
+
+The UK benchmark's hard cases are real: 62% of live UK companies share a registered address, and a record that says only "Sports Direct" sits beside four real Sports Direct companies. The record variations (shortened names, typos, partial addresses) are generated from the true company, so the truth is known.
+
+## Known limits
+
+- **Memory grows with candidate pairs.** 46,565 records took 7.5 minutes of CPU and 7.8 GB peak memory; scoring holds every candidate pair in Python. Tested to about fifty thousand records.
+- **Candidates come from blocking keys.** There is no embedding-based candidate generator yet, so two records that share no blocking key (a renamed company with nothing else in common, a heterotypic synonym with no authority loaded) are never compared directly.
+- **Model costs are real.** About $0.62 for 400 UK companies with gpt-6-luna; the default model is `claude-sonnet-5`. Use `--budget`, and `--replay` to re-run without paying again.
+- **The network benchmarks download data.** WFO families beyond the shipped three, the Catalogue of Life, and the UK sources are fetched on demand and cached under `~/.cache/thisness`. Everything else, including the Workbench, runs offline.
+
+## What it is
+
+- **Observations are not entities.** A source record is an observation of something. Entities are stable identities above them, with IDs that never change when names do.
+- **Similarity is not identity.** Candidate retrieval, evidence, decisions and identity state are separate steps with separate records. Scores are typed; there is no universal `confidence` float.
+- **Identity is not relationship.** "Subsidiary of" and "brand of" are relationships between distinct entities, never merges.
+- **Everything is reversible.** Merges and splits are ledger events over memberships. Nothing is destructively collapsed, and the ledger alone can rebuild current state.
+- **Models propose; policy decides.** Rules, Fellegi-Sunter, LLMs and people all contribute decisions. Only a commit, citing those decisions, changes identity state.
+
+## Documents
+
+- [Vision](docs/vision.md)
+- [Product requirements](docs/prd.md) and [Appendix A: LLM-assisted resolution](docs/prd-appendix-a-llm-resolution.md)
+- [Research: the entity-resolution landscape](docs/research/entity-resolution-landscape.md)
+- Design:
+  - [01 resolution runs and consensus](docs/design/01-resolution-runs.md)
+  - [02 core model and storage](docs/design/02-core-model-and-storage.md)
+  - [03 resolution pipeline](docs/design/03-resolution-pipeline.md)
+  - [04 review, dossier, Workbench, people](docs/design/04-m2-review-dossier-workbench-person.md)
+  - [05 the language-model layer](docs/design/05-m3-llm-layer.md)
+  - [06 taxonomy, the third domain](docs/design/06-m4-taxonomy.md)
+  - [07 real organizations](docs/design/07-m5-real-organizations.md)
+- [Changelog](CHANGELOG.md)
+
+## Development
+
+```bash
+uv sync --dev   # includes the ui extra
+uv run pytest
+uv run ruff check . && uv run ruff format --check .
+```
+
+Releases publish to PyPI from a version tag: bump `version` in `pyproject.toml`, add a `CHANGELOG.md` entry, then `git tag vX.Y.Z && git push origin vX.Y.Z`.
+
+## Data and license
+
+Thisness is Apache-2.0. See [LICENSE](LICENSE).
+
+Bundled and fetched data keep their own terms, credited where they ship: World Flora Online (CC0 1.0) in `benchmark/data`; GLEIF Golden Copy (CC0 1.0) and Companies House data (Open Government Licence v3.0) in `benchmark/data/uk`; the Catalogue of Life (CC BY 4.0), fetched on demand with attribution; and the Workbench's fonts, icons and scripts in `ui/static/THIRD_PARTY.md`.

thisness-0.1.0/README.md

@@ -0,0 +1,151 @@
+# Thisness
+
+**Identity resolution for imperfect observations.**
+
+For centuries, Hesperus (the evening star) and Phosphorus (the morning star) were two things. Then observation showed they were the same planet. Two observations, from different times and contexts, of one underlying thing, and the identity established by evidence rather than by definition.
+
+Thisness does that for data. It takes observations from many sources ("IBM", "IBM Corp.", "International Business Machines Corporation", an invoice line, a contract party) and decides what they refer to, keeping the evidence, the decision, and the history behind every conclusion, so any of them can be explained, reviewed, or reversed.
+
+> Status: alpha. Three domains resolve end to end: organizations, people, and taxa (scientific plant names). Each has a review queue, dossiers, a local Workbench, and an optional language model that adjudicates contested pairs or suggests review answers. The API will change. The design is in [`docs/design/`](docs/design/).
+
+```bash
+pip install 'thisness[ui]'
+```
+
+```python
+import csv
+from thisness import Thisness
+from thisness.profiles.organization import organization
+
+engine = Thisness("identity.duckdb", profiles=[organization()])
+
+# Columns such as name, website, email, registration_ids, country, city, postal_code.
+with open("vendors.csv", newline="") as f:
+    engine.ingest(
+        [
+            engine.observe(
+                "organization", row, {"type": "csv", "id": "vendors.csv", "locator": {"row": i}}
+            )
+            for i, row in enumerate(csv.DictReader(f))
+        ]
+    )
+
+result = engine.resolve_many("organization")  # fits a model on first use, then resolves
+print(result.stats)  # pairs scored, clusters, reviews opened
+
+# Later records resolve against what already exists.
+outcome = engine.resolve(
+    "organization",
+    {"name": "IBM Corp.", "website": "https://www.ibm.com"},
+    {"type": "crm", "id": "account-17"},
+)
+print(outcome.outcome, outcome.entity_id)  # ATTACH_TO_EXISTING / CREATE_ENTITY / REQUIRES_REVIEW
+engine.explain(outcome.decision_id)  # the decision, its evidence, the pairs behind it
+```
+
+A store needs a few hundred records of a type to fit its own model. Below that, Thisness uses a shipped starter model, and replaces it with a fitted one on the first run with enough data.
+
+Every decision is stored with its evidence; merges and splits are reversible ledger events (`engine.merge_entities`, `engine.split_entity`, `engine.history`).
+
+## Domains
+
+A domain is a resolution profile: its attributes, normalizers, comparisons, constraints and the guidance a model is given. Three ship.
+
+- **Organizations** (`thisness.profiles.organization`): names with legal forms, abbreviations, acronyms and group-company qualifiers; websites, emails, registration IDs, addresses. A shared brand or a group's sibling companies are relationship candidates, never merges.
+- **People** (`thisness.profiles.person`): names with nicknames, initials and spelling variants; dates of birth, emails, phones, addresses. Same name at the same address (a household, a parent and child) stays a relationship until evidence says otherwise.
+- **Taxa** (`thisness.profiles.taxon`): scientific names parsed into genus, epithets, rank and authorship. Synonyms join their accepted taxon when an authority such as World Flora Online or the Catalogue of Life is loaded, and every label says which authority supplied it.
+
+## From the command line
+
+```bash
+thisness ingest vendors.csv --resolve   # into identity.duckdb
+thisness ui                              # the Workbench: entities, reviews, history, context
+thisness --store demo.duckdb demo && thisness ui demo.duckdb    # try it on synthetic data
+thisness --store people.duckdb demo --type person                # synthetic people
+thisness --store taxa.duckdb demo --type taxon --reference       # real plant names, labelled by WFO
+```
+
+The Workbench is a local web app over the same API: browse entities with the evidence for every value, answer the review queue by dragging records between entities, relate or merge entities that share a brand, page through possible relationships, and see exactly what a language model was given and what it answered.
+
+## With a language model
+
+A model is optional, and the engine never needs one. Where it helps, it is given the contested pairs or the open reviews, with the evidence for each, and its answers are recorded like any other decision.
+
+```bash
+pip install 'thisness[ui,openai]'   # or [ui,anthropic]; keys from OPENAI_API_KEY / ANTHROPIC_API_KEY
+
+thisness resolve --provider openai --model gpt-6-luna --budget 2   # contested pairs to the model
+thisness recommend --provider openai --model gpt-6-luna --limit 50 # suggested answers for reviews
+thisness ui --provider openai --model gpt-6-luna                   # ask from the Workbench
+```
+
+What the model does is set per profile (`model_role`): for organizations and taxa it decides contested pairs, and its "same" yields to its own "different" or to a cannot-link constraint; for people it only suggests review answers, since measured on people it was both too cautious and too credulous. `--model-role decide|suggest|shadow|off` overrides that for a run. `--record` keeps every exchange in a cassette and `--replay` answers from one, free and offline. Any OpenAI-compatible server works with `--base-url` (and `--local` when it is yours).
+
+Set `--budget`: there is no default limit.
+
+## How well it works
+
+`thisness eval` resolves a benchmark with known truth and reports precision, recall and false-merge clusters. Measured so far (design 07 §13; design 06 §10):
+
+| Benchmark | Records | P | R | False-merge clusters |
+|---|---|---|---|---|
+| Real UK companies (GLEIF + Companies House), identifiers hidden | 3,507 | .9992 | .912 | 1 |
+| The same, gpt-6-luna deciding contested pairs ($0.62) | 3,507 | .9965 | .938 | 5 |
+| Real UK companies, at scale | 46,565 | .9965 | .934 | 63 |
+| Synthetic organizations, 4,000 | | .9995 | .938 | 4 |
+
+```bash
+thisness eval --size 805 4000                     # synthetic organizations (or --type person)
+thisness eval --type taxon --reference            # WFO plant names, with WFO's own rows
+python -m thisness.benchmark uk-stage             # download GLEIF and Companies House (~1 GB, once)
+thisness eval --source uk --size 400              # real UK companies, identifiers hidden
+thisness eval --source uk --adjudicator openai --model gpt-6-luna --mode decide --budget 2
+```
+
+The UK benchmark's hard cases are real: 62% of live UK companies share a registered address, and a record that says only "Sports Direct" sits beside four real Sports Direct companies. The record variations (shortened names, typos, partial addresses) are generated from the true company, so the truth is known.
+
+## Known limits
+
+- **Memory grows with candidate pairs.** 46,565 records took 7.5 minutes of CPU and 7.8 GB peak memory; scoring holds every candidate pair in Python. Tested to about fifty thousand records.
+- **Candidates come from blocking keys.** There is no embedding-based candidate generator yet, so two records that share no blocking key (a renamed company with nothing else in common, a heterotypic synonym with no authority loaded) are never compared directly.
+- **Model costs are real.** About $0.62 for 400 UK companies with gpt-6-luna; the default model is `claude-sonnet-5`. Use `--budget`, and `--replay` to re-run without paying again.
+- **The network benchmarks download data.** WFO families beyond the shipped three, the Catalogue of Life, and the UK sources are fetched on demand and cached under `~/.cache/thisness`. Everything else, including the Workbench, runs offline.
+
+## What it is
+
+- **Observations are not entities.** A source record is an observation of something. Entities are stable identities above them, with IDs that never change when names do.
+- **Similarity is not identity.** Candidate retrieval, evidence, decisions and identity state are separate steps with separate records. Scores are typed; there is no universal `confidence` float.
+- **Identity is not relationship.** "Subsidiary of" and "brand of" are relationships between distinct entities, never merges.
+- **Everything is reversible.** Merges and splits are ledger events over memberships. Nothing is destructively collapsed, and the ledger alone can rebuild current state.
+- **Models propose; policy decides.** Rules, Fellegi-Sunter, LLMs and people all contribute decisions. Only a commit, citing those decisions, changes identity state.
+
+## Documents
+
+- [Vision](docs/vision.md)
+- [Product requirements](docs/prd.md) and [Appendix A: LLM-assisted resolution](docs/prd-appendix-a-llm-resolution.md)
+- [Research: the entity-resolution landscape](docs/research/entity-resolution-landscape.md)
+- Design:
+  - [01 resolution runs and consensus](docs/design/01-resolution-runs.md)
+  - [02 core model and storage](docs/design/02-core-model-and-storage.md)
+  - [03 resolution pipeline](docs/design/03-resolution-pipeline.md)
+  - [04 review, dossier, Workbench, people](docs/design/04-m2-review-dossier-workbench-person.md)
+  - [05 the language-model layer](docs/design/05-m3-llm-layer.md)
+  - [06 taxonomy, the third domain](docs/design/06-m4-taxonomy.md)
+  - [07 real organizations](docs/design/07-m5-real-organizations.md)
+- [Changelog](CHANGELOG.md)
+
+## Development
+
+```bash
+uv sync --dev   # includes the ui extra
+uv run pytest
+uv run ruff check . && uv run ruff format --check .
+```
+
+Releases publish to PyPI from a version tag: bump `version` in `pyproject.toml`, add a `CHANGELOG.md` entry, then `git tag vX.Y.Z && git push origin vX.Y.Z`.
+
+## Data and license
+
+Thisness is Apache-2.0. See [LICENSE](LICENSE).
+
+Bundled and fetched data keep their own terms, credited where they ship: World Flora Online (CC0 1.0) in `benchmark/data`; GLEIF Golden Copy (CC0 1.0) and Companies House data (Open Government Licence v3.0) in `benchmark/data/uk`; the Catalogue of Life (CC BY 4.0), fetched on demand with attribution; and the Workbench's fonts, icons and scripts in `ui/static/THIRD_PARTY.md`.