updated outdated syntax in the notebooks

Author: pavelkomarov

examples/2a_optimizing_parameters_with_dxdt_known.ipynb

@@ -97,12 +97,13 @@
     "from pynumdiff.optimize import optimize\n",
     "from pynumdiff.module import method\n",
     "\n",
-    "search_space = {'param1':[values], 'param2':[values], ...}\n",
+    "search_space_updates = {'param1':[values], 'param2':[values], ...}\n",
     "\n",
-    "params, val = optimize(method, x, dt, search_space, \n",
+    "params, val = optimize(method, x, dt,\n",
     "                    tvgamma=tvgamma, # hyperparameter\n",
-    "                    dxdt_truth=dxdt_truth) # defaults to None if no ground truth data\n",
-    "   \n",
+    "                    dxdt_truth=dxdt_truth, # defaults to None if no ground truth data\n",
+    "                    search_space_updates=search_space_updates)\n",
+    "\t\t\t\t\t\n",
     "x_hat, dxdt_hat = method(x, dt, **params)\n",
     "```\n",
     "\n",

examples/2b_optimizing_parameters_with_dxdt_unknown.ipynb

@@ -108,7 +108,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 4,
    "metadata": {},
    "outputs": [
     {
@@ -137,11 +137,12 @@
     "from pynumdiff.optimize import optimize\n",
     "from pynumdiff.module import method\n",
     "\n",
-    "search_space = {'param1':[values], 'param2':[values], ...}\n",
+    "search_space_updates = {'param1':[values], 'param2':[values], ...}\n",
     "\n",
-    "params, val = optimize(method, x, dt, search_space, \n",
+    "params, val = optimize(method, x, dt,\n",
     "                    tvgamma=tvgamma, # hyperparameter\n",
-    "                    dxdt_truth=dxdt_truth) # defaults to None if no ground truth data\n",
+    "                    dxdt_truth=dxdt_truth, # defaults to None if no ground truth data\n",
+    "                    search_space_updates=search_space_updates)\n",
     "   \n",
     "x_hat, dxdt_hat = method(x, dt, **params)\n",
     "```\n",
@@ -520,7 +521,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 6,
    "metadata": {},
    "outputs": [
     {

pynumdiff/optimize/_optimize.py

@@ -61,7 +61,7 @@
                  {'s': (1e-2, 1e6),
                   'num_iterations': (1, 10)}),
     tvrdiff: ({'gamma': [1e-2, 1e-1, 1, 10, 100, 1000],
-               'order': {1, 2, 3}}, # categorical, because order is whole number, and there aren't many choices
+               'order': {1, 2, 3}}, # warning: order 1 hacks the loss function when tvgamma is used, tends to win but is usually suboptimal choice in terms of true RMSE
               {'gamma': (1e-4, 1e7)}),
     velocity: ({'gamma': [1e-2, 1e-1, 1, 10, 100, 1000]},
                {'gamma': (1e-4, 1e7)}),