examples/search_touche_2023.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "# Using ChatNoir in PyTerrier experiments for Touché 2023\n",
    "The [ChatNoir](https://chatnoir.eu/) search engine is a low-barrier way to search the ClueWeb22 used in the Touché 2023 tasks 1 and 2.\n",
    "Using its search API via the [`chatnoir-pyterrier`](https://pypi.org/project/chatnoir-pyterrier/) Python package,\n",
    "we can retrieve documents from the ClueWeb22 without the hassle of indexing this large corpus.\n",
    "The retrieved documents can then be re-ranked in PyTerrier experiments."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "## Setup"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "Install Python packages if run in Google Colab."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {
    "collapsed": false
   },
   "outputs": [],
   "source": [
    "from sys import modules\n",
    "\n",
    "if \"google.colab\" in modules:\n",
    "    !pip install -q chatnoir-pyterrier python-terrier"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "## Retrieval pipeline\n",
    "We can now create a retrieval pipeline which retrieves results from [ChatNoir](https://chatnoir.eu/).\n",
    "Create a `ChatNoirRetrieve` transformer by specifying the ChatNoir API key and the ClueWeb22 index.\n",
    "You can then use the pipeline in the same way as `BatchRetrieve`."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {
    "collapsed": false
   },
   "outputs": [],
   "source": [
    "from chatnoir_pyterrier import ChatNoirRetrieve\n",
    "\n",
    "chatnoir_cw22 = ChatNoirRetrieve(index=\"clueweb22/b\", verbose=True)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "### Search\n",
    "For example, we can search the ClueWeb22 for documents about `Should teachers get tenure?`:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "Searching with ChatNoir: 100%|██████████| 1/1 [00:01<00:00,  1.53s/query]\n"
     ]
    },
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>qid</th>\n",
       "      <th>query</th>\n",
       "      <th>docno</th>\n",
       "      <th>score</th>\n",
       "      <th>rank</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0031-49-02531</td>\n",
       "      <td>2800.1940</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0042-24-00769</td>\n",
       "      <td>1911.2747</td>\n",
       "      <td>1</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0011-57-13248</td>\n",
       "      <td>1896.7843</td>\n",
       "      <td>2</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0038-04-18313</td>\n",
       "      <td>1813.0868</td>\n",
       "      <td>3</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0022-88-08363</td>\n",
       "      <td>1807.3335</td>\n",
       "      <td>4</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>5</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0021-01-08109</td>\n",
       "      <td>1660.7153</td>\n",
       "      <td>5</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>6</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0032-04-03343</td>\n",
       "      <td>1553.3670</td>\n",
       "      <td>6</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>7</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0033-93-00471</td>\n",
       "      <td>1521.0442</td>\n",
       "      <td>7</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0020-35-13458</td>\n",
       "      <td>1458.4889</td>\n",
       "      <td>8</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0031-66-06129</td>\n",
       "      <td>1455.3568</td>\n",
       "      <td>9</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "  qid                        query                      docno      score  rank\n",
       "0   1  Should teachers get tenure?  clueweb22-en0031-49-02531  2800.1940     0\n",
       "1   1  Should teachers get tenure?  clueweb22-en0042-24-00769  1911.2747     1\n",
       "2   1  Should teachers get tenure?  clueweb22-en0011-57-13248  1896.7843     2\n",
       "3   1  Should teachers get tenure?  clueweb22-en0038-04-18313  1813.0868     3\n",
       "4   1  Should teachers get tenure?  clueweb22-en0022-88-08363  1807.3335     4\n",
       "5   1  Should teachers get tenure?  clueweb22-en0021-01-08109  1660.7153     5\n",
       "6   1  Should teachers get tenure?  clueweb22-en0032-04-03343  1553.3670     6\n",
       "7   1  Should teachers get tenure?  clueweb22-en0033-93-00471  1521.0442     7\n",
       "8   1  Should teachers get tenure?  clueweb22-en0020-35-13458  1458.4889     8\n",
       "9   1  Should teachers get tenure?  clueweb22-en0031-66-06129  1455.3568     9"
      ]
     },
     "execution_count": 3,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "chatnoir_cw22.search(\"Should teachers get tenure?\")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "### Run\n",
    "We can also use the pipeline to create a run for the task's topics.\n",
    "First, we need to download each task topics, then we can read them as a Pandas data frame."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {
    "collapsed": false
   },
   "outputs": [],
   "source": [
    "from requests import get\n",
    "from pandas import DataFrame, read_xml\n",
    "from pathlib import Path\n",
    "\n",
    "\n",
    "def download_read_topics(url: str, path: Path) -> DataFrame:\n",
    "    if not path.exists():\n",
    "        with path.open(\"wb\") as file:\n",
    "            file.write(get(url).content)\n",
    "    return read_xml(path).rename(columns={\"number\": \"qid\", \"title\": \"query\"}).drop(columns=[\"description\", \"narrative\"])"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {
    "collapsed": false
   },
   "outputs": [],
   "source": [
    "topics_task_1 = download_read_topics(\n",
    "    \"https://touche.webis.de/clef23/touche23-data/topics-task1.xml\",\n",
    "    Path(\"topics_task_1.xml\")\n",
    ")\n",
    "topics_task_2 = download_read_topics(\n",
    "    \"https://touche.webis.de/clef23/touche23-data/topics-task2.xml\",\n",
    "    Path(\"topics_task_2.xml\")\n",
    ")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "Now that we have loaded the topic, let's retrieve documents using ChatNoir."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "Searching with ChatNoir: 100%|██████████| 50/50 [02:11<00:00,  2.63s/query]\n"
     ]
    },
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>qid</th>\n",
       "      <th>query</th>\n",
       "      <th>docno</th>\n",
       "      <th>score</th>\n",
       "      <th>rank</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>220</th>\n",
       "      <td>23</td>\n",
       "      <td>Should euthanasia or physician-assisted suicid...</td>\n",
       "      <td>clueweb22-en0042-31-16353</td>\n",
       "      <td>6108.0728</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>221</th>\n",
       "      <td>23</td>\n",
       "      <td>Should euthanasia or physician-assisted suicid...</td>\n",
       "      <td>clueweb22-en0001-08-05007</td>\n",
       "      <td>5727.5960</td>\n",
       "      <td>1</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>222</th>\n",
       "      <td>23</td>\n",
       "      <td>Should euthanasia or physician-assisted suicid...</td>\n",
       "      <td>clueweb22-en0008-25-05854</td>\n",
       "      <td>5634.9614</td>\n",
       "      <td>2</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>200</th>\n",
       "      <td>21</td>\n",
       "      <td>Is human activity primarily responsible for gl...</td>\n",
       "      <td>clueweb22-en0008-57-07935</td>\n",
       "      <td>5532.1580</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>210</th>\n",
       "      <td>22</td>\n",
       "      <td>Is a two-state solution an acceptable solution...</td>\n",
       "      <td>clueweb22-en0043-34-00450</td>\n",
       "      <td>5198.2144</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>...</th>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>49</th>\n",
       "      <td>5</td>\n",
       "      <td>Should social security be privatized?</td>\n",
       "      <td>clueweb22-en0031-35-08958</td>\n",
       "      <td>1311.3025</td>\n",
       "      <td>9</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>446</th>\n",
       "      <td>45</td>\n",
       "      <td>Should the penny stay in circulation?</td>\n",
       "      <td>clueweb22-en0041-21-11026</td>\n",
       "      <td>1286.0981</td>\n",
       "      <td>6</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>447</th>\n",
       "      <td>45</td>\n",
       "      <td>Should the penny stay in circulation?</td>\n",
       "      <td>clueweb22-en0014-77-04826</td>\n",
       "      <td>1216.3386</td>\n",
       "      <td>7</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>448</th>\n",
       "      <td>45</td>\n",
       "      <td>Should the penny stay in circulation?</td>\n",
       "      <td>clueweb22-en0038-28-08817</td>\n",
       "      <td>1206.3966</td>\n",
       "      <td>8</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>449</th>\n",
       "      <td>45</td>\n",
       "      <td>Should the penny stay in circulation?</td>\n",
       "      <td>clueweb22-en0010-80-13555</td>\n",
       "      <td>1198.6305</td>\n",
       "      <td>9</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>500 rows × 5 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "     qid                                              query  \\\n",
       "220   23  Should euthanasia or physician-assisted suicid...   \n",
       "221   23  Should euthanasia or physician-assisted suicid...   \n",
       "222   23  Should euthanasia or physician-assisted suicid...   \n",
       "200   21  Is human activity primarily responsible for gl...   \n",
       "210   22  Is a two-state solution an acceptable solution...   \n",
       "..   ...                                                ...   \n",
       "49     5              Should social security be privatized?   \n",
       "446   45              Should the penny stay in circulation?   \n",
       "447   45              Should the penny stay in circulation?   \n",
       "448   45              Should the penny stay in circulation?   \n",
       "449   45              Should the penny stay in circulation?   \n",
       "\n",
       "                         docno      score  rank  \n",
       "220  clueweb22-en0042-31-16353  6108.0728     0  \n",
       "221  clueweb22-en0001-08-05007  5727.5960     1  \n",
       "222  clueweb22-en0008-25-05854  5634.9614     2  \n",
       "200  clueweb22-en0008-57-07935  5532.1580     0  \n",
       "210  clueweb22-en0043-34-00450  5198.2144     0  \n",
       "..                         ...        ...   ...  \n",
       "49   clueweb22-en0031-35-08958  1311.3025     9  \n",
       "446  clueweb22-en0041-21-11026  1286.0981     6  \n",
       "447  clueweb22-en0014-77-04826  1216.3386     7  \n",
       "448  clueweb22-en0038-28-08817  1206.3966     8  \n",
       "449  clueweb22-en0010-80-13555  1198.6305     9  \n",
       "\n",
       "[500 rows x 5 columns]"
      ]
     },
     "execution_count": 6,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "chatnoir_cw22.transform(topics_task_1)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "Searching with ChatNoir: 100%|██████████| 50/50 [02:05<00:00,  2.50s/query]\n"
     ]
    },
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>qid</th>\n",
       "      <th>query</th>\n",
       "      <th>cause</th>\n",
       "      <th>effect</th>\n",
       "      <th>docno</th>\n",
       "      <th>score</th>\n",
       "      <th>rank</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>380</th>\n",
       "      <td>39</td>\n",
       "      <td>Do microwave ovens cause cancer?</td>\n",
       "      <td>microwave ovens</td>\n",
       "      <td>cancer</td>\n",
       "      <td>clueweb22-en0009-17-04789</td>\n",
       "      <td>3995.74020</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>130</th>\n",
       "      <td>14</td>\n",
       "      <td>Can marijuana use cause brain damage?</td>\n",
       "      <td>marijuana use</td>\n",
       "      <td>brain damage</td>\n",
       "      <td>clueweb22-en0015-49-00744</td>\n",
       "      <td>3268.59990</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>430</th>\n",
       "      <td>44</td>\n",
       "      <td>Could an insulin resistance lead to obesity?</td>\n",
       "      <td>insulin resistance</td>\n",
       "      <td>obesity</td>\n",
       "      <td>clueweb22-en0039-06-01326</td>\n",
       "      <td>3160.06570</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>300</th>\n",
       "      <td>31</td>\n",
       "      <td>Does income inequality lead to higher economic...</td>\n",
       "      <td>income inequality</td>\n",
       "      <td>higher economic growth</td>\n",
       "      <td>clueweb22-en0034-44-02693</td>\n",
       "      <td>3052.70800</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>370</th>\n",
       "      <td>38</td>\n",
       "      <td>Does high blood pressure medication cause low ...</td>\n",
       "      <td>high blood pressure medication</td>\n",
       "      <td>low testosterone</td>\n",
       "      <td>clueweb22-en0019-31-06621</td>\n",
       "      <td>2983.64600</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>...</th>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "      <td>...</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>295</th>\n",
       "      <td>30</td>\n",
       "      <td>Could pirating media cause legal consequences?</td>\n",
       "      <td>pirating media</td>\n",
       "      <td>legal consequences</td>\n",
       "      <td>clueweb22-en0018-60-09569</td>\n",
       "      <td>666.32544</td>\n",
       "      <td>5</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>296</th>\n",
       "      <td>30</td>\n",
       "      <td>Could pirating media cause legal consequences?</td>\n",
       "      <td>pirating media</td>\n",
       "      <td>legal consequences</td>\n",
       "      <td>clueweb22-en0035-75-14958</td>\n",
       "      <td>662.34600</td>\n",
       "      <td>6</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>297</th>\n",
       "      <td>30</td>\n",
       "      <td>Could pirating media cause legal consequences?</td>\n",
       "      <td>pirating media</td>\n",
       "      <td>legal consequences</td>\n",
       "      <td>clueweb22-en0009-71-17661</td>\n",
       "      <td>620.21260</td>\n",
       "      <td>7</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>298</th>\n",
       "      <td>30</td>\n",
       "      <td>Could pirating media cause legal consequences?</td>\n",
       "      <td>pirating media</td>\n",
       "      <td>legal consequences</td>\n",
       "      <td>clueweb22-en0009-00-06856</td>\n",
       "      <td>614.21230</td>\n",
       "      <td>8</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>299</th>\n",
       "      <td>30</td>\n",
       "      <td>Could pirating media cause legal consequences?</td>\n",
       "      <td>pirating media</td>\n",
       "      <td>legal consequences</td>\n",
       "      <td>clueweb22-en0014-55-19248</td>\n",
       "      <td>610.25630</td>\n",
       "      <td>9</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>500 rows × 7 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "     qid                                              query  \\\n",
       "380   39                   Do microwave ovens cause cancer?   \n",
       "130   14              Can marijuana use cause brain damage?   \n",
       "430   44       Could an insulin resistance lead to obesity?   \n",
       "300   31  Does income inequality lead to higher economic...   \n",
       "370   38  Does high blood pressure medication cause low ...   \n",
       "..   ...                                                ...   \n",
       "295   30     Could pirating media cause legal consequences?   \n",
       "296   30     Could pirating media cause legal consequences?   \n",
       "297   30     Could pirating media cause legal consequences?   \n",
       "298   30     Could pirating media cause legal consequences?   \n",
       "299   30     Could pirating media cause legal consequences?   \n",
       "\n",
       "                              cause                  effect  \\\n",
       "380                 microwave ovens                  cancer   \n",
       "130                   marijuana use            brain damage   \n",
       "430              insulin resistance                 obesity   \n",
       "300               income inequality  higher economic growth   \n",
       "370  high blood pressure medication        low testosterone   \n",
       "..                              ...                     ...   \n",
       "295                  pirating media      legal consequences   \n",
       "296                  pirating media      legal consequences   \n",
       "297                  pirating media      legal consequences   \n",
       "298                  pirating media      legal consequences   \n",
       "299                  pirating media      legal consequences   \n",
       "\n",
       "                         docno       score  rank  \n",
       "380  clueweb22-en0009-17-04789  3995.74020     0  \n",
       "130  clueweb22-en0015-49-00744  3268.59990     0  \n",
       "430  clueweb22-en0039-06-01326  3160.06570     0  \n",
       "300  clueweb22-en0034-44-02693  3052.70800     0  \n",
       "370  clueweb22-en0019-31-06621  2983.64600     0  \n",
       "..                         ...         ...   ...  \n",
       "295  clueweb22-en0018-60-09569   666.32544     5  \n",
       "296  clueweb22-en0035-75-14958   662.34600     6  \n",
       "297  clueweb22-en0009-71-17661   620.21260     7  \n",
       "298  clueweb22-en0009-00-06856   614.21230     8  \n",
       "299  clueweb22-en0014-55-19248   610.25630     9  \n",
       "\n",
       "[500 rows x 7 columns]"
      ]
     },
     "execution_count": 7,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "chatnoir_cw22.transform(topics_task_2)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "As you see, [ChatNoir](https://chatnoir.eu/) is an easy way to retrieve documents from the ClueWeb22.\n",
    "For your submission, you can integrate the `ChatNoirRetrieve` PyTerrier module as a first retrieval stage and then build your own re-ranking stages on top."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": false
   },
   "source": [
    "## Features\n",
    "Many re-rankers need the document text or other features for re-ranking documents.\n",
    "Using `chatnoir-pyterrier`, you can select which features should be included in the result dataframe by selecting from `Feature` flags."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "Searching with ChatNoir: 100%|██████████| 1/1 [00:10<00:00, 10.49s/query]\n"
     ]
    },
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>qid</th>\n",
       "      <th>query</th>\n",
       "      <th>docno</th>\n",
       "      <th>score</th>\n",
       "      <th>title_text</th>\n",
       "      <th>text</th>\n",
       "      <th>contents_plain</th>\n",
       "      <th>rank</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0031-49-02531</td>\n",
       "      <td>2800.1940</td>\n",
       "      <td>Pro &amp; Con Quotes: Should Teachers Get Tenure? ...</td>\n",
       "      <td>Last updated on: 1/13/2011 | Author: ProCon.or...</td>\n",
       "      <td>Last updated on: 1/13/2011 | Author: ProCon.or...</td>\n",
       "      <td>0</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0042-24-00769</td>\n",
       "      <td>1911.2747</td>\n",
       "      <td>Teacher Tenure - Pros &amp; Cons - ProCon.org</td>\n",
       "      <td>Last updated on: 1/13/2011 | Author: ProCon.or...</td>\n",
       "      <td>Last updated on: 1/13/2011 | Author: ProCon.or...</td>\n",
       "      <td>1</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0011-57-13248</td>\n",
       "      <td>1896.7843</td>\n",
       "      <td>Teacher Tenure Laws | LegalMatch</td>\n",
       "      <td>Most states have laws that protect public scho...</td>\n",
       "      <td>Most states have laws that protect public scho...</td>\n",
       "      <td>2</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0038-04-18313</td>\n",
       "      <td>1813.0868</td>\n",
       "      <td>What Is Teacher Tenure? | Education.com</td>\n",
       "      <td>Charter schools, merit pay, vouchers, oh my! T...</td>\n",
       "      <td>Charter schools, merit pay, vouchers, oh my! T...</td>\n",
       "      <td>3</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0022-88-08363</td>\n",
       "      <td>1807.3335</td>\n",
       "      <td>Tenure | American Federation of Teachers</td>\n",
       "      <td>Tenure\\n\\nShare This\\nPrint\\n\\nHow Due Process...</td>\n",
       "      <td>Tenure\\n\\nShare This\\nPrint\\n\\nHow Due Process...</td>\n",
       "      <td>4</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>5</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0021-01-08109</td>\n",
       "      <td>1660.7153</td>\n",
       "      <td>Argumentative Essay: Should Teachers Get Paid?...</td>\n",
       "      <td>Argumentative Essay: Should Teachers Get Paid?...</td>\n",
       "      <td>Argumentative Essay: Should Teachers Get Paid?...</td>\n",
       "      <td>5</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>6</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0032-04-03343</td>\n",
       "      <td>1553.3670</td>\n",
       "      <td>Teachers and Tenure: Both Sides of the Heated ...</td>\n",
       "      <td>Teachers and Tenure: Both Sides of the Heated ...</td>\n",
       "      <td>Teachers and Tenure: Both Sides of the Heated ...</td>\n",
       "      <td>6</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>7</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0033-93-00471</td>\n",
       "      <td>1521.0442</td>\n",
       "      <td>New York Teacher Tenure Rights - Horton Law PL...</td>\n",
       "      <td>Home » New York Management Law Blog » New York...</td>\n",
       "      <td>Home » New York Management Law Blog » New York...</td>\n",
       "      <td>7</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>8</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0020-35-13458</td>\n",
       "      <td>1458.4889</td>\n",
       "      <td>Do you think teachers should get paid more? | ...</td>\n",
       "      <td>Do you think teachers should get paid more? | ...</td>\n",
       "      <td>Do you think teachers should get paid more? | ...</td>\n",
       "      <td>8</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>9</th>\n",
       "      <td>1</td>\n",
       "      <td>Should teachers get tenure?</td>\n",
       "      <td>clueweb22-en0031-66-06129</td>\n",
       "      <td>1455.3568</td>\n",
       "      <td>Tenure</td>\n",
       "      <td>Tenure Skip to main content\\nFull Menu\\n\\nTenu...</td>\n",
       "      <td>Tenure Skip to main content\\nFull Menu\\n\\nTenu...</td>\n",
       "      <td>9</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "  qid                        query                      docno      score  \\\n",
       "0   1  Should teachers get tenure?  clueweb22-en0031-49-02531  2800.1940   \n",
       "1   1  Should teachers get tenure?  clueweb22-en0042-24-00769  1911.2747   \n",
       "2   1  Should teachers get tenure?  clueweb22-en0011-57-13248  1896.7843   \n",
       "3   1  Should teachers get tenure?  clueweb22-en0038-04-18313  1813.0868   \n",
       "4   1  Should teachers get tenure?  clueweb22-en0022-88-08363  1807.3335   \n",
       "5   1  Should teachers get tenure?  clueweb22-en0021-01-08109  1660.7153   \n",
       "6   1  Should teachers get tenure?  clueweb22-en0032-04-03343  1553.3670   \n",
       "7   1  Should teachers get tenure?  clueweb22-en0033-93-00471  1521.0442   \n",
       "8   1  Should teachers get tenure?  clueweb22-en0020-35-13458  1458.4889   \n",
       "9   1  Should teachers get tenure?  clueweb22-en0031-66-06129  1455.3568   \n",
       "\n",
       "                                          title_text  \\\n",
       "0  Pro & Con Quotes: Should Teachers Get Tenure? ...   \n",
       "1          Teacher Tenure - Pros & Cons - ProCon.org   \n",
       "2                   Teacher Tenure Laws | LegalMatch   \n",
       "3            What Is Teacher Tenure? | Education.com   \n",
       "4           Tenure | American Federation of Teachers   \n",
       "5  Argumentative Essay: Should Teachers Get Paid?...   \n",
       "6  Teachers and Tenure: Both Sides of the Heated ...   \n",
       "7  New York Teacher Tenure Rights - Horton Law PL...   \n",
       "8  Do you think teachers should get paid more? | ...   \n",
       "9                                             Tenure   \n",
       "\n",
       "                                                text  \\\n",
       "0  Last updated on: 1/13/2011 | Author: ProCon.or...   \n",
       "1  Last updated on: 1/13/2011 | Author: ProCon.or...   \n",
       "2  Most states have laws that protect public scho...   \n",
       "3  Charter schools, merit pay, vouchers, oh my! T...   \n",
       "4  Tenure\\n\\nShare This\\nPrint\\n\\nHow Due Process...   \n",
       "5  Argumentative Essay: Should Teachers Get Paid?...   \n",
       "6  Teachers and Tenure: Both Sides of the Heated ...   \n",
       "7  Home » New York Management Law Blog » New York...   \n",
       "8  Do you think teachers should get paid more? | ...   \n",
       "9  Tenure Skip to main content\\nFull Menu\\n\\nTenu...   \n",
       "\n",
       "                                      contents_plain  rank  \n",
       "0  Last updated on: 1/13/2011 | Author: ProCon.or...     0  \n",
       "1  Last updated on: 1/13/2011 | Author: ProCon.or...     1  \n",
       "2  Most states have laws that protect public scho...     2  \n",
       "3  Charter schools, merit pay, vouchers, oh my! T...     3  \n",
       "4  Tenure\\n\\nShare This\\nPrint\\n\\nHow Due Process...     4  \n",
       "5  Argumentative Essay: Should Teachers Get Paid?...     5  \n",
       "6  Teachers and Tenure: Both Sides of the Heated ...     6  \n",
       "7  Home » New York Management Law Blog » New York...     7  \n",
       "8  Do you think teachers should get paid more? | ...     8  \n",
       "9  Tenure Skip to main content\\nFull Menu\\n\\nTenu...     9  "
      ]
     },
     "execution_count": 8,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "from chatnoir_pyterrier.retrieve import ChatNoirRetrieve, Feature\n",
    "\n",
    "features = Feature.CONTENTS_PLAIN | Feature.TITLE_TEXT  # plain text and title\n",
    "chatnoir_all = ChatNoirRetrieve(index=\"clueweb22/b\", features=features, verbose=True)\n",
    "chatnoir_all.search(\"Should teachers get tenure?\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "metadata": {
    "collapsed": false
   },
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": ".venv",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.12.3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 0
}