From dbdcb35a71f761e1e184a9389657057346fd2e85 Mon Sep 17 00:00:00 2001 From: Arjan Mossel Date: Wed, 15 May 2024 21:07:55 +0200 Subject: [PATCH] Initial commit --- .github/workflows/publish.yml | 52 +++++++++ .github/workflows/test.yml | 28 +++++ .gitignore | 12 ++ LICENSE | 201 ++++++++++++++++++++++++++++++++++ README.md | 51 +++++++++ llm_vertex.py | 94 ++++++++++++++++ pyproject.toml | 27 +++++ tests/test_vertex.py | 6 + 8 files changed, 471 insertions(+) create mode 100644 .github/workflows/publish.yml create mode 100644 .github/workflows/test.yml create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 llm_vertex.py create mode 100644 pyproject.toml create mode 100644 tests/test_vertex.py diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..9a56cea --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,52 @@ +name: Publish Python Package + +on: + release: + types: [created] + +permissions: + contents: read + +jobs: + test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] + steps: + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + cache: pip + cache-dependency-path: pyproject.toml + - name: Install dependencies + run: | + pip install -e '.[test]' + - name: Run tests + run: | + pytest + deploy: + runs-on: ubuntu-latest + needs: [test] + environment: release + permissions: + id-token: write + steps: + - uses: actions/checkout@v4 + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.12" + cache: pip + cache-dependency-path: pyproject.toml + - name: Install dependencies + run: | + pip install setuptools wheel build + - name: Build + run: | + python -m build + - name: Publish + uses: pypa/gh-action-pypi-publish@release/v1 + diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..5142287 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,28 @@ +name: Test + +on: [push, pull_request] + +permissions: + contents: read + +jobs: + test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] + steps: + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + cache: pip + cache-dependency-path: pyproject.toml + - name: Install dependencies + run: | + pip install -e '.[test]' + - name: Run tests + run: | + pytest + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e61ce1d --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +.venv +__pycache__/ +*.py[cod] +*$py.class +venv +.eggs +.pytest_cache +*.egg-info +.DS_Store +.vscode +dist +build diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7700169 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# llm-vertex + +[![PyPI](https://img.shields.io/pypi/v/llm-vertex.svg)](https://pypi.org/project/llm-vertex/) +[![Changelog](https://img.shields.io/github/v/release/ar-jan/llm-vertex?include_prereleases&label=changelog)](https://github.com/ar-jan/llm-vertex/releases) +[![Tests](https://github.com/ar-jan/llm-vertex/actions/workflows/test.yml/badge.svg)](https://github.com/ar-jan/llm-vertex/actions/workflows/test.yml) +[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/ar-jan/llm-vertex/blob/main/LICENSE) + +LLM plugin to access Google Vertex AI. + +## Installation + +Install this plugin in the same environment as [LLM](https://llm.datasette.io/). +```bash +llm install llm-vertex +``` +## Usage + +### Set up Vertex AI + +You will need a project id and an access token. The easiest way to get these seems to be to setup the gcloud CLI. + +To display the access token, run: `gcloud auth print-access-token`. + + +### Run + +Use the access token as llm key: + +`llm keys set vertex` + +Provide LLM_VERTEX_LOCATION and LLM_VERTEX_PROJECT_ID in your environment, e.g.: + +`LLM_VERTEX_LOCATION=europe-west4 LLM_VERTEX_PROJECT_ID=yourprojectid-1234` + + +## Development + +To set up this plugin locally, first checkout the code. Then create a new virtual environment: +```bash +cd llm-vertex +python3 -m venv venv +source venv/bin/activate +``` +Now install the dependencies and test dependencies: +```bash +llm install -e '.[test]' +``` +To run the tests: +```bash +pytest +``` diff --git a/llm_vertex.py b/llm_vertex.py new file mode 100644 index 0000000..f9fd4a1 --- /dev/null +++ b/llm_vertex.py @@ -0,0 +1,94 @@ +import httpx +import ijson +import llm +import os +import urllib.parse + + +SAFETY_SETTINGS = [ + { + "category": "HARM_CATEGORY_DANGEROUS_CONTENT", + "threshold": "BLOCK_NONE", + }, + { + "category": "HARM_CATEGORY_SEXUALLY_EXPLICIT", + "threshold": "BLOCK_NONE", + }, + { + "category": "HARM_CATEGORY_HATE_SPEECH", + "threshold": "BLOCK_NONE", + }, + { + "category": "HARM_CATEGORY_HARASSMENT", + "threshold": "BLOCK_NONE", + }, +] + + +@llm.hookimpl +def register_models(register): + register(VertexAI("gemini-1.5-flash-preview-0514")) + register(VertexAI("gemini-1.5-pro-preview-0514")) + register(VertexAI("gemini-1.0-pro")) + + +class VertexAI(llm.Model): + can_stream = True + + def __init__(self, model_id): + self.model_id = model_id + self.location = os.environ.get("LLM_VERTEX_LOCATION", "us-central1") + self.project_id = os.environ.get("LLM_VERTEX_PROJECT_ID") + + def build_messages(self, prompt, conversation): + if not conversation: + return [{"role": "user", "parts": [{"text": prompt.prompt}]}] + messages = [] + for response in conversation.responses: + messages.append( + {"role": "user", "parts": [{"text": response.prompt.prompt}]} + ) + messages.append({"role": "model", "parts": [{"text": response.text()}]}) + messages.append({"role": "user", "parts": [{"text": prompt.prompt}]}) + return messages + + def execute(self, prompt, stream, response, conversation): + access_token = llm.get_key("", "vertex", "VERTEX_ACCESS_TOKEN") + url = "https://{LOCATION}-aiplatform.googleapis.com/v1/projects/{PROJECT_ID}/locations/{LOCATION}/publishers/google/models/{MODEL_ID}:streamGenerateContent".format( + MODEL_ID=self.model_id, + LOCATION=self.location, + PROJECT_ID=self.project_id + ) + headers = { + "Authorization": f"Bearer {access_token}", + "Content-Type": "application/json" + } + gathered = [] + body = { + "contents": self.build_messages(prompt, conversation), + "safetySettings": SAFETY_SETTINGS, + } + if prompt.system: + body["system_instructions"] = {"parts": [{"text": prompt.system}]} + with httpx.stream( + "POST", + url, + headers=headers, + timeout=None, + json=body, + ) as http_response: + events = ijson.sendable_list() + coro = ijson.items_coro(events, "item") + for chunk in http_response.iter_bytes(): + coro.send(chunk) + if events: + event = events[0] + if isinstance(event, dict) and "error" in event: + raise llm.ModelError(event["error"]["message"]) + try: + yield event["candidates"][0]["content"]["parts"][0]["text"] + except KeyError: + yield "" + gathered.append(event) + events.clear() + response.response_json = gathered diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..2065e66 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,27 @@ +[project] +name = "llm-vertex" +version = "0.0.1" +description = "LLM plugin to access Google Vertex AI" +readme = "README.md" +authors = [{name = "Arjan Mossel"}] +license = {text = "Apache-2.0"} +classifiers = [ + "License :: OSI Approved :: Apache Software License" +] +dependencies = [ + "httpx", + "ijson", + "llm", +] + +[project.urls] +Homepage = "https://github.com/ar-jan/llm-vertex" +Changelog = "https://github.com/ar-jan/llm-vertex/releases" +Issues = "https://github.com/ar-jan/llm-vertex/issues" +CI = "https://github.com/ar-jan/llm-vertex/actions" + +[project.entry-points.llm] +vertex = "llm_vertex" + +[project.optional-dependencies] +test = ["pytest"] diff --git a/tests/test_vertex.py b/tests/test_vertex.py new file mode 100644 index 0000000..974f924 --- /dev/null +++ b/tests/test_vertex.py @@ -0,0 +1,6 @@ +from llm.plugins import pm + + +def test_plugin_is_installed(): + names = [mod.__name__ for mod in pm.get_plugins()] + assert "llm_vertex" in names