add update details from v0.10.0 to updates.md

- replace max_iter_num with max_iter in tutorial.ipynb and usecases.md
  to be consistent with the codebase.

Author: jdlph

README.md

@@ -35,7 +35,7 @@ $ pip install path4gmns
 ```
 
 > [!IMPORTANT]
-> v0.10.0 introduces the link-based UE that adopts the Frank-Wolfe algorithm with line search. As it does not preserve any paths, each iteration runs faster than the path-based procedure with less memory footprint. Please **discard all old versions**.
+> v0.10.0 introduces the link-based UE that adopts the Frank-Wolfe algorithm with line search. As it does not preserve any paths, each iteration runs faster than the path-based procedure with less memory footprint. Besides, it fixes potential issues on invoking DTALite. Please **discard all old versions**.
 
 > [!WARNING]
 > find_shortest_path() computes the shortest path per travel time rather than distance for v0.9.9.post1 and any earlier versions. See [Issue #58](https://github.com/jdlph/Path4GMNS/issues/58) for details. v0.9.10 offers the correct implementation with the flexibility to switch between time and distance.

docs/source/updates.md

@@ -70,5 +70,12 @@
 68. Adaptively display the path distance per the length unit passed to read_network() (v0.9.10)
 69. Introduce get_shortest_path_tree() to return the shortest path tree from a given source node (v0.9.10)
 70. Remove deprecated APIs including perform_column_generation(), perform_network_assignment(), perform_network_assignment(), and perform_network_assignment_DTALite() (v0.9.10)
+71. Introduce generic downloading functions to replace download_sample_data_sets() (v0.10.0)
+72. Introduce DTALiteClassic() and DTALiteMultimodal() to replace perform_network_assignment_DTALite() and
+  run_DTALite(), respectively (v0.10.0)
+73. Add multiprocessing exception handling to DTALiteClassic() (v0.10.0)
+74. Fix segmentation fault on DTALiteMultimodal() with Python 3.8 on Linux (v0.10.0)
+75. Introduce link-based UE with find_ue_fw() (v0.10.0)
+76. Optimize IO by precluding path geometry as default when outputting route_assignment.csv (v0.10.0)
 
 Detailed update information can be found in [Releases](https://github.com/jdlph/Path4GMNS/releases).

docs/source/usecases.md

@@ -236,7 +236,7 @@ pg.output_link_performance(network)
 
 # NOTE that pg.output_columns(network) is NOT available under the link-based UE!
 ```
-find_ue_fw() will terminate when it reaches the maximum number of iterations (**max_iter_num**) or the target relative gap (**rel_gap_tolerance**), whichever comes first. The default values are **40** and **1e-04**, respectively. You can specify
+find_ue_fw() will terminate when it reaches the maximum number of iterations (**max_iter**) or the target relative gap (**rel_gap_tolerance**), whichever comes first. The default values are **40** and **1e-04**, respectively. You can specify
 their values toward your own need like below.
 
 ```python
@@ -245,7 +245,7 @@ import path4gmns as pg
 network = pg.read_network()
 pg.read_demand(network)
 
-pg.find_ue_fw(network, max_iter_num=100, rel_gap_tolerance=1e-6)
+pg.find_ue_fw(network, max_iter=100, rel_gap_tolerance=1e-6)
 pg.output_link_performance(network)
 
 # NOTE that pg.output_columns(network) is NOT available under the link-based UE!

path4gmns/fw.py

@@ -199,7 +199,7 @@ def find_ue_fw(ui, max_iter=40, rel_gap_tolerance=1e-04):
 
     Note
     ----
-    You will need to call output_link_performance() toget the assignment
+    You will need to call output_link_performance() to get the assignment
     results, i.e., volumes and other link attributes on each link (in
     link_performance.csv).
     """

tutorial/tutorial.ipynb

@@ -387,7 +387,7 @@
    "id": "bf333d6c",
    "metadata": {},
    "source": [
-    "find_ue_fw() will terminate when it reaches the maximum number of iterations (**max_iter_num**) or the target relative gap (**rel_gap_tolerance**), whichever comes first. The default values are **40** and **1e-04**, respectively. You can adjust\n",
+    "find_ue_fw() will terminate when it reaches the maximum number of iterations (**max_iter**) or the target relative gap (**rel_gap_tolerance**), whichever comes first. The default values are **40** and **1e-04**, respectively. You can adjust\n",
     "their values toward your own need like below."
    ]
   },
@@ -401,7 +401,7 @@
     "network = pg.read_network()\n",
     "pg.read_demand(network)\n",
     "\n",
-    "pg.find_ue_fw(network, max_iter_num=100, rel_gap_tolerance=1e-6)\n",
+    "pg.find_ue_fw(network, max_iter=100, rel_gap_tolerance=1e-6)\n",
     "pg.output_link_performance(network)\n",
     "\n",
     "# NOTE that pg.output_columns(network) is NOT available under the link-based UE!"