add documentation for kaggle functions

Author: betaBison

gnss_lib_py/parsers/android.py

@@ -532,7 +532,7 @@ def solve_kaggle_baseline(navdata):
 
     return state_estimate
 
-def prepare_kaggle_submission(state_estimate, trip_id):
+def prepare_kaggle_submission(state_estimate, trip_id="trace/phone"):
     """Converts from gnss_lib_py receiver state to Kaggle submission.
 
     Parameters

notebooks/tutorials/parsers.ipynb

@@ -137,6 +137,84 @@
     "gt_data.rows"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "c849214b",
+   "metadata": {},
+   "source": [
+    "# 2022 Google Decimeter Kaggle Challenge\n",
+    "There are utility functions to prepare Kaggle submissions for the 2022 challenge."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "83ac7998",
+   "metadata": {},
+   "source": [
+    "We offer a function to convert the provided Weighted Least Squares baseline solution into the standard `state_estimate` format found throughout `gnss_lib_py`. Simply pass in the derived data NavData object."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "a990ec31",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from gnss_lib_py.parsers.android import solve_kaggle_baseline\n",
+    "\n",
+    "state_estimate = solve_kaggle_baseline(derived_data)\n",
+    "\n",
+    "print(state_estimate)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "f1504d5d",
+   "metadata": {},
+   "source": [
+    "`prepare_kaggle_submission` can be used to convert the standard `state_estimate` format to a NavData object with the same rows and row names which the 2022 Kaggle competition expects. The `trip_id` is a combination of the trajectory trace name and phone name."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "22f43b10",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from gnss_lib_py.parsers.android import prepare_kaggle_submission\n",
+    "\n",
+    "solution = prepare_kaggle_submission(state_estimate, trip_id = \"my_trace/my_phone\")\n",
+    "\n",
+    "print(solution)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "7e8879f2",
+   "metadata": {},
+   "source": [
+    "`solve_kaggle_dataset` can be used to automatically iterate through all trace trajectory names and phone names, estimate the state using the provided solver, and concatenate all state estimates together for a single submission. The `solver` variable could use `solve_kaggle_baseline`, `solve_wls`, or `solve_gnss_ekf` for example.\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "49659881",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from gnss_lib_py.parsers.android import solve_kaggle_dataset\n",
+    "from gnss_lib_py.algorithms.snapshot import solve_wls\n",
+    "\n",
+    "# submission = solve_kaggle_dataset(folder_path = \"/path/to/train/or/test/folder/\", \n",
+    "#                                   solver = solve_wls)\n",
+    "\n",
+    "# after the submission NavData object is created, save it to a csv with:\n",
+    "# submission.to_csv(\"file_path.csv\")"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "0f78bfdb",