-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
bb8d444
commit 749ab38
Showing
40 changed files
with
16,816 additions
and
23 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <link rel="stylesheet" href="main.css" /> | ||
| <script src="https://code.jquery.com/jquery-1.12.4.min.js" integrity="sha256-ZosEbRLbNQzLpnKIkEdrPv7lOy9C27hHQ+Xp8a4MxAQ=" crossorigin="anonymous"></script> | ||
| <script src="https://code.jquery.com/ui/1.12.1/jquery-ui.min.js" integrity="sha256-VazP97ZCwtekAsvgPBSUwPFKdrwD3unUfSGVYrahUqU=" crossorigin="anonymous"></script> | ||
| <script src="main.js"></script> | ||
| <meta charset="utf-8" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
|
|
||
| <title>Command Line Interface - ir_datasets</title> | ||
| <body> | ||
| <div class="page"> | ||
|
|
||
| <div style="position: absolute; top: 4px; left: 4px;"><a href="index.html">← home</a></div> | ||
|
|
||
| <div style="position: absolute; top: 4px; right: 4px;">Github: <a href="https://github.com/allenai/ir_datasets/">allenai/ir_datasets</a></div> | ||
| <h1><code>ir_datasets</code>: Command Line Interface</h1> | ||
| <h2 id="export">export command</h2> | ||
|
|
||
| <p> | ||
| Data can be exported to stdout in various formats using the <code>ir_datasets export</code> command. | ||
| </p> | ||
|
|
||
| <h4><code>ir_datasts export [dataset-id] docs [--fields] [--format]</code></h4> | ||
|
|
||
| <div class="methodinfo"> | ||
| <p>Exports documents</p> | ||
| <p><code>--fields</code>: select which fields from the document to export (defaults to all)</p> | ||
| <p><code>--format</code>: select output format to use: <code>tsv</code> (default) or <code>jsonl</code></p> | ||
| </div> | ||
|
|
||
| <h4><code>ir_datasts export [dataset-id] queries [--fields] [--format]</code></h4> | ||
|
|
||
| <div class="methodinfo"> | ||
| <p>Exports queries</p> | ||
| <p><code>--fields</code>: select which fields from the query to export (defaults to all)</p> | ||
| <p><code>--format</code>: select output format to use: <code>tsv</code> (default) or <code>jsonl</code></p> | ||
| </div> | ||
|
|
||
| <h4><code>ir_datasts export [dataset-id] qrels [--fields] [--format]</code></h4> | ||
|
|
||
| <div class="methodinfo"> | ||
| <p>Exports queries</p> | ||
| <p><code>--fields</code>: select which fields from the qrels to export (defaults to all)</p> | ||
| <p><code>--format</code>: select output format to use: <code>trec</code> (default), <code>tsv</code> or <code>jsonl</code></p> | ||
| </div> | ||
|
|
||
| <h4><code>ir_datasts export [dataset-id] scoreddocs [--fields] [--format]</code></h4> | ||
|
|
||
| <div class="methodinfo"> | ||
| <p>Exports queries</p> | ||
| <p><code>--fields</code>: select which fields from the scoreddocs to export (defaults to all)</p> | ||
| <p><code>--format</code>: select output format to use: <code>trec</code> (default), <code>tsv</code> or <code>jsonl</code></p> | ||
| </div> | ||
|
|
||
| <h2 id="export">lookup command</h2> | ||
|
|
||
| <p> | ||
| You can look up documents by their <code>doc_id</code> using the <code>ir_datasets lookup</code> command. | ||
| </p> | ||
|
|
||
| <h4><code>ir_datasts lookup [dataset-id] [doc_ids ...] [--fields] [--format]</code></h4> | ||
|
|
||
| <div class="methodinfo"> | ||
| <p>Efficiently finds documents that have the provided doc_ids</p> | ||
| <p><code>--fields</code>: select which fields from the documents to export (defaults to all)</p> | ||
| <p><code>--format</code>: select output format to use: <code>trec</code> (default), <code>tsv</code> or <code>jsonl</code></p> | ||
| </div> | ||
|
|
||
|
|
||
| <h2 id="export">doc_fifo command</h2> | ||
|
|
||
| <p> | ||
| You can create output FIFOs suitable for Anserini indexing using the <code>ir_datasets doc_fifo</code> command. | ||
| </p> | ||
|
|
||
| <p> | ||
| Note that unlike export and lookup, these always output as JSONL in a format that Anserini can use to index | ||
| (id and content fields). All selected fields are concatenated. | ||
| </p> | ||
|
|
||
| <p> | ||
| This command will output a command you can run for indexing with Anserini. This process remains running | ||
| until all documents are sent to fifos. | ||
| </p> | ||
|
|
||
| <h4><code>ir_datasts doc_fifos [dataset-id] [--fields] [--count]</code></h4> | ||
|
|
||
| <div class="methodinfo"> | ||
| <p>Creates a temporary directory with fifos</p> | ||
| <p><code>--fields</code>: select which fields from the documents to export (defaults to all). These fields are concatenated.</p> | ||
| <p><code>--count</code>: how many fifos to make? Defualts to 1 less than the number of processors (or 1).</p> | ||
| <p><code>--dir</code>: where to put the fifos? Defaults to a new temp directory.</p> | ||
| </div> | ||
|
|
||
| </div> | ||
| </body> | ||
| </html> |
Large diffs are not rendered by default.
Oops, something went wrong.
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
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
Oops, something went wrong.