optillm 0.0.2__tar.gz

optillm-0.0.2/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.

optillm-0.0.2/PKG-INFO

@@ -0,0 +1,326 @@
+Metadata-Version: 2.1
+Name: optillm
+Version: 0.0.2
+Summary: An optimizing inference proxy for LLMs.
+Home-page: https://github.com/codelion/optillm
+Author: codelion
+Author-email: codelion@okyasoft.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: networkx
+Requires-Dist: openai
+Requires-Dist: z3-solver
+Requires-Dist: aiohttp
+Requires-Dist: flask
+Requires-Dist: torch
+Requires-Dist: transformers
+Requires-Dist: azure-identity
+Requires-Dist: tiktoken
+Requires-Dist: scikit-learn
+Requires-Dist: litellm
+Requires-Dist: requests
+Requires-Dist: beautifulsoup4
+Requires-Dist: lxml
+Requires-Dist: presidio_analyzer
+Requires-Dist: presidio_anonymizer
+Requires-Dist: nbconvert
+Requires-Dist: nbformat
+Requires-Dist: ipython
+Requires-Dist: ipykernel
+
+# optillm
+
+optillm is an OpenAI API compatible optimizing inference proxy which implements several state-of-the-art techniques that can improve the accuracy and performance of LLMs. The current focus is on implementing techniques that improve reasoning over coding, logical and mathematical queries. It is possible to beat the frontier models using these techniques across diverse tasks by doing additional compute at inference time.
+
+[![Open in Spaces](https://huggingface.co/datasets/huggingface/badges/resolve/main/open-in-hf-spaces-sm.svg)](https://huggingface.co/spaces/codelion/optillm)
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1SpuUb8d9xAoTh32M-9wJsB50AOH54EaH?usp=sharing)
+[![GitHub Discussions](https://img.shields.io/github/discussions/codelion/optillm)](https://github.com/codelion/optillm/discussions)
+
+## Installation
+
+Clone the repository with `git` and use `pip install` to setup the dependencies.
+
+```bash
+git clone https://github.com/codelion/optillm.git
+cd optillm
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+```
+
+Set up the `OPENAI_API_KEY` environment variable (for OpenAI) 
+or the `AZURE_OPENAI_API_KEY`, `AZURE_API_VERSION` and `AZURE_API_BASE` environment variables (for Azure OpenAI)
+or the `AZURE_API_VERSION` and `AZURE_API_BASE` environment variables and login using `az login` for Azure OpenAI with managed identity (see [here](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/managed-identity)).
+
+You can then run the optillm proxy as follows.
+
+```bash
+python optillm.py
+2024-09-06 07:57:14,191 - INFO - Starting server with approach: auto
+2024-09-06 07:57:14,191 - INFO - Server configuration: {'approach': 'auto', 'mcts_simulations': 2, 'mcts_exploration': 0.2, 'mcts_depth': 1, 'best_of_n': 3, 'model': 'gpt-4o-mini', 'rstar_max_depth': 3, 'rstar_num_rollouts': 5, 'rstar_c': 1.4, 'base_url': ''}
+ * Serving Flask app 'optillm'
+ * Debug mode: off
+2024-09-06 07:57:14,212 - INFO - WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead.
+ * Running on all addresses (0.0.0.0)
+ * Running on http://127.0.0.1:8000
+ * Running on http://192.168.10.48:8000
+2024-09-06 07:57:14,212 - INFO - Press CTRL+C to quit
+```
+
+### Starting the optillm proxy for a local server (e.g. llama.cpp)
+
+- Set the `OPENAI_API_KEY` env variable to a placeholder value
+  - e.g. `export OPENAI_API_KEY="no_key"`
+- Run `./llama-server -c 4096 -m path_to_model` to start the server with the specified model and a context length of 4096 tokens
+- Run `python3 optillm.py --base_url base_url` to start the proxy
+  - e.g. for llama.cpp, run `python3 optillm.py --base_url http://localhost:8080/v1`
+
+> [!WARNING]
+> Note that llama-server currently does not support sampling multiple responses from a model, which limits the available approaches to the following:
+> `cot_reflection`, `leap`, `plansearch`, `rstar`, `rto`, `self_consistency`, `re2`, and `z3`.
+
+> [!NOTE]
+> You'll later need to specify a model name in the OpenAI client configuration. Since llama-server was started with a single model, you can choose any name you want.
+
+## Usage
+
+Once the proxy is running, you can use it as a drop in replacement for an OpenAI client by setting the `base_url` as `http://localhost:8000/v1`.
+
+```python
+import os
+from openai import OpenAI
+
+OPENAI_KEY = os.environ.get("OPENAI_API_KEY")
+OPENAI_BASE_URL = "http://localhost:8000/v1"
+client = OpenAI(api_key=OPENAI_KEY, base_url=OPENAI_BASE_URL)
+
+response = client.chat.completions.create(
+  model="moa-gpt-4o",
+  messages=[
+    {
+      "role": "user",
+      "content": "Write a Python program to build an RL model to recite text from any position that the user provides, using only numpy."
+    }
+  ],
+  temperature=0.2
+)
+
+print(response)
+```
+The code above applies to both OpenAI and Azure OpenAI, just remember to populate the `OPENAI_API_KEY` env variable with the proper key. 
+There are multiple ways to control the optimization techniques, they are applied in the follow order of preference:
+
+- You can control the technique you use for optimization by prepending the slug to the model name `{slug}-model-name`. E.g. in the above code we are using `moa` or mixture of agents as the optimization approach. In the proxy logs you will see the following showing the `moa` is been used with the base model as `gpt-4o-mini`.
+
+```bash
+2024-09-06 08:35:32,597 - INFO - Using approach moa, with gpt-4o-mini
+2024-09-06 08:35:35,358 - INFO - HTTP Request: POST https://api.openai.com/v1/chat/completions "HTTP/1.1 200 OK"
+2024-09-06 08:35:39,553 - INFO - HTTP Request: POST https://api.openai.com/v1/chat/completions "HTTP/1.1 200 OK"
+2024-09-06 08:35:44,795 - INFO - HTTP Request: POST https://api.openai.com/v1/chat/completions "HTTP/1.1 200 OK"
+2024-09-06 08:35:44,797 - INFO - 127.0.0.1 - - [06/Sep/2024 08:35:44] "POST /v1/chat/completions HTTP/1.1" 200 -
+```
+
+- Or, you can pass the slug in the `optillm_approach` field in the `extra_body`.
+
+```bash
+response = client.chat.completions.create(
+  model="gpt-4o-mini",
+  messages=[{ "role": "user","content": "" }],
+  temperature=0.2,
+  extra_body={"optillm_approach": "bon|moa|mcts"}
+)
+```
+- Or, you can just mention the approach in either your `system` or `user` prompt, within `<optillm_approach> </optillm_approach>` tags.
+
+```bash
+response = client.chat.completions.create(
+  model="gpt-4o-mini",
+  messages=[{ "role": "user","content": "<optillm_approach>re2</optillm_approach> How many r's are there in strawberry?" }],
+  temperature=0.2
+)
+```
+
+> [!TIP]
+> You can also combine different techniques either by using symbols `&` and `|`. When you use `&` the techniques are processed in the order from left to right in a pipeline
+> with response from previous stage used as request to the next. While, with `|` we run all the requests in parallel and generate multiple responses that are returned as a list.
+
+Please note that the convention described above works only when the optillm server has been started with inference approach set to `auto`. Otherwise, the `model` attribute in the client request must be set with the model name only.  
+
+We now suport all LLM providers (by wrapping around the [LiteLLM sdk](https://docs.litellm.ai/docs/#litellm-python-sdk)). E.g. you can use the Gemini Flash model with `moa` by setting passing the api key in the environment variable `os.environ['GEMINI_API_KEY']` and then calling the model `moa-gemini/gemini-1.5-flash-002`. In the output you will then see that LiteLLM is being used to call the base model.
+
+```bash
+9:43:21 - LiteLLM:INFO: utils.py:2952 - 
+LiteLLM completion() model= gemini-1.5-flash-002; provider = gemini
+2024-09-29 19:43:21,011 - INFO - 
+LiteLLM completion() model= gemini-1.5-flash-002; provider = gemini
+2024-09-29 19:43:21,481 - INFO - HTTP Request: POST https://generativelanguage.googleapis.com/v1beta/models/gemini-1.5-flash-002:generateContent?key=[redacted] "HTTP/1.1 200 OK"
+19:43:21 - LiteLLM:INFO: utils.py:988 - Wrapper: Completed Call, calling success_handler
+2024-09-29 19:43:21,483 - INFO - Wrapper: Completed Call, calling success_handler
+19:43:21 - LiteLLM:INFO: utils.py:2952 - 
+LiteLLM completion() model= gemini-1.5-flash-002; provider = gemini
+```
+
+> [!TIP]
+> optillm is a transparent proxy and will work with any LLM API or provider that has an OpenAI API compatible chat completions endpoint, and in turn, optillm also exposes 
+the same OpenAI API compatible chat completions endpoint. This should allow you to integrate it into any existing tools or frameworks easily. If the LLM you want to use
+doesn't have an OpenAI API compatible endpoint (like Google or Anthropic) you can use [LiteLLM proxy server](https://docs.litellm.ai/docs/proxy/quick_start) that supports most LLMs.
+
+The following sequence diagram illustrates how the request and responses go through optillm. 
+
+![Sequance diagram showing optillm in use](./optillm-sequence-diagram.png)
+
+In the diagram:
+- `A` is an existing tool (like [oobabooga](https://github.com/oobabooga/text-generation-webui/)), framework (like [patchwork](https://github.com/patched-codes/patchwork))
+or your own code where you want to use the results from optillm. You can use it directly using any OpenAI client sdk.
+- `B` is the optillm service (running directly or in a docker container) that will send requests to the `base_url`.
+- `C` is any service providing an OpenAI API compatible chat completions endpoint. 
+
+## Implemented techniques
+
+| Approach                | Slug               | Description                                                                                    |
+| ----------------------- | ------------------ | ---------------------------------------------------------------------------------------------- |
+| CoT with Reflection     | `cot_reflection`   | Implements chain-of-thought reasoning with \<thinking\>, \<reflection> and \<output\> sections |
+| PlanSearch              | `plansearch`       | Implements a search algorithm over candidate plans for solving a problem in natural language   |
+| ReRead                  | `re2`              | Implements rereading to improve reasoning by processing queries twice                          |
+| Self-Consistency        | `self_consistency` | Implements an advanced self-consistency method                                                 |
+| Z3 Solver               | `z3`               | Utilizes the Z3 theorem prover for logical reasoning                                           |
+| R* Algorithm            | `rstar`            | Implements the R* algorithm for problem-solving                                                |
+| LEAP                    | `leap`             | Learns task-specific principles from few shot examples                                         |
+| Round Trip Optimization | `rto`              | Optimizes responses through a round-trip process                                               |
+| Best of N Sampling      | `bon`              | Generates multiple responses and selects the best one                                          |
+| Mixture of Agents       | `moa`              | Combines responses from multiple critiques                                                     |
+| Monte Carlo Tree Search | `mcts`             | Uses MCTS for decision-making in chat responses                                                |
+| PV Game                 | `pvg`              | Applies a prover-verifier game approach at inference time                                      |
+| CoT Decoding            |  N/A for proxy     | Implements chain-of-thought decoding to elicit reasoning without explicit prompting            |
+| Entropy Decoding        |  N/A for proxy     | Implements adaptive sampling based on the uncertainy of tokens during generation               |
+
+## Implemented plugins
+
+| Plugin                  | Slug               | Description                                                                                    |
+| ----------------------- | ------------------ | ---------------------------------------------------------------------------------------------- |
+| Memory                  | `memory`           | Implements a short term memory layer, enables you to use unbounded context length with any LLM |
+| Privacy                 | `privacy`          | Anonymize PII data in request and deanonymize it back to original value in response            |
+| Read URLs               | `readurls`         | Reads all URLs found in the request, fetches the content at the URL and adds it to the context |
+| Execute Code            | `executecode`      | Enables use of code interpreter to execute python code in requests and LLM generated responses |
+
+## Available parameters
+
+optillm supports various command-line arguments and environment variables for configuration.
+
+| Parameter                | Description                                                     | Default Value   |
+|--------------------------|-----------------------------------------------------------------|-----------------|
+| `--approach`             | Inference approach to use                                       | `"auto"`        |
+| `--simulations`          | Number of MCTS simulations                                      | 2               |
+| `--exploration`          | Exploration weight for MCTS                                     | 0.2             |
+| `--depth`                | Simulation depth for MCTS                                       | 1               |
+| `--best-of-n`            | Number of samples for best_of_n approach                        | 3               |
+| `--model`                | OpenAI model to use                                             | `"gpt-4o-mini"` |
+| `--base-url`             | Base URL for OpenAI compatible endpoint                         | `""`            |
+| `--rstar-max-depth`      | Maximum depth for rStar algorithm                               | 3               |
+| `--rstar-num-rollouts`   | Number of rollouts for rStar algorithm                          | 5               |
+| `--rstar-c`              | Exploration constant for rStar algorithm                        | 1.4             |
+| `--n`                    | Number of final responses to be returned                        | 1               |
+| `--return-full-response` | Return the full response including the CoT with <thinking> tags | `False`         |
+| `--port`                 | Specify the port to run the proxy                               | 8000            |
+| `--optillm-api-key`      | Optional API key for client authentication to optillm           | `""`            |
+
+When using Docker, these can be set as environment variables prefixed with `OPTILLM_`.
+
+## Running with Docker
+
+optillm can optionally be built and run using Docker and the provided [Dockerfile](./Dockerfile).
+
+### Using Docker Compose
+
+1. Make sure you have Docker and Docker Compose installed on your system.
+
+2. Either update the environment variables in the docker-compose.yaml file or create a `.env` file in the project root directory and add any environment variables you want to set. For example, to set the OpenAI API key, add the following line to the `.env` file:
+
+   ```bash
+   OPENAI_API_KEY=your_openai_api_key_here
+   ```
+
+3. Run the following command to start optillm:
+
+   ```bash
+   docker compose up -d
+   ```
+
+   This will build the Docker image if it doesn't exist and start the optillm service.
+
+4. optillm will be available at `http://localhost:8000`.
+
+When using Docker, you can set these parameters as environment variables. For example, to set the approach and model, you would use:
+
+```bash
+OPTILLM_APPROACH=mcts
+OPTILLM_MODEL=gpt-4
+```
+
+To secure the optillm proxy with an API key, set the `OPTILLM_API_KEY` environment variable:
+
+```bash
+OPTILLM_API_KEY=your_secret_api_key
+```
+
+When the API key is set, clients must include it in their requests using the `Authorization` header:
+
+```plain
+Authorization: Bearer your_secret_api_key
+```
+## SOTA results on benchmarks with optillm
+
+### readurls&memory-gpt-4o-mini on Google FRAMES Benchmark (Oct 2024)
+| Model | Accuracy | 
+| ----- | -------- |
+| readlurls&memory-gpt-4o-mini | 65.66 | 
+| gpt-4o-mini | 50.0 |
+| readlurls&memory-Gemma2-9b | 30.1 |
+| Gemma2-9b | 5.1 |
+| Gemma2-27b | 30.8 |
+| Gemini Flash 1.5 | 66.5 |
+| Gemini Pro 1.5 | 72.9 |
+
+### plansearch-gpt-4o-mini on LiveCodeBench (Sep 2024)
+
+| Model                  | pass@1 | pass@5 | pass@10 |
+| ---------------------- | ------ | ------ | ------- |
+| plansearch-gpt-4o-mini | 44.03  | 59.31  | 63.5    |
+| gpt-4o-mini            | 43.9   | 50.61  | 53.25   |
+| claude-3.5-sonnet      | 51.3   |        |         |
+| gpt-4o-2024-05-13      | 45.2   |        |         |
+| gpt-4-turbo-2024-04-09 | 44.2   |        |         |
+
+### moa-gpt-4o-mini on Arena-Hard-Auto (Aug 2024)
+
+![Results showing Mixture of Agents approach using gpt-4o-mini on Arena Hard Auto Benchmark](./moa-results.png)
+
+### optillm with Patchwork (July 2024)
+
+Since optillm is a drop-in replacement for OpenAI API you can easily integrate it with existing tools and frameworks using the OpenAI client. We used optillm with [patchwork](https://github.com/patched-codes/patchwork) which is an open-source framework that automates development gruntwork like PR reviews, bug fixing, security patching using workflows
+called patchflows. We saw huge performance gains across all the supported patchflows as shown below when using the mixutre of agents approach (moa). 
+
+![Results showing optillm mixture of agents approach used with patchflows](./moa-patchwork-results.png)
+
+## References
+
+- [Entropy Based Sampling and Parallel CoT Decoding](https://github.com/xjdr-alt/entropix) - [Implementation](https://github.com/codelion/optillm/blob/main/optillm/entropy_decoding.py)
+- [Fact, Fetch, and Reason: A Unified Evaluation of Retrieval-Augmented Generation](https://arxiv.org/abs/2409.12941) - [Evaluation script](https://github.com/codelion/optillm/blob/main/scripts/eval_frames_benchmark.py)
+- [Writing in the Margins: Better Inference Pattern for Long Context Retrieval](https://www.arxiv.org/abs/2408.14906) - [Inspired the implementation of the memory plugin](https://github.com/codelion/optillm/blob/main/optillm/plugins/memory_plugin.py)
+- [Chain-of-Thought Reasoning Without Prompting](https://arxiv.org/abs/2402.10200) - [Implementation](https://github.com/codelion/optillm/blob/main/optillm/cot_decoding.py)
+- [Re-Reading Improves Reasoning in Large Language Models](https://arxiv.org/abs/2309.06275) - [Implementation](https://github.com/codelion/optillm/blob/main/optillm/reread.py)
+- [In-Context Principle Learning from Mistakes](https://arxiv.org/abs/2402.05403) - [Implementation](https://github.com/codelion/optillm/blob/main/optillm/leap.py)
+- [Planning In Natural Language Improves LLM Search For Code Generation](https://arxiv.org/abs/2409.03733) - [Implementation](https://github.com/codelion/optillm/blob/main/optillm/plansearch.py)
+- [Self-Consistency Improves Chain of Thought Reasoning in Language Models](https://arxiv.org/abs/2203.11171) - [Implementation](https://github.com/codelion/optillm/blob/main/optillm/self_consistency.py)
+- [Mutual Reasoning Makes Smaller LLMs Stronger Problem-Solvers](https://arxiv.org/abs/2408.06195) - [Implementation](https://github.com/codelion/optillm/blob/main/optillm/rstar.py)
+- [Mixture-of-Agents Enhances Large Language Model Capabilities](https://arxiv.org/abs/2406.04692) - [Inspired the implementation of moa](https://github.com/codelion/optillm/blob/main/optillm/moa.py)
+- [Prover-Verifier Games improve legibility of LLM outputs](https://arxiv.org/abs/2407.13692) - [Implementation](https://github.com/codelion/optillm/blob/main/optillm/pvg.py)
+- [Monte Carlo Tree Search Boosts Reasoning via Iterative Preference Learning](https://arxiv.org/abs/2405.00451) - [Inspired the implementation of mcts](https://github.com/codelion/optillm/blob/main/optillm/mcts.py)
+- [Unsupervised Evaluation of Code LLMs with Round-Trip Correctness](https://arxiv.org/abs/2402.08699) - [Inspired the implementation of rto](https://github.com/codelion/optillm/blob/main/optillm/rto.py)
+- [Patched MOA: optimizing inference for diverse software development tasks](https://arxiv.org/abs/2407.18521) - [Implementation](https://github.com/codelion/optillm/blob/main/optillm/moa.py)
+- [Patched RTC: evaluating LLMs for diverse software development tasks](https://arxiv.org/abs/2407.16557) - [Implementation](https://github.com/codelion/optillm/blob/main/optillm/rto.py)