Deploying to gh-pages from @ 44cdec4 🚀

Author: m-richards

_sources/api/data_loading.rst.txt

@@ -0,0 +1,7 @@
+recursiveRouteChoice
+====================
+
+.. toctree::
+   :maxdepth: 4
+
+   recursiveRouteChoice

_sources/api/data_processing.rst.txt

@@ -0,0 +1,7 @@
+Data Loading: (recursiveRouteChoice.data\_loading)
+-----------------------------------------------------------
+
+.. automodule:: recursiveRouteChoice.data_loading
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/api/modules.rst.txt

@@ -0,0 +1,7 @@
+Data Preprocessing: (recursiveRouteChoice.data\_processing)
+-----------------------------------------------------------
+
+.. automodule:: recursiveRouteChoice.data_processing
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/api/optimisers.rst.txt

@@ -0,0 +1,50 @@
+Optimisers Submodule: Main use case
+===================================
+
+
+recursiveRouteChoice.optimisers.optimisers\_file
+------------------------------------------------
+Main user access point to optimisers module, note that important pieces are already directly
+imported into the optimisers module namespace. The main class of interest is :code:`ScipyOptimiser`
+which provides an interface to the SciPy optimisation algorithms for the recursive logit.
+
+.. automodule:: recursiveRouteChoice.optimisers.optimisers_file
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Optimisers Submodule: Other files with minimal public API
+=========================================================
+
+recursiveRouteChoice.optimisers.extra\_optim module
+---------------------------------------------------
+
+.. automodule:: recursiveRouteChoice.optimisers.extra_optim
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+recursiveRouteChoice.optimisers.hessian\_approx module
+------------------------------------------------------
+
+.. automodule:: recursiveRouteChoice.optimisers.hessian_approx
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+recursiveRouteChoice.optimisers.line\_search module
+---------------------------------------------------
+
+.. automodule:: recursiveRouteChoice.optimisers.line_search
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+..
+    Module contents
+    ---------------
+
+    .. automodule:: recursiveRouteChoice.optimisers
+       :members:
+       :undoc-members:
+       :show-inheritance:

_sources/api/recursive_route_choice.rst.txt

@@ -0,0 +1,8 @@
+Model: Sherman Morrison Variant (recursiveRouteChoice.recursive\_logit\_efficient\_update)
+-------------------------------------------------------------------------------------------------------------------
+Separate prediction and estimation classes using the more efficient recursive logit model variant.
+
+.. automodule:: recursiveRouteChoice.recursive_logit_efficient_update
+   :members:
+   :undoc-members:
+   :show-inheritance: