Skip to content

Commit

Permalink
Improve documentation to resolve #1
Browse files Browse the repository at this point in the history
  • Loading branch information
mam10eks authored May 2, 2023
1 parent 22e3e3a commit 7f9ba0c
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion ir-datasets/tutorial/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
FROM webis/tira-ir-datasets-starter:0.0.54

COPY pangrams.py /usr/lib/python3.8/site-packages/ir_datasets/datasets_in_progress/
# The ir_datasets integration in "pangrams.py" and the resources "pangram-qrels.txt", "pangram-topics.xml", and "pangram-documents.jsonl" need to be
# located in a package "datasets_in_progress" on the pythonpath so that they can be found. The following copy command ensures this.
# You can test that it is correctly in the python path by running "from ir_datasets.datasets_in_progress import pangrams" inside a python shell.
# I.e., if your docker image has the name "pangram-ir-dataset" as in the tutorial, a command to test this would be:
# docker run --rm -ti --entrypoint python3 pangram-ir-dataset -c 'from ir_datasets.datasets_in_progress import pangrams; help(pangrams)'
COPY pangrams.py pangram-qrels.txt pangram-topics.xml pangram-documents.jsonl /usr/lib/python3.8/site-packages/ir_datasets/datasets_in_progress/

ENTRYPOINT [ "/irds_cli.sh" ]

0 comments on commit 7f9ba0c

Please sign in to comment.