diff --git a/README.md b/README.md index 3ebca145..e119fcc8 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,52 @@ Powered by BentoML 🍱 + HuggingFace 🤗
+ +To get started, simply install OpenLLM with pip: + +```bash +pip install openllm +``` + +> NOTE: Currently, OpenLLM is built with pydantic v2. At the time of writing, +> Pydantic v2 is still in alpha stage. To get pydantic v2, do +> `pip install -U --pre pydantic` + +To start a LLM server, `openllm start` allows you to start any supported LLM +with a single command. For example, to start a `dolly-v2` server: + +```bash +openllm start dolly-v2 + +# Starting LLM Server for 'dolly_v2' +# +# 2023-05-27T04:55:36-0700 [INFO] [cli] Environ for worker 0: set CPU thread coun t to 10 +# 2023-05-27T04:55:36-0700 [INFO] [cli] Prometheus metrics for HTTP BentoServer f rom "_service.py:svc" can be accessed at http://localhost:3000/metrics. +# 2023-05-27T04:55:36-0700 [INFO] [cli] Starting production HTTP BentoServer from "_service.py:svc" listening on http://0.0.0.0:3000 (Press CTRL+C to quit) +``` + +To see a list of supported LLMs, run `openllm start --help`. + +On a different terminal window, open a IPython session and create a client to +start interacting with the model: + +```python +>>> import openllm +>>> client = openllm.client.HTTPClient('http://localhost:3000') +>>> client.query('Explain to me the difference between "further" and "farther"') +``` + +To package the LLM into a Bento, simply use `openllm build`: + +```bash +openllm build dolly-v2 +``` + +🎯 To streamline production deployment, you can use the following: + +- [☁️ BentoML Cloud](https://l.bentoml.com/bento-cloud): the fastest way to + deploy your bento, simple and at scale +- [🦄️ Yatai](https://github.com/bentoml/yatai): Model Deployment at scale on + Kubernetes +- [🚀 bentoctl](https://github.com/bentoml/bentoctl): Fast model deployment on + AWS SageMaker, Lambda, ECE, GCP, Azure, Heroku, and more! diff --git a/yarn.lock b/yarn.lock deleted file mode 100644 index 71cfa40a..00000000 --- a/yarn.lock +++ /dev/null @@ -1,55 +0,0 @@ -# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. -# yarn lockfile v1 - - -pyright@^1.1.306: - version "1.1.306" - resolved "https://registry.npmjs.org/pyright/-/pyright-1.1.306.tgz" - integrity sha512-2OdV1XyYZMTjGY5deOBZGaHkBuAqTR13DvwlIXFQUTx1ZSxOkCsfibOlIy1ydpDnUY2aaweaXe39clthIipnrg== - -turbo-darwin-64@1.9.3: - version "1.9.3" - resolved "https://registry.yarnpkg.com/turbo-darwin-64/-/turbo-darwin-64-1.9.3.tgz#29470b902a1418dae8a88b2620caf917b27480bc" - integrity sha512-0dFc2cWXl82kRE4Z+QqPHhbEFEpUZho1msHXHWbz5+PqLxn8FY0lEVOHkq5tgKNNEd5KnGyj33gC/bHhpZOk5g== - -turbo-darwin-arm64@1.9.3: - version "1.9.3" - resolved "https://registry.npmjs.org/turbo-darwin-arm64/-/turbo-darwin-arm64-1.9.3.tgz" - integrity sha512-1cYbjqLBA2zYE1nbf/qVnEkrHa4PkJJbLo7hnuMuGM0bPzh4+AnTNe98gELhqI1mkTWBu/XAEeF5u6dgz0jLNA== - -turbo-linux-64@1.9.3: - version "1.9.3" - resolved "https://registry.yarnpkg.com/turbo-linux-64/-/turbo-linux-64-1.9.3.tgz#dbce8fd50edee1319f17800ee38e7c4749ab0cb0" - integrity sha512-UuBPFefawEwpuxh5pM9Jqq3q4C8M0vYxVYlB3qea/nHQ80pxYq7ZcaLGEpb10SGnr3oMUUs1zZvkXWDNKCJb8Q== - -turbo-linux-arm64@1.9.3: - version "1.9.3" - resolved "https://registry.yarnpkg.com/turbo-linux-arm64/-/turbo-linux-arm64-1.9.3.tgz#636b77fde17c7a5cdef8a20616ff57f08c785345" - integrity sha512-vUrNGa3hyDtRh9W0MkO+l1dzP8Co2gKnOVmlJQW0hdpOlWlIh22nHNGGlICg+xFa2f9j4PbQlWTsc22c019s8Q== - -turbo-windows-64@1.9.3: - version "1.9.3" - resolved "https://registry.yarnpkg.com/turbo-windows-64/-/turbo-windows-64-1.9.3.tgz#c65625c222456161b0b4d000ec7f50e372332825" - integrity sha512-0BZ7YaHs6r+K4ksqWus1GKK3W45DuDqlmfjm/yuUbTEVc8szmMCs12vugU2Zi5GdrdJSYfoKfEJ/PeegSLIQGQ== - -turbo-windows-arm64@1.9.3: - version "1.9.3" - resolved "https://registry.yarnpkg.com/turbo-windows-arm64/-/turbo-windows-arm64-1.9.3.tgz#86e105692ad6ba935eff0284522bdf7728a2e517" - integrity sha512-QJUYLSsxdXOsR1TquiOmLdAgtYcQ/RuSRpScGvnZb1hY0oLc7JWU0llkYB81wVtWs469y8H9O0cxbKwCZGR4RQ== - -turbo@^1.9.3: - version "1.9.3" - resolved "https://registry.npmjs.org/turbo/-/turbo-1.9.3.tgz" - integrity sha512-ID7mxmaLUPKG/hVkp+h0VuucB1U99RPCJD9cEuSEOdIPoSIuomcIClEJtKamUsdPLhLCud+BvapBNnhgh58Nzw== - optionalDependencies: - turbo-darwin-64 "1.9.3" - turbo-darwin-arm64 "1.9.3" - turbo-linux-64 "1.9.3" - turbo-linux-arm64 "1.9.3" - turbo-windows-64 "1.9.3" - turbo-windows-arm64 "1.9.3" - -typescript@^5.0.4: - version "5.0.4" - resolved "https://registry.npmjs.org/typescript/-/typescript-5.0.4.tgz" - integrity sha512-cW9T5W9xY37cc+jfEnaUvX91foxtHkza3Nw3wkoF4sSlKn0MONdkdEndig/qPBWXNkmplh3NzayQzCiHM4/hqw==