Skip to content

Commit

Permalink
Clarify report file command (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidmezzetti committed Oct 11, 2021
1 parent 138bf60 commit 27d2a2c
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,15 +125,15 @@ no parameters are passed in.
## Building a report file
Reports support generating output in multiple formats. An example report call:

python -m paperai.report tasks/risk-factors.yml 50 md cord19/models
python -m paperai.report tasks/risks.yml 50 md cord19/models

The following report formats are supported:

- Markdown (Default) - Renders a Markdown report. Columns and answers are extracted from articles with the results stored in a Markdown file.
- CSV - Renders a CSV report. Columns and answers are extracted from articles with the results stored in a CSV file.
- Annotation - Columns and answers are extracted from articles with the results annotated over the original PDF files. Requires passing in a path with the original PDF files.

In the example above, a file named tasks/risk-factors.md will be created.
In the example above, a file named tasks/risk_factors.md will be created. Example report configuration files can be found [here](https://github.com/neuml/cord19q/tree/master/tasks).

## Running queries
The fastest way to run queries is to start a paperai shell
Expand Down

0 comments on commit 27d2a2c

Please sign in to comment.