From cee1404ec3f89b588afd95c9aaf76bd805dc7da4 Mon Sep 17 00:00:00 2001
From: hupe1980 <frankhuebner1980@gmail.com>
Date: Wed, 19 Jul 2023 21:32:52 +0200
Subject: [PATCH] Add docstrings

---
 agent/agent.go                   | 1 +
 callback/callback.go             | 1 +
 chain/chain.go                   | 2 ++
 documentloader/documentloader.go | 2 ++
 evaluation/evaluation.go         | 1 +
 integration/integration.go       | 1 +
 memory/memory.go                 | 2 +-
 outputparser/outputparser.go     | 2 ++
 prompt/prompt.go                 | 1 +
 rag/rag.go                       | 2 ++
 schema/schema.go                 | 2 ++
 textsplitter/text_splitter.go    | 1 +
 tokenizer/tokenizer.go           | 2 ++
 util/util.go                     | 1 +
 vectorstore/vectorstore.go       | 1 +
 15 files changed, 21 insertions(+), 1 deletion(-)
 create mode 100644 chain/chain.go
 create mode 100644 documentloader/documentloader.go
 create mode 100644 outputparser/outputparser.go
 create mode 100644 rag/rag.go
 create mode 100644 schema/schema.go
 create mode 100644 tokenizer/tokenizer.go

diff --git a/agent/agent.go b/agent/agent.go
index 897f1bd..f82ec75 100644
--- a/agent/agent.go
+++ b/agent/agent.go
@@ -1,3 +1,4 @@
+// Package agent provides functionality for creating and managing agents that leverage Large Language Models (LLMs) to make informed decisions and take actions.
 package agent
 
 import (
diff --git a/callback/callback.go b/callback/callback.go
index aa93eca..de156ac 100644
--- a/callback/callback.go
+++ b/callback/callback.go
@@ -1,3 +1,4 @@
+// Package callback provides utilities for implementing callbacks in GoLC applications.
 package callback
 
 import (
diff --git a/chain/chain.go b/chain/chain.go
new file mode 100644
index 0000000..73d726b
--- /dev/null
+++ b/chain/chain.go
@@ -0,0 +1,2 @@
+// Package chain enables the creation and execution of chains, which are sequences of calls to LLMs or other utilities. It provides a standardized interface for working with chains and allows for seamless integration with various tools and services.
+package chain
diff --git a/documentloader/documentloader.go b/documentloader/documentloader.go
new file mode 100644
index 0000000..fcd83de
--- /dev/null
+++ b/documentloader/documentloader.go
@@ -0,0 +1,2 @@
+// Package documentloader provides functionality for loading and processing documents in GoLC applications.
+package documentloader
diff --git a/evaluation/evaluation.go b/evaluation/evaluation.go
index 8e6bac5..08d06bc 100644
--- a/evaluation/evaluation.go
+++ b/evaluation/evaluation.go
@@ -1 +1,2 @@
+// Package evaluation provides utilities for evaluating and assessing the performance of generative models in GoLC applications.
 package evaluation
diff --git a/integration/integration.go b/integration/integration.go
index 76ab1b7..4309630 100644
--- a/integration/integration.go
+++ b/integration/integration.go
@@ -1 +1,2 @@
+// Package integration provides utilities for integrating GoLC with external systems, services, and frameworks.
 package integration
diff --git a/memory/memory.go b/memory/memory.go
index 06c4e14..511e1e1 100644
--- a/memory/memory.go
+++ b/memory/memory.go
@@ -1,2 +1,2 @@
-// Package memory contains implementations for managing conversation data
+// Package memory contains implementations for managing conversation data and facilitating the persistence of state between chain or agent calls.
 package memory
diff --git a/outputparser/outputparser.go b/outputparser/outputparser.go
new file mode 100644
index 0000000..b94ef86
--- /dev/null
+++ b/outputparser/outputparser.go
@@ -0,0 +1,2 @@
+// Package outputparser provides utilities for parsing and processing the output generated by LLMs and other tools in GoLC applications.
+package outputparser
diff --git a/prompt/prompt.go b/prompt/prompt.go
index 68f9498..c293692 100644
--- a/prompt/prompt.go
+++ b/prompt/prompt.go
@@ -1,3 +1,4 @@
+// Package prompt provides utilities for managing and optimizing prompts in GoLC applications.
 package prompt
 
 import (
diff --git a/rag/rag.go b/rag/rag.go
new file mode 100644
index 0000000..21beda5
--- /dev/null
+++ b/rag/rag.go
@@ -0,0 +1,2 @@
+// Package rag provides functionality for Retrieval-Augmented Generation (RAG) in GoLC applications.
+package rag
diff --git a/schema/schema.go b/schema/schema.go
new file mode 100644
index 0000000..cdb039f
--- /dev/null
+++ b/schema/schema.go
@@ -0,0 +1,2 @@
+// Package schema defines the data structures and types used in GoLC applications.
+package schema
diff --git a/textsplitter/text_splitter.go b/textsplitter/text_splitter.go
index c3629ba..beb6508 100644
--- a/textsplitter/text_splitter.go
+++ b/textsplitter/text_splitter.go
@@ -1,3 +1,4 @@
+// Package textsplitter provides utilities for splitting and processing text in GoLC applications.
 package textsplitter
 
 import (
diff --git a/tokenizer/tokenizer.go b/tokenizer/tokenizer.go
new file mode 100644
index 0000000..fac2e75
--- /dev/null
+++ b/tokenizer/tokenizer.go
@@ -0,0 +1,2 @@
+// Package tokenizer provides utilities for tokenizing text in GoLC applications.
+package tokenizer
diff --git a/util/util.go b/util/util.go
index c7d8682..b588a8d 100644
--- a/util/util.go
+++ b/util/util.go
@@ -1 +1,2 @@
+// Package util provides utility functions and helpers for use in GoLC applications.
 package util
diff --git a/vectorstore/vectorstore.go b/vectorstore/vectorstore.go
index 0b7c622..8a87626 100644
--- a/vectorstore/vectorstore.go
+++ b/vectorstore/vectorstore.go
@@ -1,3 +1,4 @@
+// Package vectorstore provides functionality for storing and managing vector embeddings in GoLC applications.
 package vectorstore
 
 import (