Feature: JSON document format #603
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #603 +/- ##
=======================================
Coverage 93.91% 93.92%
=======================================
Files 82 82
Lines 3929 3931 +2
=======================================
+ Hits 3690 3692 +2
Misses 239 239 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Support JSONL collection format. This should make it easy to prepare a script that transforms any format into JSON and streams it to the parsing tool. Signed-off-by: Michal Siedlaczek <[email protected]>
The script utilizes `ir-datasets` to download a dataset and prints it out in a format that can be understood by `parse_collection`. Signed-off-by: Michal Siedlaczek <[email protected]>
JMMackenzie
approved these changes
Mar 9, 2025
amallia
reviewed
Mar 12, 2025
| @@ -262,6 +262,8 @@ <h2 id="supported-formats"><a class="header" href="#supported-formats">Supported | |||
| <li><code>plaintext</code>: every line contains the document's title first, then any | |||
| number of whitespaces, followed by the content delimited by a new line | |||
| character.</li> | |||
| <li><code>jsonl</code>: every line is a JSON document with three fields: <code>title</code>, | |||
There was a problem hiding this comment.
Can we clarify how we treat title and content? Do we concatenate?
There was a problem hiding this comment.
"title" what in PISA we call a string document ID. We must have one. This has nothing to do with a title that could be part of content.
| @@ -420,6 +420,8 @@ <h2 id="supported-formats"><a class="header" href="#supported-formats">Supported | |||
| <li><code>plaintext</code>: every line contains the document's title first, then any | |||
| number of whitespaces, followed by the content delimited by a new line | |||
| character.</li> | |||
| <li><code>jsonl</code>: every line is a JSON document with three fields: <code>title</code>, | |||
| def parse_dataset(dataset_name): | ||
| dataset = ir.load(dataset_name) | ||
| for doc in dataset.docs_iter(): | ||
| print(json.dumps({"title": doc.doc_id, "content": doc.text})) |
There was a problem hiding this comment.
why doc_id as title?
For example
import ir_datasets
dataset = ir_datasets.load("beir/climate-fever")
for doc in dataset.docs_iter():
doc # namedtuple<doc_id, text, title>
import ir_datasets
dataset = ir_datasets.load("msmarco-passage")
for doc in dataset.docs_iter():
doc # namedtuple<doc_id, text>
Two examples: one has title and the other one does not
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.
Support JSONL collection format. This should make it easy to prepare a script that transforms any format into JSON and streams it to the parsing tool.