Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
Issue: resolves #18
Implementation:
Step 1: Add docstrings to functions in '/sunholo/components/llm.py'
Open the file '/sunholo/components/llm.py'. For each function in this file, add a docstring that describes what the function does, its parameters, and its return value. The functions in this file include 'pick_llm', 'pick_streaming', 'get_llm', 'get_llm_chat', 'get_embeddings', and 'pick_embedding'.
Step 2: Add docstrings to functions in '/sunholo/components/prompt.py'
Open the file '/sunholo/components/prompt.py'. For each function in this file, add a docstring that describes what the function does, its parameters, and its return value. The functions in this file include 'pick_prompt', 'pick_chat_buddy', 'pick_agent', 'pick_shared_vectorstore', and 'get_chat_history'.
Step 3: Add docstrings to functions in '/sunholo/components/retriever.py'
Open the file '/sunholo/components/retriever.py'. For each function in this file, add a docstring that describes what the function does, its parameters, and its return value. The functions in this file include 'load_memories' and 'pick_retriever'.
Step 4: Add docstrings to functions in '/sunholo/components/vectorstore.py'
Open the file '/sunholo/components/vectorstore.py'. For each function in this file, add a docstring that describes what the function does, its parameters, and its return value. The function in this file is 'pick_vectorstore'.
Step 5: Add README.md to '/sunholo/components'
Create a new file named 'README.md' in the '/sunholo/components' folder. This file should provide an overview of the folder and describe what each Python file in the folder does. The Python files in this folder include 'llm.py', 'prompt.py', 'retriever.py', and 'vectorstore.py'.
Report:
Add docstrings to functions in '/sunholo/components/llm.py'
Added docstrings to functions in '/sunholo/components/llm.py'Add docstrings to functions in '/sunholo/components/prompt.py'
Added docstrings to the functions in the '/sunholo/components/prompt.py' file.Add docstrings to functions in '/sunholo/components/retriever.py'
No resultAdd docstrings to functions in '/sunholo/components/vectorstore.py'
No resultAdd README.md to '/sunholo/components'
No resultSomething look wrong?: If this Pull Request doesn't contain the expected changes, add more information to #18. Then, add the
ellipsis:create
label to try again. For more information, check the documentation.