stickler-eval 0.1.0__tar.gz

stickler_eval-0.1.0/LICENSE

@@ -0,0 +1,175 @@
+
+                                 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.

stickler_eval-0.1.0/NOTICE

@@ -0,0 +1 @@
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

stickler_eval-0.1.0/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.4
+Name: stickler-eval
+Version: 0.1.0
+Summary: Structured object comparison and evaluation library
+Author-email: Spencer Romo <sromo@amazon.com>
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: pydantic>=2.11.0
+Requires-Dist: rapidfuzz>=3.0.0
+Requires-Dist: munkres>=1.1.4
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: scipy>=1.10.0
+Requires-Dist: psutil>=5.8.0
+Requires-Dist: pandas>=1.5.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-xdist>=3.0.0; extra == "dev"
+Dynamic: license-file
+
+# stickler-lib
+
+A Python library for structured object comparison and evaluation with configurable comparison strategies and detailed metrics.
+
+## Installation
+
+### Requirements
+- Python 3.12+
+- conda (recommended)
+
+### Quick Install
+```bash
+# Create conda environment
+conda create -n stickler python=3.12 -y
+conda activate stickler
+
+# Install the library
+pip install -e .
+```
+
+### Development Install
+```bash
+# Install with testing dependencies
+pip install -e ".[dev]"
+```
+
+## Quick Test
+
+Run the example to verify installation:
+```bash
+python examples/scripts/quick_start.py
+```
+
+Run tests:
+```bash
+pytest tests/
+```
+
+## Basic Usage
+
+### Static Model Definition
+
+```python
+from stickler import StructuredModel, ComparableField, StructuredModelEvaluator
+from stickler.comparators.levenshtein import LevenshteinComparator
+
+# Define your data structure
+class Invoice(StructuredModel):
+    invoice_number: str = ComparableField(
+        comparator=LevenshteinComparator(),
+        threshold=0.9
+    )
+    total: float = ComparableField(threshold=0.95)
+
+# Compare objects
+evaluator = StructuredModelEvaluator()
+result = evaluator.evaluate(ground_truth, prediction)
+
+print(f"Overall Score: {result['overall']['anls_score']:.3f}")
+```
+
+### Dynamic Model Creation (New!)
+
+Create models from JSON configuration for maximum flexibility:
+
+```python
+from stickler.structured_object_evaluator.models.structured_model import StructuredModel
+
+# Define model configuration
+config = {
+    "model_name": "Product",
+    "match_threshold": 0.8,
+    "fields": {
+        "name": {
+            "type": "str",
+            "comparator": "LevenshteinComparator",
+            "threshold": 0.8,
+            "weight": 2.0
+        },
+        "price": {
+            "type": "float",
+            "comparator": "NumericComparator",
+            "default": 0.0
+        }
+    }
+}
+
+# Create dynamic model class
+Product = StructuredModel.model_from_json(config)
+
+# Use like any Pydantic model
+product1 = Product(name="Widget", price=29.99)
+product2 = Product(name="Gadget", price=29.99)
+
+# Full comparison capabilities
+result = product1.compare_with(product2)
+print(f"Similarity: {result['overall_score']:.2f}")
+```
+
+### Complete JSON-to-Evaluation Workflow (New!)
+
+For maximum flexibility, load both configuration AND data from JSON:
+
+```python
+# Load model config from JSON
+with open('model_config.json') as f:
+    config = json.load(f)
+
+# Load test data from JSON  
+with open('test_data.json') as f:
+    data = json.load(f)
+
+# Create model and instances from JSON
+Model = StructuredModel.model_from_json(config)
+ground_truth = Model(**data['ground_truth'])
+prediction = Model(**data['prediction'])
+
+# Evaluate - no Python object construction needed!
+result = ground_truth.compare_with(prediction)
+```
+
+**Benefits of JSON-Driven Approach:**
+- Zero Python object construction required
+- Configuration-driven model creation
+- A/B testing different field configurations
+- Runtime model generation from external schemas
+- Production-ready JSON-based evaluation pipeline
+- Full Pydantic compatibility with comparison capabilities
+
+See [`examples/scripts/json_to_evaluation_demo.py`](examples/scripts/json_to_evaluation_demo.py) for a complete working example and [`docs/StructuredModel_Dynamic_Creation.md`](docs/StructuredModel_Dynamic_Creation.md) for comprehensive documentation.
+
+## Examples
+
+Check out the `examples/` directory for more detailed usage examples and notebooks.
+
+## License
+
+© 2025 Amazon Web Services, Inc. or its affiliates. All Rights Reserved.

stickler_eval-0.1.0/README.md

