From ec48310da4ca2a0439e1c7b9130e006d33ef4325 Mon Sep 17 00:00:00 2001
From: Rahul Behal <rahulbehal01@hotmail.com>
Date: Wed, 12 Apr 2023 09:18:27 -0700
Subject: [PATCH] Add READMEs for 5 utility chains (#27)

---
 chains/llm-bash/README.md     | 13 +++++++++++++
 chains/llm-checker/README.md  | 13 +++++++++++++
 chains/llm-math/README.md     | 14 ++++++++++++++
 chains/llm-requests/README.md | 14 ++++++++++++++
 chains/pal/math/README.md     | 13 +++++++++++++
 5 files changed, 67 insertions(+)
 create mode 100644 chains/llm-bash/README.md
 create mode 100644 chains/llm-checker/README.md
 create mode 100644 chains/llm-math/README.md
 create mode 100644 chains/llm-requests/README.md
 create mode 100644 chains/pal/math/README.md

diff --git a/chains/llm-bash/README.md b/chains/llm-bash/README.md
new file mode 100644
index 0000000..512e3a7
--- /dev/null
+++ b/chains/llm-bash/README.md
@@ -0,0 +1,13 @@
+# BashChain
+
+## Description
+
+The LLMBashChain takes in a task to perform and generates a series of bash commands that will perform the task.
+
+## Chain type
+
+LLMBashChain
+
+## Input Variables
+
+question: a question about how to perform a task in bash.
\ No newline at end of file
diff --git a/chains/llm-checker/README.md b/chains/llm-checker/README.md
new file mode 100644
index 0000000..3826a7a
--- /dev/null
+++ b/chains/llm-checker/README.md
@@ -0,0 +1,13 @@
+# LLMCheckerChain
+
+## Description
+
+The LLMCheckerChain is designed to generate better answers to factual questions. The chain works by first generating a draft answer based on the question. The model is then asked to list its assumptions for this statement. The model is then asked to determine whether each assertion is true or false, and explain why if it is false. Finally, the model is prompted to revise their answer based on the above checks and assertions.
+
+## Chain type
+
+LLMCheckerChain
+
+## Input Variables
+
+question: the question to answer
\ No newline at end of file
diff --git a/chains/llm-math/README.md b/chains/llm-math/README.md
new file mode 100644
index 0000000..a5b1808
--- /dev/null
+++ b/chains/llm-math/README.md
@@ -0,0 +1,14 @@
+# LLM Math
+
+
+## Description
+
+A LLMMathChain that uses LLMs and the Python REPL to do complex word math problems.
+
+## Chain type
+
+LLMMathChain
+
+## Input Variables
+
+question: math problem to be solved.
\ No newline at end of file
diff --git a/chains/llm-requests/README.md b/chains/llm-requests/README.md
new file mode 100644
index 0000000..931811e
--- /dev/null
+++ b/chains/llm-requests/README.md
@@ -0,0 +1,14 @@
+# LLMRequestsChain
+
+## Description
+
+The LLMRequestsChain extracts answers from HTML results from a URL. Given a URL, and a query to extract information from the results, the chain will extract the answer to the query from the text of the results or return "not found" if the information is not contained in the results text.
+
+## Chain type
+
+LLMRequestsChain
+
+## Input Variables
+
+url: URL
+query: query to extract information from search results.
\ No newline at end of file
diff --git a/chains/pal/math/README.md b/chains/pal/math/README.md
new file mode 100644
index 0000000..a2339ea
--- /dev/null
+++ b/chains/pal/math/README.md
@@ -0,0 +1,13 @@
+# PAL Math Chain
+
+## Description
+
+The PALChain mplements Program-Aided Language Models, as in https://arxiv.org/pdf/2211.10435.pdf. Gives the model examples of math questions sent as text and answers written in Python, then provides the input question to do the same.
+
+## Chain type
+
+PALChain
+
+## Input Variables
+
+question: a math problem in plain text
\ No newline at end of file