-
Notifications
You must be signed in to change notification settings - Fork 1
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
20 additions
and
20 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 |
|---|---|---|
| @@ -1,19 +1,19 @@ | ||
| <!-- [](https://doi.org/10.1145/3477495.3531743) --> | ||
| <!-- [](https://arxiv.org/abs/2304.00413) --> | ||
| <!-- [](https://github.com/webis-de/ir-pad/actions/workflows/ci.yml) --> | ||
| [](https://github.com/webis-de/ir-pad/issues) | ||
| [](https://github.com/webis-de/ir-pad/pulls) | ||
| [](https://github.com/webis-de/ir-pad/commits) | ||
| [](https://github.com/webis-de/ir-pad/graphs/contributors) | ||
| [](LICENSE) | ||
| <!-- [](https://github.com/tira-io/teaching-ir-with-shared-tasks/actions/workflows/ci.yml) --> | ||
| [](https://github.com/tira-io/teaching-ir-with-shared-tasks/issues) | ||
| [](https://github.com/tira-io/teaching-ir-with-shared-tasks/pulls) | ||
| [](https://github.com/tira-io/teaching-ir-with-shared-tasks/commits) | ||
| [](https://github.com/tira-io/teaching-ir-with-shared-tasks/graphs/contributors) | ||
| [](LICENSE) | ||
|
|
||
| # 🧪 ir-pad | ||
| # 🧪 Teaching IR with Shared Tasks | ||
|
|
||
| Resources for combining teaching and research in information retrieval coursework. | ||
|
|
||
| [](https://codespaces.new/webis-de/ir-pad?quickstart=1) | ||
| [](https://codespaces.new/tira-io/teaching-ir-with-shared-tasks?quickstart=1) | ||
|
|
||
| The ir-pad is intended as a collection of supplementary materials for exercises in IR courses that let students experience the full research cycle in their course. We provide: | ||
| The resources are intended as a collection of supplementary materials for exercises in IR courses that let students experience the full research cycle in their course. We provide: | ||
|
|
||
| - A [dashboard](#dashboard) to support brainstorming | ||
| - Explore datasets, approaches, and evaluation techniques | ||
|
|
@@ -22,7 +22,7 @@ The ir-pad is intended as a collection of supplementary materials for exercises | |
| - A set of [tutorials](#tutorials) covering IR concepts | ||
| - Showcases a single concept using small example data | ||
| - Takes about 15 minutes per tutorial | ||
| - Implemented as Jupyter notebooks in [GitHub Codespaces](https://codespaces.new/webis-de/ir-pad?quickstart=1) | ||
| - Implemented as Jupyter notebooks in [GitHub Codespaces](https://codespaces.new/tira-io/teaching-ir-with-shared-tasks?quickstart=1) | ||
| - An integration with TIREx to support [reproducible experiments](#reproducible-experiments) | ||
| - Reuse strong baselines from [TIREx](https://tira.io/tirex) | ||
| - Code submissions for reproducible experiments | ||
|
|
@@ -32,7 +32,7 @@ The ir-pad is intended as a collection of supplementary materials for exercises | |
| - Archived on Zenodo and GitHub Pages | ||
| - Deep links for referencing in research papers | ||
|
|
||
| Read more about the ir-pad in our accompanying research paper: \ | ||
| Read more about the resources in our accompanying research paper: \ | ||
| Resources for Combining Teaching and Research in Information Retrieval Coursework | ||
| <!-- [Resources for Combining Teaching and Research in Information Retrieval Coursework](TODO) ([abstract](#abstract)) --> | ||
|
|
||
|
|
@@ -51,13 +51,13 @@ Resources for Combining Teaching and Research in Information Retrieval Coursewor | |
| ## Installation | ||
|
|
||
| The easiest way to start with the tutorials is to open this repository in GitHub Codespaces: \ | ||
| [](https://codespaces.new/webis-de/ir-pad?quickstart=1) \ | ||
| [](https://codespaces.new/tira-io/teaching-ir-with-shared-tasks?quickstart=1) \ | ||
| This will install all necessary software. Just wait until the editor window has fully loaded (i.e., no progress bars visible; may take a while). \ | ||
| The other resources (i.e., [dashboard](#dashboard), [reproducible experiments](#reproducible-experiments), and [dataset browser](#dataset-browser)) are just web apps that you can run in your web browser. | ||
|
|
||
| ## Usage | ||
|
|
||
| In the following, you will learn how to use each of the four main components of the ir-pad: | ||
| In the following, you will learn how to use each of the four main components of our resources: | ||
| the [dashboard](#dashboard), the [tutorials](#tutorials), [reproducible experiments](#reproducible-experiments), and the [dataset browser](#dataset-browser). The sections roughly follow the order as you would use the components in your course (either as student or teacher). | ||
|
|
||
| ### Dashboard | ||
|
|
@@ -97,24 +97,24 @@ The below list includes the universities and IR courses that already benefit fro | |
| | ✅ | Summer semester 2023 | Advanced Information Retrieval | [Friedrich-Schiller-Universität Jena](https://jena.webis.de) | | ||
| | 🔜 | _soon_ | _**your** IR course_ | _[get in touch 💬](#contact)_ | | ||
|
|
||
| Our accompanying [research paper](#citation) includes a case study and describes our experiences of using the ir-pad in the IR courses of two universities over two semesters. | ||
| Our accompanying [research paper](#citation) includes a case study and describes our experiences of using our resources in the IR courses of two universities over two semesters. | ||
|
|
||
| ## Similar resources | ||
|
|
||
| We took inspiration from some great tutorials and resources out there. Of course, the ir-pad should not replace but complement them: | ||
| We took inspiration from some great tutorials and resources out there. Of course, our resources should not replace but complement them: | ||
|
|
||
| - [The PyTerrier Tutorial](https://github.com/terrier-org/ecir2021tutorial) | ||
|
|
||
| ## Contributing | ||
|
|
||
| With the plethora of new retrieval approaches emerging every year, it is hard for us alone to keep the ir-lab up-to-date and to add new tutorials. We would be extremely happy, if you (as an IR teacher) could take some time to improve an existing notebook or to propose a new one! | ||
|
|
||
| Contributing to the ir-pad is as easy as using it: Just [open this repository in GitHub Codespaces](https://codespaces.new/webis-de/ir-pad?quickstart=1) (or alternatively, clone it and open the repo in a [Dev container](https://containers.dev/) with your [favorite IDE](https://containers.dev/supporting)). | ||
| Contributing to the resources is as easy as using it: Just [open this repository in GitHub Codespaces](https://codespaces.new/tira-io/teaching-ir-with-shared-tasks?quickstart=1) (or alternatively, clone it and open the repo in a [Dev container](https://containers.dev/) with your [favorite IDE](https://containers.dev/supporting)). | ||
|
|
||
| ## Contact | ||
|
|
||
| We would be glad to support you in using the ir-pad for your information retrieval course! | ||
| Do not hesitate to write us an email or file an [issue](https://github.com/webis-de/ir-pad/issues/new): | ||
| We would be glad to support you in applying shared task style teaching for your information retrieval course! | ||
| Do not hesitate to write us an email or file an [issue](https://github.com/tira-io/teaching-ir-with-shared-tasks/issues/new): | ||
|
|
||
| - Maik Fröbe [[email protected]](mailto:[email protected]) | ||
| - Harrisen Scells | ||
|
|
@@ -131,7 +131,7 @@ We're happy to help! | |
|
|
||
| <!--## Citation | ||
| If you use the ir-pad or its tutorials in your research, please cite the following paper: | ||
| If you use our resources or its tutorials in your research, please cite the following paper: | ||
| > TODO | ||
|
|
@@ -143,7 +143,7 @@ You can use the following BibTeX entry for citation: | |
| ## License | ||
|
|
||
| This repository and its tutorials are released under the [MIT license](LICENSE). | ||
| <!-- If you use the ir-pad in your research, we'd be glad if you'd [cite us](#citation). --> | ||
| <!-- If you use the resources in your research, we'd be glad if you'd [cite us](#citation). --> | ||
|
|
||
| ## Abstract | ||
|
|
||
|
|
||