@@ -0,0 +1,138 @@
+# stickler-lib
+
+A Python library for structured object comparison and evaluation with configurable comparison strategies and detailed metrics.
+
+## Installation
+
+### Requirements
+- Python 3.12+
+- conda (recommended)
+
+### Quick Install
+```bash
+# Create conda environment
+conda create -n stickler python=3.12 -y
+conda activate stickler
+
+# Install the library
+pip install -e .
+```
+
+### Development Install
+```bash
+# Install with testing dependencies
+pip install -e ".[dev]"
+```
+
+## Quick Test
+
+Run the example to verify installation:
+```bash
+python examples/scripts/quick_start.py
+```
+
+Run tests:
+```bash
+pytest tests/
+```
+
+## Basic Usage
+
+### Static Model Definition
+
+```python
+from stickler import StructuredModel, ComparableField, StructuredModelEvaluator
+from stickler.comparators.levenshtein import LevenshteinComparator
+
+# Define your data structure
+class Invoice(StructuredModel):
+    invoice_number: str = ComparableField(
+        comparator=LevenshteinComparator(),
+        threshold=0.9
+    )
+    total: float = ComparableField(threshold=0.95)
+
+# Compare objects
+evaluator = StructuredModelEvaluator()
+result = evaluator.evaluate(ground_truth, prediction)
+
+print(f"Overall Score: {result['overall']['anls_score']:.3f}")
+```
+
+### Dynamic Model Creation (New!)
+
+Create models from JSON configuration for maximum flexibility:
+
+```python
+from stickler.structured_object_evaluator.models.structured_model import StructuredModel
+
+# Define model configuration
+config = {
+    "model_name": "Product",
+    "match_threshold": 0.8,
+    "fields": {
+        "name": {
+            "type": "str",
+            "comparator": "LevenshteinComparator",
+            "threshold": 0.8,
+            "weight": 2.0
+        },
+        "price": {
+            "type": "float",
+            "comparator": "NumericComparator",
+            "default": 0.0
+        }
+    }
+}
+
+# Create dynamic model class
+Product = StructuredModel.model_from_json(config)
+
+# Use like any Pydantic model
+product1 = Product(name="Widget", price=29.99)
+product2 = Product(name="Gadget", price=29.99)
+
+# Full comparison capabilities
+result = product1.compare_with(product2)
+print(f"Similarity: {result['overall_score']:.2f}")
+```
+
+### Complete JSON-to-Evaluation Workflow (New!)
+
+For maximum flexibility, load both configuration AND data from JSON:
+
+```python
+# Load model config from JSON
+with open('model_config.json') as f:
+    config = json.load(f)
+
+# Load test data from JSON  
+with open('test_data.json') as f:
+    data = json.load(f)
+
+# Create model and instances from JSON
+Model = StructuredModel.model_from_json(config)
+ground_truth = Model(**data['ground_truth'])
+prediction = Model(**data['prediction'])
+
+# Evaluate - no Python object construction needed!
+result = ground_truth.compare_with(prediction)
+```
+
+**Benefits of JSON-Driven Approach:**
+- Zero Python object construction required
+- Configuration-driven model creation
+- A/B testing different field configurations
+- Runtime model generation from external schemas
+- Production-ready JSON-based evaluation pipeline
+- Full Pydantic compatibility with comparison capabilities
+
+See [`examples/scripts/json_to_evaluation_demo.py`](examples/scripts/json_to_evaluation_demo.py) for a complete working example and [`docs/StructuredModel_Dynamic_Creation.md`](docs/StructuredModel_Dynamic_Creation.md) for comprehensive documentation.
+
+## Examples
+
+Check out the `examples/` directory for more detailed usage examples and notebooks.
+
+## License
+
+© 2025 Amazon Web Services, Inc. or its affiliates. All Rights Reserved.

stickler_eval-0.1.0/pyproject.toml

@@ -0,0 +1,36 @@
+[project]
+name = "stickler-eval"
+version = "0.1.0"
+description = "Structured object comparison and evaluation library"
+authors = [
+    {name = "Spencer Romo", email = "sromo@amazon.com"}
+]
+readme = "README.md"
+requires-python = ">=3.12"
+
+dependencies = [
+    "pydantic>=2.11.0",
+    "rapidfuzz>=3.0.0",
+    "munkres>=1.1.4",
+    "numpy>=1.24.0",
+    "scipy>=1.10.0",
+    "psutil>=5.8.0",
+    "pandas>=1.5.0"
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-xdist>=3.0.0"
+]
+
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[build-system]
+requires = ["setuptools >= 61.0", "wheel"]
+build-backend = "setuptools.build_meta"

stickler_eval-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

stickler_eval-0.1.0/src/stickler/__init__.py

@@ -0,0 +1,30 @@
+"""
+stickler: Structured object comparison and evaluation library.
+
+This library provides tools for comparing complex structured objects
+with configurable comparison strategies and detailed evaluation metrics.
+"""
+
+from .structured_object_evaluator import (
+    StructuredModel,
+    ComparableField,
+    NonMatchField,
+    NonMatchType,
+    StructuredModelEvaluator,
+    compare_structured_models,
+    anls_score,
+    compare_json,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "StructuredModel",
+    "ComparableField",
+    "NonMatchField",
+    "NonMatchType",
+    "StructuredModelEvaluator",
+    "compare_structured_models",
+    "anls_score",
+    "compare_json",
+]

stickler_eval-0.1.0/src/stickler/algorithms/__init__.py

@@ -0,0 +1,12 @@
+"""Common algorithms for key information evaluation.
+
+This package contains algorithms that are shared between the traditional
+and ANLS Star evaluation systems.
+"""
+
+from stickler.algorithms.hungarian import (
+    HungarianMatcher,
+    HUNGARIAN_SIZE_WARNING_THRESHOLD,
+)
+
+__all__ = ["HungarianMatcher", "HUNGARIAN_SIZE_WARNING_THRESHOLD"]