diff --git a/src/documentation/how_tos/studio/how_to_execute_a_benchmark.ipynb b/src/documentation/how_tos/studio/how_to_execute_a_benchmark.ipynb index 9b23112c..99bb5d6f 100644 --- a/src/documentation/how_tos/studio/how_to_execute_a_benchmark.ipynb +++ b/src/documentation/how_tos/studio/how_to_execute_a_benchmark.ipynb @@ -12,21 +12,32 @@ "\n", "from documentation.how_tos.example_data import (\n", " DummyAggregationLogic,\n", - " DummyEvaluationLogic,\n", + " DummyEvaluation,\n", " DummyTask,\n", " example_data,\n", ")\n", - "from intelligence_layer.connectors.studio.studio import StudioClient\n", - "from intelligence_layer.evaluation.benchmark.studio_benchmark import (\n", + "from intelligence_layer.connectors import StudioClient\n", + "from intelligence_layer.evaluation import (\n", + " EvaluationLogic,\n", + " Example,\n", " StudioBenchmarkRepository,\n", - ")\n", - "from intelligence_layer.evaluation.dataset.studio_dataset_repository import (\n", " StudioDatasetRepository,\n", + " SuccessfulExampleOutput,\n", ")\n", "\n", "load_dotenv()\n", "my_example_data = example_data()\n", - "examples = my_example_data.examples" + "examples = my_example_data.examples\n", + "\n", + "\n", + "class DummyEvaluationLogic(EvaluationLogic[str, str, str, DummyEvaluation]):\n", + " def do_evaluate(\n", + " self, example: Example[str, str], *output: SuccessfulExampleOutput[str]\n", + " ) -> DummyEvaluation:\n", + " output_str = \"(\" + (\", \".join(o.output for o in output)) + \")\"\n", + " return DummyEvaluation(\n", + " eval=f\"{example.input}, {example.expected_output}, {output_str} -> evaluation\"\n", + " )" ] }, { @@ -89,7 +100,7 @@ ], "metadata": { "kernelspec": { - "display_name": "intelligence-layer-LP3DLT23-py3.12", + "display_name": ".venv", "language": "python", "name": "python3" }, diff --git a/src/intelligence_layer/evaluation/__init__.py b/src/intelligence_layer/evaluation/__init__.py index f97a162e..055b155f 100644 --- a/src/intelligence_layer/evaluation/__init__.py +++ b/src/intelligence_layer/evaluation/__init__.py @@ -23,6 +23,10 @@ from .aggregation.in_memory_aggregation_repository import ( InMemoryAggregationRepository as InMemoryAggregationRepository, ) +from .benchmark.studio_benchmark import StudioBenchmark as StudioBenchmark +from .benchmark.studio_benchmark import ( + StudioBenchmarkRepository as StudioBenchmarkRepository, +) from .dataset.dataset_repository import DatasetRepository as DatasetRepository from .dataset.domain import Dataset as Dataset from .dataset.domain import Example as Example diff --git a/src/intelligence_layer/evaluation/benchmark/get_code.py b/src/intelligence_layer/evaluation/benchmark/get_code.py new file mode 100644 index 00000000..f2e897ba --- /dev/null +++ b/src/intelligence_layer/evaluation/benchmark/get_code.py @@ -0,0 +1,277 @@ +""" +The following code is licensed under the following license and taken from https://github.com/wandb/weave. +The following modifications have been made: + - Adapt the type hints to be more specific to this project + - Change the control flow for the get_source_notebook_safe to try to only get the source from notebooks once it fails. + + 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. +""" # noqa + +import ast +import inspect +import textwrap + +from intelligence_layer.evaluation.aggregation.aggregator import AggregationLogic +from intelligence_layer.evaluation.evaluation.evaluator.evaluator import EvaluationLogic + + +class NotInteractiveEnvironmentError(Exception): ... + + +def is_running_interactively() -> bool: + """Check if the code is running in an interactive environment.""" + try: + from IPython import get_ipython + + return get_ipython() is not None + except ModuleNotFoundError: + return False + + +def get_notebook_source() -> str: + """Get the source code of the running notebook.""" + from IPython import get_ipython + + shell = get_ipython() + if shell is None: + raise NotInteractiveEnvironmentError + + if not hasattr(shell, "user_ns"): + raise AttributeError("Cannot access user namespace") + + # This is the list of input cells in the notebook + in_list = shell.user_ns["In"] + + # Stitch them back into a single "file" + full_source = "\n\n".join(cell for cell in in_list[1:] if cell) + + return full_source + + +def get_class_source(cls: type) -> str: + """Get the latest source definition of a class in the notebook.""" + notebook_source = get_notebook_source() + tree = ast.parse(notebook_source) + class_name = cls.__name__ + + # We need to walk the entire tree and get the last one since that's the most version of the cls + segment = None + for node in ast.walk(tree): + if isinstance(node, ast.ClassDef) and node.name == class_name: + segment = ast.get_source_segment(notebook_source, node) + + if segment is not None: + return segment + + raise ValueError(f"Class '{class_name}' not found in the notebook") + + +def get_source_notebook_safe(logic: EvaluationLogic | AggregationLogic) -> str: + # In ipython, we can't use inspect.getsource on classes defined in the notebook + logic_class = type(logic) + try: + src = inspect.getsource(logic_class) + except OSError: + if is_running_interactively() and inspect.isclass(logic_class): + src = get_class_source(logic_class) + return textwrap.dedent(src) diff --git a/src/intelligence_layer/evaluation/benchmark/studio_benchmark.py b/src/intelligence_layer/evaluation/benchmark/studio_benchmark.py index 23235024..d88c35e7 100644 --- a/src/intelligence_layer/evaluation/benchmark/studio_benchmark.py +++ b/src/intelligence_layer/evaluation/benchmark/studio_benchmark.py @@ -1,4 +1,3 @@ -import inspect from collections.abc import Sequence from datetime import datetime from http import HTTPStatus @@ -29,6 +28,7 @@ Benchmark, BenchmarkRepository, ) +from intelligence_layer.evaluation.benchmark.get_code import get_source_notebook_safe from intelligence_layer.evaluation.dataset.domain import ExpectedOutput from intelligence_layer.evaluation.dataset.studio_dataset_repository import ( StudioDatasetRepository, @@ -269,7 +269,7 @@ def create_evaluation_logic_identifier( evaluation_logic=eval_logic, ) return EvaluationLogicIdentifier( - logic=inspect.getsource(type(eval_logic)), + logic=get_source_notebook_safe(eval_logic), input_schema=type_to_schema(evaluator.input_type()), output_schema=type_to_schema(evaluator.output_type()), expected_output_schema=type_to_schema(evaluator.expected_output_type()), @@ -287,7 +287,7 @@ def create_aggregation_logic_identifier( aggregation_logic=aggregation_logic, ) return AggregationLogicIdentifier( - logic=inspect.getsource(type(aggregation_logic)), + logic=get_source_notebook_safe(aggregation_logic), evaluation_schema=type_to_schema(aggregator.evaluation_type()), aggregation_schema=type_to_schema(aggregator.aggregated_evaluation_type()), ) diff --git a/src/intelligence_layer/evaluation/dataset/studio_dataset_repository.py b/src/intelligence_layer/evaluation/dataset/studio_dataset_repository.py index 4c0f4ffc..e9c91b66 100644 --- a/src/intelligence_layer/evaluation/dataset/studio_dataset_repository.py +++ b/src/intelligence_layer/evaluation/dataset/studio_dataset_repository.py @@ -10,9 +10,9 @@ StudioExample, ) from intelligence_layer.core import Input -from intelligence_layer.evaluation import ( +from intelligence_layer.evaluation.dataset.dataset_repository import DatasetRepository +from intelligence_layer.evaluation.dataset.domain import ( Dataset, - DatasetRepository, Example, ExpectedOutput, )