tf-rewardkit 1.6.3__tar.gz

tf_rewardkit-1.6.3/LICENSE

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

tf_rewardkit-1.6.3/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: tf-rewardkit
+Version: 1.6.3
+Summary: Lightweight grading toolkit for environment-based tasks.
+Keywords: grading,evaluation,rewards,llm,agents,benchmarks
+Author: benediktstroebl
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Requires-Dist: litellm>=1.83
+Requires-Dist: typing-extensions>=4.6
+Requires-Dist: prefect>=3.8,<3.9
+Requires-Dist: python-pptx>=1.0
+Requires-Dist: pymupdf>=1.24
+Requires-Dist: pillow>=10.0
+Requires-Dist: pillow>=10.0 ; extra == 'all'
+Requires-Dist: markitdown[pdf,docx,pptx,xlsx,xls,outlook]>=0.1 ; extra == 'all'
+Requires-Dist: typesafe-sdk>=0.7 ; extra == 'all'
+Requires-Dist: markitdown[pdf,docx,pptx,xlsx,xls,outlook]>=0.1 ; extra == 'documents'
+Requires-Dist: pillow>=10.0 ; extra == 'image'
+Requires-Dist: typesafe-sdk>=0.7 ; extra == 'jev'
+Requires-Python: >=3.10
+Project-URL: Repository, https://github.com/harbor-framework/harbor
+Project-URL: Issues, https://github.com/harbor-framework/harbor/issues
+Provides-Extra: all
+Provides-Extra: documents
+Provides-Extra: image
+Provides-Extra: jev
+Description-Content-Type: text/markdown
+
+# Harbor Rewardkit
+
+[![](https://dcbadge.limes.pink/api/server/https://discord.gg/QVvyhRw5UQ)](https://discord.gg/QVvyhRw5UQ)
+[![Docs](https://img.shields.io/badge/Docs-000000?style=for-the-badge&logo=mdbook&color=105864)](https://harborframework.com/docs/rewardkit)
+
+Rewardkit is a lightweight verifier package for Harbor tasks or standalone use.
+
+## Installation
+
+```bash
+uv tool install harbor-rewardkit
+```
+
+## Programmatic verifier
+
+```python
+# tests/checks.py
+from rewardkit import criteria
+
+criteria.file_exists("output.txt")
+criteria.file_contains("output.txt", "hello")
+```
+
+Run it with:
+
+```bash
+uvx --from harbor-rewardkit rewardkit /tests
+```
+
+Rewardkit runs the criteria against `/app` and writes
+`/logs/verifier/reward.json`. With files directly under `tests/`, their scores
+are combined into one `reward` automatically.
+
+## Configure scoring
+
+Each Python file that registers criteria is one equal-weighted component named
+after its filename stem. Use `[scoring.<stem>]` in `reward.toml` to change how
+the criteria within that file combine:
+
+```toml
+# tests/reward.toml
+[scoring.checks]
+aggregation = "all-pass"
+```
+
+Files that only provide imports or `shared=True` criterion definitions and
+register no checks are ignored.
+
+## Judge verifier
+
+```toml
+# tests/quality.toml
+[judge]
+judge = "anthropic/claude-sonnet-5"
+files = ["/app/main.py"]
+
+[[criterion]]
+description = "Is the code correct?"
+type = "binary"
+```
+
+`judge` is a LiteLLM model, an agent such as `claude-code`, or `jev` for
+JEV, a new type of language model from TypeSafe (install `harbor-rewardkit[jev]`).
+
+Python files and judge TOMLs can coexist. A judge TOML is also a component named
+after its stem and has its own optional `[scoring]` section.
+
+To change how these flat components combine, add a named reward aggregation:
+
+```toml
+# tests/reward.toml
+[[reward]]
+name = "reward"
+aggregation = "weighted-mean"
+weights = { checks = 2.0, quality = 1.0 }
+```
+
+## Multi-reward verifier
+
+Put scoring inputs in subdirectories to emit separate dimensions:
+
+```text
+tests/
+├── correctness/
+│   └── checks.py
+├── structure/
+│   └── files.py
+└── quality/
+    └── judge.toml
+```
+
+This emits `correctness`, `structure`, and `quality`. Add a root
+`tests/reward.toml` to combine them into a main reward:
+
+```toml
+[[reward]]
+name = "reward"
+aggregation = "weighted-mean"
+weights = { correctness = 2.0, structure = 1.0, quality = 1.0 }
+```
+
+Inside a dimension, one unnamed `[[reward]]` can set weights across local
+Python files, judge TOMLs, and child directories. Reference files by stem and
+child groups by directory name.
+
+See the [documentation](https://harborframework.com/docs/rewardkit) for custom
+criteria, agent judges, the JEV judge, MCP servers, nested groups, and the complete config
+reference. A [working Harbor task](https://github.com/harbor-framework/harbor/tree/main/examples/tasks/reward-kit-example)
+shows the full layout.

tf_rewardkit-1.6.3/README.md

@@ -0,0 +1,109 @@
+# Harbor Rewardkit
+
+[![](https://dcbadge.limes.pink/api/server/https://discord.gg/QVvyhRw5UQ)](https://discord.gg/QVvyhRw5UQ)
+[![Docs](https://img.shields.io/badge/Docs-000000?style=for-the-badge&logo=mdbook&color=105864)](https://harborframework.com/docs/rewardkit)
+
+Rewardkit is a lightweight verifier package for Harbor tasks or standalone use.
+
+## Installation
+
+```bash
+uv tool install harbor-rewardkit
+```
+
+## Programmatic verifier
+
+```python
+# tests/checks.py
+from rewardkit import criteria
+
+criteria.file_exists("output.txt")
+criteria.file_contains("output.txt", "hello")
+```
+
+Run it with:
+
+```bash
+uvx --from harbor-rewardkit rewardkit /tests
+```
+
+Rewardkit runs the criteria against `/app` and writes
+`/logs/verifier/reward.json`. With files directly under `tests/`, their scores
+are combined into one `reward` automatically.
+
+## Configure scoring
+
+Each Python file that registers criteria is one equal-weighted component named
+after its filename stem. Use `[scoring.<stem>]` in `reward.toml` to change how
+the criteria within that file combine:
+
+```toml
+# tests/reward.toml
+[scoring.checks]
+aggregation = "all-pass"
+```
+
+Files that only provide imports or `shared=True` criterion definitions and
+register no checks are ignored.
+
+## Judge verifier
+
+```toml
+# tests/quality.toml
+[judge]
+judge = "anthropic/claude-sonnet-5"
+files = ["/app/main.py"]
+
+[[criterion]]
+description = "Is the code correct?"
+type = "binary"
+```
+
+`judge` is a LiteLLM model, an agent such as `claude-code`, or `jev` for
+JEV, a new type of language model from TypeSafe (install `harbor-rewardkit[jev]`).
+
+Python files and judge TOMLs can coexist. A judge TOML is also a component named
+after its stem and has its own optional `[scoring]` section.
+
+To change how these flat components combine, add a named reward aggregation:
+
+```toml
+# tests/reward.toml
+[[reward]]
+name = "reward"
+aggregation = "weighted-mean"
+weights = { checks = 2.0, quality = 1.0 }
+```
+
+## Multi-reward verifier
+
+Put scoring inputs in subdirectories to emit separate dimensions:
+
+```text
+tests/
+├── correctness/
+│   └── checks.py
+├── structure/
+│   └── files.py
+└── quality/
+    └── judge.toml
+```
+
+This emits `correctness`, `structure`, and `quality`. Add a root
+`tests/reward.toml` to combine them into a main reward:
+
+```toml
+[[reward]]
+name = "reward"
+aggregation = "weighted-mean"
+weights = { correctness = 2.0, structure = 1.0, quality = 1.0 }
+```
+
+Inside a dimension, one unnamed `[[reward]]` can set weights across local
+Python files, judge TOMLs, and child directories. Reference files by stem and
+child groups by directory name.
+
+See the [documentation](https://harborframework.com/docs/rewardkit) for custom
+criteria, agent judges, the JEV judge, MCP servers, nested groups, and the complete config
+reference. A [working Harbor task](https://github.com/harbor-framework/harbor/tree/main/examples/tasks/reward-kit-example)
+shows the full layout.

tf_rewardkit-1.6.3/pyproject.toml

@@ -0,0 +1,64 @@
+[project]
+name = "tf-rewardkit"
+version = "1.6.3"
+description = "Lightweight grading toolkit for environment-based tasks."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+    { name = "benediktstroebl" },
+]
+requires-python = ">=3.10"
+keywords = ["grading", "evaluation", "rewards", "llm", "agents", "benchmarks"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Testing",
+]
+dependencies = [
+    "litellm>=1.83",
+    "typing_extensions>=4.6",
+    "prefect>=3.8,<3.9",
+    "python-pptx>=1.0",
+    "pymupdf>=1.24",
+    "Pillow>=10.0",
+]
+
+[project.optional-dependencies]
+documents = ["markitdown[pdf,docx,pptx,xlsx,xls,outlook]>=0.1"]
+image = ["Pillow>=10.0"]
+jev = ["typesafe-sdk>=0.7"]
+all = [
+    "Pillow>=10.0",
+    "markitdown[pdf,docx,pptx,xlsx,xls,outlook]>=0.1",
+    "typesafe-sdk>=0.7",
+]
+
+[project.urls]
+Repository = "https://github.com/harbor-framework/harbor"
+Issues = "https://github.com/harbor-framework/harbor/issues"
+
+[dependency-groups]
+dev = [
+    "pytest>=8",
+    "pytest-asyncio",
+    "ruff>=0.4",
+    "typesafe-sdk>=0.7",
+]
+
+[project.scripts]
+rewardkit = "rewardkit.__main__:main"
+rewardkit-workflow = "rewardkit.workflow.cli:main"
+
+[build-system]
+requires = ["uv_build>=0.10.8,<0.11.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "rewardkit"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"

tf_rewardkit-1.6.3/src/rewardkit/__init__.py

@@ -0,0 +1,66 @@
+from rewardkit.agents import AgentAttempt, AgentBackend, register_agent
+from rewardkit.compare import ComparisonResult, compare, format_comparison
+from rewardkit.models import (
+    Aggregation,
+    AgentJudge,
+    Binary,
+    Criterion,
+    JevJudge,
+    LLMJudge,
+    Likert,
+    MCPServerConfig,
+    Numeric,
+    OutputFormat,
+    Rubric,
+    Score,
+)
+from rewardkit.reward import Reward
+from rewardkit.runner import discover, run, run_multi
+from rewardkit.session import criterion
+from rewardkit.trajectory import format_trajectory
+
+__all__ = [
+    "AgentAttempt",
+    "AgentBackend",
+    "Aggregation",
+    "AgentJudge",
+    "Binary",
+    "ComparisonResult",
+    "Criterion",
+    "JevJudge",
+    "LLMJudge",
+    "Likert",
+    "MCPServerConfig",
+    "Numeric",
+    "OutputFormat",
+    "Reward",
+    "Rubric",
+    "Score",
+    "compare",
+    "criterion",
+    "discover",
+    "format_comparison",
+    "format_trajectory",
+    "register_agent",
+    "run",
+    "run_multi",
+]
+
+
+def __getattr__(name: str):  # noqa: ANN204
+    """Allow criteria to be accessed directly, e.g. ``rk.file_exists(...)``."""
+    import rewardkit.criteria  # noqa: F401 — ensures built-in criteria are registered
+
+    from rewardkit.session import _factory_registry
+
+    if name in _factory_registry:
+        return _factory_registry[name]
+    raise AttributeError(f"module 'rewardkit' has no attribute {name!r}")
+
+
+def __dir__() -> list[str]:
+    import rewardkit.criteria  # noqa: F401
+
+    from rewardkit.session import _factory_registry
+
+    return list(set(__all__) | set(_factory_registry))