From 390994ea5ec7c0ab20a8a6e76ac85b7bb5b6d019 Mon Sep 17 00:00:00 2001
From: Andriy Mulyar <andriy.mulyar@gmail.com>
Date: Wed, 28 Jun 2023 16:24:48 -0400
Subject: [PATCH] Update README.md to include inference example

Signed-off-by: Andriy Mulyar <andriy.mulyar@gmail.com>
---
 gpt4all-api/README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/gpt4all-api/README.md b/gpt4all-api/README.md
index 64804886..ac8af2ad 100644
--- a/gpt4all-api/README.md
+++ b/gpt4all-api/README.md
@@ -43,3 +43,29 @@ localhost:80/docs
 ```
 
 This documentation should match the OpenAI OpenAPI spec located at https://github.com/openai/openai-openapi/blob/master/openapi.yaml
+
+
+#### Running inference
+```python
+import openai
+openai.api_base = "http://localhost:4891/v1"
+
+openai.api_key = "not needed for a local LLM"
+
+
+def test_completion():
+    model = "gpt4all-j-v1.3-groovy"
+    prompt = "Who is Michael Jordan?"
+    response = openai.Completion.create(
+        model=model,
+        prompt=prompt,
+        max_tokens=50,
+        temperature=0.28,
+        top_p=0.95,
+        n=1,
+        echo=True,
+        stream=False
+    )
+    assert len(response['choices'][0]['text']) > len(prompt)
+    print(response)
+```