Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: [Ellipsis] Documentation bots #21

Closed
wants to merge 1 commit into from

Conversation

ellipsis-dev[bot]
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot commented Mar 25, 2024

⚠️ Sorry, I timed out before I could complete this PR, so I've submitted my work in progress.

Summary:

⚠️ We couldn't build/test your project to verify our changes. Add a Dockerfile to significantly improve code quality.

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:

Step Result Details
1
Add docstrings to functions in '/sunholo/components/llm.py'Added docstrings to functions in '/sunholo/components/llm.py'
2
Add docstrings to functions in '/sunholo/components/prompt.py'Added docstrings to the functions in the '/sunholo/components/prompt.py' file.
3
Add docstrings to functions in '/sunholo/components/retriever.py'No result
4
Add docstrings to functions in '/sunholo/components/vectorstore.py'No result
5
Add README.md to '/sunholo/components'No result

Something 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation bots
1 participant