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

docs: Include all use-cases in README.md #761

Merged
merged 2 commits into from
Apr 19, 2024

Conversation

NickyHavoc
Copy link
Collaborator

@NickyHavoc NickyHavoc commented Apr 19, 2024

Description

No description.

Before Merging

  • Review the code changes
    • Unused print / comments / TODOs
    • Missing docstrings for functions that should have them
    • Consistent variable names
    • ...
  • Update changelog.md if necessary
  • Commit messages should contain a semantic label and the ticket number
    • Consider squashing if this is not the case

@NickyHavoc
Copy link
Collaborator Author

Some services appear to be down or sth, making stuff break

@NiklasKoehneckeAA
Copy link
Contributor

this also failed on main and was done by my merge, will have a look at it

@NiklasKoehneckeAA NiklasKoehneckeAA force-pushed the readme-to-include-all-tasks branch from d17e6fd to b003907 Compare April 19, 2024 11:08
Copy link
Contributor

@NiklasKoehneckeAA NiklasKoehneckeAA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We now have MultiChunkRetrieverQa & RetrieverBasedQa, and we recommend the multichunk one. Its still kinda confusing when reading the readme, especially since they are not grouped together. Do you have an idea on how to make this more clear on what to use when?

@NickyHavoc NickyHavoc merged commit 57b4ea2 into main Apr 19, 2024
4 checks passed
@NickyHavoc NickyHavoc deleted the readme-to-include-all-tasks branch April 19, 2024 11:54
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.

2 participants