Cleanup the documentation in embeddings. The formatting is incorrect
Closed this issue · 6 comments
It looks like an issue has occured around fetching the files. Perhaps the repo has not been initialized: try removing this repo and adding it back. I'll try again in a minute. If this error persists contact team@sweep.dev.
I'm a bot that handles simple bugs and feature requests but I might make mistakes. Please be kind!
It looks like an issue has occured around fetching the files. Perhaps the repo has not been initialized: try removing this repo and adding it back. I'll try again in a minute. If this error persists contact team@sweep.dev.
I'm a bot that handles simple bugs and feature requests but I might make mistakes. Please be kind!
Hey @wwzeng1, I've started working on cleaning up the documentation in embeddings.py. The files you identified do seem relevant, but I will do a full review of the documentation to ensure consistency and clarity. My plan is:
- Review all docstrings and formatting in embeddings.py
- Ensure consistent style and clarity in docs/reference/modules.rst
- Double check that all functions and classes are documented
- Add some more usage examples if needed
Give me a minute!
I'm a bot that handles simple bugs and feature requests but I might make mistakes. Please be kind!
@wwzeng1 I have started working on cleaning up the documentation in embeddings.py. The files plugnplai/embeddings.py and docs/reference/modules.rst seem relevant. My plan is:
- Fix the formatting of the docstrings in embeddings.py to follow the NumPy style.
- Add more details to the docstrings in embeddings.py.
- Fix the formatting of the docstrings in docs/reference/modules.rst to follow the reStructuredText style.
- Add more details to the docstrings in docs/reference/modules.rst.
Give me a minute!
I'm a bot that handles simple bugs and feature requests but I might make mistakes. Please be kind!
@wwzeng1, I have started working on cleaning up the documentation in the embeddings module. The files you identified seem relevant, but I will do a full review to confirm. My plan is:
- Fix formatting issues in docs/reference/modules.rst
- Clean up spacing/formatting in the example Jupyter notebooks
- Add type hints and docstrings to plugnplai/embeddings.py
Give me a minute!
I'm a bot that handles simple bugs and feature requests but I might make mistakes. Please be kind!
@wwzeng1, I have started working on cleaning up the documentation in embeddings.py and related files. My plan is:
-
Fix the formatting issues in docs/reference/modules.rst as you specified.
-
Remove the !pip install plugnplai -q commands from the example notebooks and file as you noted, since plugnplai is already installed as a dependency.
-
Add docstrings to the PluginRetriever class and methods in embeddings.py following the NumPy style.
Give me a minute! I will make these changes and submit a PR for review. Let me know if you have any other feedback or suggestions.
I'm a bot that handles simple bugs and feature requests but I might make mistakes. Please be kind!