From 32a839baa03c22390f9cd5aec4aa1e4adc9d8bfc Mon Sep 17 00:00:00 2001 From: Steve Phelps Date: Mon, 13 Nov 2023 10:09:25 +0000 Subject: [PATCH] Update README.md --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f69604f..1e6e759 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,12 @@ ![GitHub release (latest by date)](https://img.shields.io/github/v/release/phelps-sg/openai-pygenerator) ![GitHub](https://img.shields.io/github/license/phelps-sg/openai-pygenerator?color=blue) -This is a simple type-annotated wrapper around the OpenAI Python API which provides retry functionality, reduces the default timeout from 10 minutes to 20 seconds (configurable), and provides a generator over completions. In addition to providing a simple class to manage chat session state, it can also be used to chain together completions from different prompts in a very straightforward [functional-programming](https://docs.python.org/3/howto/functional.html) style using [Python generators](https://docs.python.org/3/howto/functional.html#generators). +This is a simple type-annotated wrapper around the OpenAI Python API which provides: +- retry functionality, +- reduces the default timeout from 10 minutes to 20 seconds (configurable), and +- provides a generator over completions. + +In addition to providing a simple class to manage chat session state, it can also be used to chain together completions from different prompts in a very straightforward [functional-programming](https://docs.python.org/3/howto/functional.html) style using [Python generators](https://docs.python.org/3/howto/functional.html#generators). ## Installation