Clarify usage modes in README #90
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
QuentinJGMace
left a comment
QuentinJGMace
left a comment
There was a problem hiding this comment.
Looks good ! Maybe I would state the colpali-engine[train] incompatibility more explicitely.
README.md
Outdated
Comment on lines
61
to
62
| > [!WARNING] | ||
| > Do not install optional dependency groups if you are going to use the library mode, or you might end up with circular dependency imports! |
Collaborator
There was a problem hiding this comment.
Isn't it true in both cases ? Shouldn't it be better to say that colpali-engine[train] et vidore-benchmark[colpali-engine] are incompatible (or will be in the near future).
|
|
||
| ```bash | ||
| pip install "vidore-benchmark[bge-m3]" | ||
| pip install "vidore-benchmark[colpali-engine]" |
Collaborator
There was a problem hiding this comment.
Probably better to state the incompatibility with colpalli-engine[train] here no ? As it is where we are addressing the dependency groups install
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Clarify the package's usage modes (CLI vs libray) in README.