| Name | flow-judge JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A small yet powerful LM Judge |
| upload_time | 2024-10-08 15:04:46 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2024 Flow AI Oy 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. |
| keywords |
lm-judge
evaluation
llms
ai
benchmarking
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `flow-judge`
<p align="center">
<img src="img/flow_judge_banner.png" alt="Flow Judge Banner">
</p>
<p align="center" style="font-family: 'Courier New', Courier, monospace;">
<strong>
<a href="https://www.flow-ai.com/judge">Technical Report</a> |
<a href="https://huggingface.co/collections/flowaicom/flow-judge-v01-66e6af5fc3b3a128bde07dec">Model Weights</a> |
<a href="https://github.com/flowaicom/lm-evaluation-harness/tree/Flow-Judge-v0.1_evals/lm_eval/tasks/flow_judge_evals">Evaluation Code</a> |
<a href="https://github.com/flowaicom/flow-judge/tree/main/examples">Examples</a>
</strong>
</p>
<p align="center" style="font-family: 'Courier New', Courier, monospace;">
<code>flow-judge</code> is a lightweight library for evaluating LLM applications with <code>Flow-Judge-v0.1</code>.
</p>
<p align="center">
<a href="https://github.com/flowaicom/flow-judge/stargazers/" target="_blank">
<img src="https://img.shields.io/github/stars/flowaicom/flow-judge?style=social&label=Star&maxAge=3600" alt="GitHub stars">
</a>
<a href="https://github.com/flowaicom/flow-judge/releases" target="_blank">
<img src="https://img.shields.io/github/v/release/flowaicom/flow-judge?color=white" alt="Release">
</a>
<a href="https://www.youtube.com/@flowaicom" target="_blank">
<img alt="YouTube Channel Views" src="https://img.shields.io/youtube/channel/views/UCo2qL1nIQRHiPc0TF9xbqwg?style=social">
</a>
<a href="https://github.com/flowaicom/flow-judge/actions/workflows/python-package.yml" target="_blank">
<img src="https://github.com/flowaicom/flow-judge/actions/workflows/python-package.yml/badge.svg" alt="Build">
</a>
<a href="https://codecov.io/gh/flowaicom/flow-judge" target="_blank">
<img src="https://codecov.io/gh/flowaicom/flow-judge/branch/feat%2Fllamafile/graph/badge.svg?token=AEGC7W3DGE" alt="Code coverage">
</a>
<a href="https://github.com/flowaicom/flow-judge/blob/main/LICENSE" target="_blank">
<img src="https://img.shields.io/static/v1?label=license&message=Apache%202.0&color=white" alt="License">
</a>
</p>
## Model
`Flow-Judge-v0.1` is an open, small yet powerful language model evaluator trained on a synthetic dataset containing LLM system evaluation data by Flow AI.
You can learn more about the unique features of our model in the [technical report](https://www.flow-ai.com/blog/flow-judge#flow-judge-an-open-small-language-model-for-llm-system-evaluations).
## Features of the library
- Support for multiple model types: Hugging Face Transformers and vLLM
- Extensible architecture for custom metrics
- Pre-defined evaluation metrics
- Ease of custom metric and rubric creation
- Batched evaluation for efficient processing
- Integrations with most popular frameworks like Llama Index
## Installation
Install flow-judge using pip:
```bash
pip install -e ".[vllm,hf]"
pip install 'flash_attn>=2.6.3' --no-build-isolation
```
Extras available:
- `dev` to install development dependencies
- `hf` to install Hugging Face Transformers dependencies
- `vllm` to install vLLM dependencies
- `llamafile` to install Llamafile dependencies
## Quick Start
Here's a simple example to get you started:
```python
from flow_judge import Vllm, Llamafile, Hf, EvalInput, FlowJudge
from flow_judge.metrics import RESPONSE_FAITHFULNESS_5POINT
from IPython.display import Markdown, display
# If you are running on an Ampere GPU or newer, create a model using VLLM
model = Vllm()
# If you have other applications open taking up VRAM, you can use less VRAM by setting gpu_memory_utilization to a lower value.
# model = Vllm(gpu_memory_utilization=0.70)
# Or if not running on Ampere GPU or newer, create a model using no flash attn and Hugging Face Transformers
# model = Hf(flash_attn=False)
# Or create a model using Llamafile if not running an Nvidia GPU & running a Silicon MacOS for example
# model = Llamafile()
# Initialize the judge
faithfulness_judge = FlowJudge(
metric=RESPONSE_FAITHFULNESS_5POINT,
model=model
)
# Sample to evaluate
query = """..."""
context = """...""""
response = """..."""
# Create an EvalInput
# We want to evaluate the response to the customer issue based on the context and the user instructions
eval_input = EvalInput(
inputs=[
{"query": query},
{"context": context},
],
output={"response": response},
)
# Run the evaluation
result = faithfulness_judge.evaluate(eval_input, save_results=False)
# Display the result
display(Markdown(f"__Feedback:__\n{result.feedback}\n\n__Score:__\n{result.score}"))
```
## Usage
### Inference Options
The library supports multiple inference backends to accommodate different hardware configurations and performance needs:
1. **vLLM**:
- Best for NVIDIA GPUs with Ampere architecture or newer (e.g., RTX 3000 series, A100, H100)
- Offers the highest performance and throughput
- Requires CUDA-compatible GPU
```python
from flow_judge import Vllm
model = Vllm()
```
2. **Hugging Face Transformers**:
- Compatible with a wide range of hardware, including older NVIDIA GPUs
- Supports CPU inference (slower but universally compatible)
- It is slower than vLLM but generally compatible with more hardware.
If you are running on an Ampere GPU or newer:
```python
from flow_judge import Hf
model = Hf()
```
If you are not running on an Ampere GPU or newer, disable flash attention:
```python
from flow_judge import Hf
model = Hf(flash_attn=False)
```
3. **Llamafile**:
- Ideal for non-NVIDIA hardware, including Apple Silicon
- Provides good performance on CPUs
- Self-contained, easy to deploy option
```python
from flow_judge import Llamafile
model = Llamafile()
```
Choose the inference backend that best matches your hardware and performance requirements. The library provides a unified interface for all these options, making it easy to switch between them as needed.
### Evaluation Metrics
`Flow-Judge-v0.1` was trained to handle any custom metric that can be expressed as a combination of evaluation criteria and rubric, and required inputs and outputs.
#### Pre-defined Metrics
For convenience, `flow-judge` library comes with pre-defined metrics such as `RESPONSE_CORRECTNESS` or `RESPONSE_FAITHFULNESS`. You can check the full list by running:
```python
from flow_judge.metrics import list_all_metrics
list_all_metrics()
```
### Batched Evaluations
For efficient processing of multiple inputs, you can use the `batch_evaluate` method:
```python
# Read the sample data
import json
from flow_judge import Vllm, EvalInput, FlowJudge
from flow_judge.metrics import RESPONSE_FAITHFULNESS_5POINT
from IPython.display import Markdown, display
# Initialize the model
model = Vllm()
# Initialize the judge
faithfulness_judge = FlowJudge(
metric=RESPONSE_FAITHFULNESS_5POINT,
model=model
)
# Load some sampledata
with open("sample_data/csr_assistant.json", "r") as f:
data = json.load(f)
# Create a list of inputs and outputs
inputs_batch = [
[
{"query": sample["query"]},
{"context": sample["context"]},
]
for sample in data
]
outputs_batch = [{"response": sample["response"]} for sample in data]
# Create a list of EvalInput
eval_inputs_batch = [EvalInput(inputs=inputs, output=output) for inputs, output in zip(inputs_batch, outputs_batch)]
# Run the batch evaluation
results = faithfulness_judge.batch_evaluate(eval_inputs_batch, save_results=False)
# Visualizing the results
for i, result in enumerate(results):
display(Markdown(f"__Sample {i+1}:__"))
display(Markdown(f"__Feedback:__\n{result.feedback}\n\n__Score:__\n{result.score}"))
display(Markdown("---"))
```
## Advanced Usage
> [!WARNING]
> There exists currently a reported issue with Phi-3 models that produces gibberish outputs with contexts longer than 4096 tokens, including input and output. This issue has been recently fixed in the transformers library so we recommend using the `Hf()` model configuration for longer contexts at the moment. For more details, refer to: [#33129](https://github.com/huggingface/transformers/pull/33129) and [#6135](https://github.com/vllm-project/vllm/issues/6135)
### Custom Metrics
Create your own evaluation metrics:
```python
from flow_judge.metrics import CustomMetric, RubricItem
custom_metric = CustomMetric(
name="My Custom Metric",
criteria="Evaluate based on X, Y, and Z.",
rubric=[
RubricItem(score=0, description="Poor performance"),
RubricItem(score=1, description="Good performance"),
],
required_inputs=["query"],
required_output="response"
)
judge = FlowJudge(metric=custom_metric, config="Flow-Judge-v0.1-AWQ")
```
### Integrations
We support an integration with Llama Index evaluation module and Haystack:
- [Llama Index tutorial](https://github.com/flowaicom/flow-judge/blob/main/examples/4_llama_index_evaluators.ipynb)
- [Haystack tutorial](https://github.com/flowaicom/flow-judge/blob/main/examples/5_evaluate_haystack_rag_pipeline.ipynb)
> Note that we are currently working on adding more integrations with other frameworks in the near future.
## Development Setup
1. Clone the repository:
```bash
git clone https://github.com/flowaicom/flow-judge.git
cd flow-judge
```
2. Create a virtual environment:
```bash
virtualenv ./.venv
```
or
```bash
python -m venv ./.venv
```
3. Activate the virtual environment:
- On Windows:
```bash
venv\Scripts\activate
```
- On macOS and Linux:
```bash
source venv/bin/activate
```
4. Install the package in editable mode with development dependencies:
```bash
pip install -e ".[dev]"
```
or
```bash
pip install -e ".[dev,vllm]"
```
for vLLM support.
5. Set up pre-commit hooks:
```bash
pre-commit install
```
6. Run pre-commit on all files:
```bash
pre-commit run --all-files
```
7. You're now ready to start developing! You can run the main script with:
```bash
python -m flow_judge
```
Remember to always activate your virtual environment when working on the project. To deactivate the virtual environment when you're done, simply run:
```bash
deactivate
```
## Running Tests
To run the tests for Flow-Judge, follow these steps:
1. Navigate to the root directory of the project in your terminal.
2. Run the tests using pytest:
```bash
pytest tests/
```
This will discover and run all the tests in the `tests/` directory.
3. If you want to run a specific test file, you can do so by specifying the file path:
```bash
pytest tests/test_flow_judge.py
```
4. For more verbose output, you can use the `-v` flag:
```bash
pytest -v tests/
```
## Contributing
Contributions to `flow-judge` are welcome! Please follow these steps:
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
Please ensure that your code adheres to the project's coding standards and passes all tests.
## License
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
Flow-Judge is developed and maintained by the Flow AI team. We appreciate the contributions and feedback from the AI community in making this tool more robust and versatile.
Raw data
{
"_id": null,
"home_page": null,
"name": "flow-judge",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "LM-judge, evaluation, LLMs, AI, benchmarking",
"author": null,
"author_email": "Bernardo Garcia <bernardo@flow-ai.com>, Karolus Sariola <karolus@flow-ai.com>, Minaam Shahid <minaam@flow-ai.com>, Tiina Vaahtio <tiina@flow-ai.com>",
"download_url": "https://files.pythonhosted.org/packages/98/af/4562cf283de5d593d6243c5acff6ac4dda4f79cae5c953adffc9c6e0ed9f/flow_judge-0.1.0.tar.gz",
"platform": null,
"description": "# `flow-judge`\n\n<p align=\"center\">\n <img src=\"img/flow_judge_banner.png\" alt=\"Flow Judge Banner\">\n</p>\n\n<p align=\"center\" style=\"font-family: 'Courier New', Courier, monospace;\">\n <strong>\n <a href=\"https://www.flow-ai.com/judge\">Technical Report</a> |\n <a href=\"https://huggingface.co/collections/flowaicom/flow-judge-v01-66e6af5fc3b3a128bde07dec\">Model Weights</a> |\n <a href=\"https://github.com/flowaicom/lm-evaluation-harness/tree/Flow-Judge-v0.1_evals/lm_eval/tasks/flow_judge_evals\">Evaluation Code</a> |\n <a href=\"https://github.com/flowaicom/flow-judge/tree/main/examples\">Examples</a>\n </strong>\n</p>\n\n<p align=\"center\" style=\"font-family: 'Courier New', Courier, monospace;\">\n <code>flow-judge</code> is a lightweight library for evaluating LLM applications with <code>Flow-Judge-v0.1</code>.\n</p>\n\n<p align=\"center\">\n<a href=\"https://github.com/flowaicom/flow-judge/stargazers/\" target=\"_blank\">\n <img src=\"https://img.shields.io/github/stars/flowaicom/flow-judge?style=social&label=Star&maxAge=3600\" alt=\"GitHub stars\">\n</a>\n<a href=\"https://github.com/flowaicom/flow-judge/releases\" target=\"_blank\">\n <img src=\"https://img.shields.io/github/v/release/flowaicom/flow-judge?color=white\" alt=\"Release\">\n</a>\n<a href=\"https://www.youtube.com/@flowaicom\" target=\"_blank\">\n <img alt=\"YouTube Channel Views\" src=\"https://img.shields.io/youtube/channel/views/UCo2qL1nIQRHiPc0TF9xbqwg?style=social\">\n</a>\n<a href=\"https://github.com/flowaicom/flow-judge/actions/workflows/python-package.yml\" target=\"_blank\">\n <img src=\"https://github.com/flowaicom/flow-judge/actions/workflows/python-package.yml/badge.svg\" alt=\"Build\">\n</a>\n<a href=\"https://codecov.io/gh/flowaicom/flow-judge\" target=\"_blank\">\n <img src=\"https://codecov.io/gh/flowaicom/flow-judge/branch/feat%2Fllamafile/graph/badge.svg?token=AEGC7W3DGE\" alt=\"Code coverage\">\n</a>\n<a href=\"https://github.com/flowaicom/flow-judge/blob/main/LICENSE\" target=\"_blank\">\n <img src=\"https://img.shields.io/static/v1?label=license&message=Apache%202.0&color=white\" alt=\"License\">\n</a>\n</p>\n\n## Model\n`Flow-Judge-v0.1` is an open, small yet powerful language model evaluator trained on a synthetic dataset containing LLM system evaluation data by Flow AI.\n\nYou can learn more about the unique features of our model in the [technical report](https://www.flow-ai.com/blog/flow-judge#flow-judge-an-open-small-language-model-for-llm-system-evaluations).\n\n\n## Features of the library\n\n- Support for multiple model types: Hugging Face Transformers and vLLM\n- Extensible architecture for custom metrics\n- Pre-defined evaluation metrics\n- Ease of custom metric and rubric creation\n- Batched evaluation for efficient processing\n- Integrations with most popular frameworks like Llama Index\n\n## Installation\n\nInstall flow-judge using pip:\n\n```bash\npip install -e \".[vllm,hf]\"\npip install 'flash_attn>=2.6.3' --no-build-isolation\n```\n\nExtras available:\n- `dev` to install development dependencies\n- `hf` to install Hugging Face Transformers dependencies\n- `vllm` to install vLLM dependencies\n- `llamafile` to install Llamafile dependencies\n\n## Quick Start\n\nHere's a simple example to get you started:\n\n```python\nfrom flow_judge import Vllm, Llamafile, Hf, EvalInput, FlowJudge\nfrom flow_judge.metrics import RESPONSE_FAITHFULNESS_5POINT\nfrom IPython.display import Markdown, display\n\n# If you are running on an Ampere GPU or newer, create a model using VLLM\nmodel = Vllm()\n\n# If you have other applications open taking up VRAM, you can use less VRAM by setting gpu_memory_utilization to a lower value.\n# model = Vllm(gpu_memory_utilization=0.70)\n\n# Or if not running on Ampere GPU or newer, create a model using no flash attn and Hugging Face Transformers\n# model = Hf(flash_attn=False)\n\n# Or create a model using Llamafile if not running an Nvidia GPU & running a Silicon MacOS for example\n# model = Llamafile()\n\n# Initialize the judge\nfaithfulness_judge = FlowJudge(\n metric=RESPONSE_FAITHFULNESS_5POINT,\n model=model\n)\n\n# Sample to evaluate\nquery = \"\"\"...\"\"\"\ncontext = \"\"\"...\"\"\"\"\nresponse = \"\"\"...\"\"\"\n\n# Create an EvalInput\n# We want to evaluate the response to the customer issue based on the context and the user instructions\neval_input = EvalInput(\n inputs=[\n {\"query\": query},\n {\"context\": context},\n ],\n output={\"response\": response},\n)\n\n# Run the evaluation\nresult = faithfulness_judge.evaluate(eval_input, save_results=False)\n\n# Display the result\ndisplay(Markdown(f\"__Feedback:__\\n{result.feedback}\\n\\n__Score:__\\n{result.score}\"))\n```\n\n## Usage\n\n### Inference Options\n\nThe library supports multiple inference backends to accommodate different hardware configurations and performance needs:\n\n1. **vLLM**:\n - Best for NVIDIA GPUs with Ampere architecture or newer (e.g., RTX 3000 series, A100, H100)\n - Offers the highest performance and throughput\n - Requires CUDA-compatible GPU\n\n ```python\n from flow_judge import Vllm\n\n model = Vllm()\n ```\n\n2. **Hugging Face Transformers**:\n - Compatible with a wide range of hardware, including older NVIDIA GPUs\n - Supports CPU inference (slower but universally compatible)\n - It is slower than vLLM but generally compatible with more hardware.\n\n If you are running on an Ampere GPU or newer:\n ```python\n from flow_judge import Hf\n\n model = Hf()\n ```\n\n If you are not running on an Ampere GPU or newer, disable flash attention:\n ```python\n from flow_judge import Hf\n\n model = Hf(flash_attn=False)\n ```\n\n3. **Llamafile**:\n - Ideal for non-NVIDIA hardware, including Apple Silicon\n - Provides good performance on CPUs\n - Self-contained, easy to deploy option\n\n ```python\n from flow_judge import Llamafile\n\n model = Llamafile()\n ```\n\nChoose the inference backend that best matches your hardware and performance requirements. The library provides a unified interface for all these options, making it easy to switch between them as needed.\n\n\n### Evaluation Metrics\n\n`Flow-Judge-v0.1` was trained to handle any custom metric that can be expressed as a combination of evaluation criteria and rubric, and required inputs and outputs.\n\n#### Pre-defined Metrics\n\nFor convenience, `flow-judge` library comes with pre-defined metrics such as `RESPONSE_CORRECTNESS` or `RESPONSE_FAITHFULNESS`. You can check the full list by running:\n\n```python\nfrom flow_judge.metrics import list_all_metrics\n\nlist_all_metrics()\n```\n\n### Batched Evaluations\n\nFor efficient processing of multiple inputs, you can use the `batch_evaluate` method:\n\n```python\n# Read the sample data\nimport json\nfrom flow_judge import Vllm, EvalInput, FlowJudge\nfrom flow_judge.metrics import RESPONSE_FAITHFULNESS_5POINT\nfrom IPython.display import Markdown, display\n\n# Initialize the model\nmodel = Vllm()\n\n# Initialize the judge\nfaithfulness_judge = FlowJudge(\n metric=RESPONSE_FAITHFULNESS_5POINT,\n model=model\n)\n\n# Load some sampledata\nwith open(\"sample_data/csr_assistant.json\", \"r\") as f:\n data = json.load(f)\n\n# Create a list of inputs and outputs\ninputs_batch = [\n [\n {\"query\": sample[\"query\"]},\n {\"context\": sample[\"context\"]},\n ]\n for sample in data\n]\noutputs_batch = [{\"response\": sample[\"response\"]} for sample in data]\n\n# Create a list of EvalInput\neval_inputs_batch = [EvalInput(inputs=inputs, output=output) for inputs, output in zip(inputs_batch, outputs_batch)]\n\n# Run the batch evaluation\nresults = faithfulness_judge.batch_evaluate(eval_inputs_batch, save_results=False)\n\n# Visualizing the results\nfor i, result in enumerate(results):\n display(Markdown(f\"__Sample {i+1}:__\"))\n display(Markdown(f\"__Feedback:__\\n{result.feedback}\\n\\n__Score:__\\n{result.score}\"))\n display(Markdown(\"---\"))\n```\n\n## Advanced Usage\n\n> [!WARNING]\n> There exists currently a reported issue with Phi-3 models that produces gibberish outputs with contexts longer than 4096 tokens, including input and output. This issue has been recently fixed in the transformers library so we recommend using the `Hf()` model configuration for longer contexts at the moment. For more details, refer to: [#33129](https://github.com/huggingface/transformers/pull/33129) and [#6135](https://github.com/vllm-project/vllm/issues/6135)\n\n\n### Custom Metrics\n\nCreate your own evaluation metrics:\n\n```python\nfrom flow_judge.metrics import CustomMetric, RubricItem\n\ncustom_metric = CustomMetric(\n name=\"My Custom Metric\",\n criteria=\"Evaluate based on X, Y, and Z.\",\n rubric=[\n RubricItem(score=0, description=\"Poor performance\"),\n RubricItem(score=1, description=\"Good performance\"),\n ],\n required_inputs=[\"query\"],\n required_output=\"response\"\n)\n\njudge = FlowJudge(metric=custom_metric, config=\"Flow-Judge-v0.1-AWQ\")\n```\n\n### Integrations\n\nWe support an integration with Llama Index evaluation module and Haystack:\n- [Llama Index tutorial](https://github.com/flowaicom/flow-judge/blob/main/examples/4_llama_index_evaluators.ipynb)\n- [Haystack tutorial](https://github.com/flowaicom/flow-judge/blob/main/examples/5_evaluate_haystack_rag_pipeline.ipynb)\n\n> Note that we are currently working on adding more integrations with other frameworks in the near future.\n## Development Setup\n\n1. Clone the repository:\n ```bash\n git clone https://github.com/flowaicom/flow-judge.git\n cd flow-judge\n ```\n\n2. Create a virtual environment:\n ```bash\n virtualenv ./.venv\n ```\n or\n\n ```bash\n python -m venv ./.venv\n ```\n\n3. Activate the virtual environment:\n - On Windows:\n ```bash\n venv\\Scripts\\activate\n ```\n - On macOS and Linux:\n ```bash\n source venv/bin/activate\n ```\n\n4. Install the package in editable mode with development dependencies:\n ```bash\n pip install -e \".[dev]\"\n ```\n or\n ```bash\n pip install -e \".[dev,vllm]\"\n ```\n for vLLM support.\n\n5. Set up pre-commit hooks:\n ```bash\n pre-commit install\n ```\n\n6. Run pre-commit on all files:\n ```bash\n pre-commit run --all-files\n ```\n\n7. You're now ready to start developing! You can run the main script with:\n ```bash\n python -m flow_judge\n ```\n\nRemember to always activate your virtual environment when working on the project. To deactivate the virtual environment when you're done, simply run:\n```bash\ndeactivate\n```\n\n## Running Tests\n\nTo run the tests for Flow-Judge, follow these steps:\n\n1. Navigate to the root directory of the project in your terminal.\n\n2. Run the tests using pytest:\n ```bash\n pytest tests/\n ```\n\n This will discover and run all the tests in the `tests/` directory.\n\n3. If you want to run a specific test file, you can do so by specifying the file path:\n ```bash\n pytest tests/test_flow_judge.py\n ```\n\n4. For more verbose output, you can use the `-v` flag:\n ```bash\n pytest -v tests/\n ```\n## Contributing\n\nContributions to `flow-judge` are welcome! Please follow these steps:\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\nPlease ensure that your code adheres to the project's coding standards and passes all tests.\n\n## License\n\nThis project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\nFlow-Judge is developed and maintained by the Flow AI team. We appreciate the contributions and feedback from the AI community in making this tool more robust and versatile.\n",
"bugtrack_url": null,
"license": "Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License. \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\" \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives. Copyright 2024 Flow AI Oy 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. ",
"summary": "A small yet powerful LM Judge",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/flowaicom/flow-judge"
},
"split_keywords": [
"lm-judge",
" evaluation",
" llms",
" ai",
" benchmarking"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "15d6946fb58cc3272b15c3a478b22f64e393ebd4dcdabebde1730b63628243a1",
"md5": "2e374508d9a674d681ffb082f25c5e8e",
"sha256": "a4f2e994ac7b34be8defa69cfbc03c0d1495d467f914b14611ce66ab89c573d2"
},
"downloads": -1,
"filename": "flow_judge-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2e374508d9a674d681ffb082f25c5e8e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 39650,
"upload_time": "2024-10-08T15:04:43",
"upload_time_iso_8601": "2024-10-08T15:04:43.535572Z",
"url": "https://files.pythonhosted.org/packages/15/d6/946fb58cc3272b15c3a478b22f64e393ebd4dcdabebde1730b63628243a1/flow_judge-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "98af4562cf283de5d593d6243c5acff6ac4dda4f79cae5c953adffc9c6e0ed9f",
"md5": "516aacef440dda11d02941a66c1ffa8e",
"sha256": "e6444ce7a2f9c17f90b411272e056436ab8f935c006c8f1bd916aad4f6f6b164"
},
"downloads": -1,
"filename": "flow_judge-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "516aacef440dda11d02941a66c1ffa8e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 285713,
"upload_time": "2024-10-08T15:04:46",
"upload_time_iso_8601": "2024-10-08T15:04:46.433561Z",
"url": "https://files.pythonhosted.org/packages/98/af/4562cf283de5d593d6243c5acff6ac4dda4f79cae5c953adffc9c6e0ed9f/flow_judge-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-08 15:04:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "flowaicom",
"github_project": "flow-judge",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "flow-judge"
}
