Add docstrings

hupe1980 · Jul 19, 2023 · cee1404 · cee1404
1 parent 86812fe
commit cee1404
Show file tree

Hide file tree

Showing 15 changed files with 21 additions and 1 deletion.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -1,3 +1,4 @@
+// Package vectorstore provides functionality for storing and managing vector embeddings in GoLC applications.
 package vectorstore
 
 import (
Original file line number	Diff line number	Diff line change
		@@ -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
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package documentloader provides functionality for loading and processing documents in GoLC applications.
		package documentloader
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		// Package evaluation provides utilities for evaluating and assessing the performance of generative models in GoLC applications.
		package evaluation
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		// Package integration provides utilities for integrating GoLC with external systems, services, and frameworks.
		package integration
Original file line number	Diff line number	Diff line change
		@@ -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
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package rag provides functionality for Retrieval-Augmented Generation (RAG) in GoLC applications.
		package rag
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package schema defines the data structures and types used in GoLC applications.
		package schema
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package tokenizer provides utilities for tokenizing text in GoLC applications.
		package tokenizer
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		// Package util provides utility functions and helpers for use in GoLC applications.
		package util