Add to onboarding reproduction logs #2492
Merged
Conversation
This file contains 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
lintool
reviewed
May 10, 2024
docs/experiments-msmarco-passage.md
Outdated
| @@ -322,8 +316,8 @@ It turns out that optimizing for MRR@10 and MAP yields the same settings. | |||
|
|
|||
| Here's the comparison between the Anserini default and optimized parameters: | |||
|
|
|||
| | Setting | MRR@10 | MAP | Recall@1000 | | |||
| |:------------------------------------------------|-------:|-------:|------------:| | |||
| | Setting | MRR@10 | MAP | Recall@1000 | | |||
There was a problem hiding this comment.
I think you introduced inconsistencies here? Old table seems fine to me?
There was a problem hiding this comment.
Oops, I clicked on the file and my editor did some formatting automatically. I will fix that.
lintool
reviewed
May 10, 2024
docs/start-here.md
Outdated
| @@ -20,8 +20,8 @@ What's the problem we're trying to solve? | |||
|
|
|||
| This is the definition I typically give: | |||
|
|
|||
| > Given an information need expressed as a query _q_, the text retrieval task is to return a ranked list of _k_ texts {_d<sub>1</sub>_, _d<sub>2</sub>_ ... _d<sub>k</sub>_} from an arbitrarily large but finite collection | |||
| of texts _C_ = {_d<sub>i</sub>_} that maximizes a metric of interest, for example, nDCG, AP, etc. | |||
| > Given an information need expressed as a query _q_, the text retrieval task is to return a ranked list of _k_ texts {_d`<sub>`1`</sub>`_, _d`<sub>`2`</sub>`_ ... _d`<sub>`k`</sub>`_} from an arbitrarily large but finite collection | |||
There was a problem hiding this comment.
nah, I think I like original better...
There was a problem hiding this comment.
Yeah same here, I didn't mean to change that. My editor did that automatically for some reason. Will fix.
|
thanks for the de-linting. left comments. |
lintool
reviewed
May 10, 2024
docs/experiments-msmarco-passage.md
Outdated
| @@ -89,7 +86,7 @@ On the other hand, retrieval needs to be fast, i.e., low latency, high throughpu | |||
|
|
|||
| With the data prep above, we can now index the MS MARCO passage collection in `collections/msmarco-passage/collection_jsonl`. | |||
|
|
|||
| If you haven't built Anserini already, build it now using the instructions in [anserini#-getting-started](https://github.com/castorini/anserini#-getting-started). | |||
| If you haven't built Anserini already, build it now using the instructions in [anserini#-try-it](https://github.com/castorini/anserini?tab=readme-ov-file#-try-it). | |||
There was a problem hiding this comment.
I think "Installation" is the better link?
|
@lintool I have made the changes accordingly. Please let me know if anything I didn't expect breaks lol |
lintool
approved these changes
May 10, 2024
lintool
approved these changes
May 10, 2024
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.
System setup:
OS: macOS Sonoma 14.4.1
Memory: 16GB
Chip: Apple M1 Pro
Python Version: 3.12.3
Java Version: 21.0.3
Maven: 3.9.6
Suggestion: I think linking try-it instead of getting-started is more suitable as I don't see a getting-started section on the read-me.