-
Notifications
You must be signed in to change notification settings - Fork 3
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
Showing
1 changed file
with
25 additions
and
1 deletion.
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 |
---|---|---|
@@ -1,4 +1,28 @@ | ||
# Examples of Reproducibility Experiments | ||
|
||
We will add the Jupyter Notebooks for the reproducibility Experiments in the next two days, we are at the moment cleaning and documenting the code. | ||
This directory exemplifies how archived reproducibility experiments on archived shared task repositories of the IR Experiment Platform look like. | ||
This directory contains notebooks with detailed instructions and examples on how to do allow post-hoc experiments. | ||
All examples work use the archived shared task of the 32 ir benchmarks on which we executed over 50 retrieval approaches: [https://github.com/tira-io/ir-experiment-platform-benchmarks](https://github.com/tira-io/ir-experiment-platform-benchmarks). | ||
|
||
The reporucibility examples use jupyter notebooks. | ||
To start them, please clone the archived shared task repository: | ||
|
||
``` | ||
git clone [email protected]:tira-io/ir-experiment-platform-benchmarks.git | ||
``` | ||
|
||
Inside the cloned repository, you can start the Jupyter notebook which automatically installs a minimal virtual environment using: | ||
``` | ||
make jupyterlab | ||
``` | ||
|
||
|
||
The installation of the environment is simplified with a virtual environment and executing `make jupyterlab` installs the virtual environment (if not already done) and starts the jupyter notebook ready to run all parts of the tutorial. | ||
|
||
For each of the softwares submitted to TIRA, the `tira` integration to PyTerrier loads the Docker Image submitted to TIRA to execute it in PyTerrier pipelines (i.e., a first execution could take sligthly longer). | ||
|
||
The following reproducibility notebooks are available: | ||
|
||
- [full-rank-retriever-reproducibility.ipynb](full-rank-retriever-reproducibility.ipynb): showcases how full-rankers can be reproduced/replicated. | ||
- [re-rank-reproducibility.ipynb](re-rank-reproducibility.ipynb): showcases how re-rankers can be reproduced/replicated. | ||
- [interoparability-tutorial.ipynb](interoparability-tutorial.ipynb): showcases how full-rankers and re-rankers submitted in TIRA can be combined in new ways in post-hoc experiments. |