SearchLibrium 0.0.153__tar.gz → 0.0.155__tar.gz

{searchlibrium-0.0.153/src/SearchLibrium.egg-info → searchlibrium-0.0.155}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: SearchLibrium
-Version: 0.0.153
+Version: 0.0.155
 Summary: A Python package for econometric models driven by search
 Author: Mario Fernando Taco Morales, Alexander Paz, Prithvi Beeramole, Robert Burdett
 Author-email: Zeke Ahern <z.ahern@qut.edu.au>

{searchlibrium-0.0.153 → searchlibrium-0.0.155}/pyproject.toml

@@ -82,7 +82,7 @@ Documentation = "https://pypi.org/project/SearchLibrium/"
 realpython = "SearchLibrium.__main__:main"
 
 [tool.bumpver]
-current_version = "0.0.153"
+current_version = "0.0.155"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message = "[skip ci] Bump version {old_version} -> {new_version}"
 commit = true

{searchlibrium-0.0.153 → searchlibrium-0.0.155}/src/SearchLibrium/MixedLogitGSE.py

@@ -11,6 +11,16 @@ Usage:
   mxl = MixedLogitGSE()
   mxl.setup(..., gradient_scores=g_avg, random_gamma=False)
   mxl.fit()
+
+Larch equivalence (kept in sync with test_runs_tours stage-5 mode model):
+  The model β_nk = μ_k + γ_k·g_nk + σ_k·η_nk decomposes term-by-term into a
+  plain Larch mixed logit, since β_nk multiplies x_k in the utility:
+      μ_k·x_k          → ordinary fixed utility term         P('c_k')  * X('x_k')
+      γ_k·(g_nk·x_k)   → systematic gradient interaction     P('g_k')  * X('x_k * g')
+      σ_k·(η_nk·x_k)   → Normal random coefficient           mixtures.append(Normal('c_k','s_k'))
+  random_gamma=True adds τ_k·z_nk·g_nk, i.e. promoting the γ_k loadings to
+  random coefficients too (Normal mixtures on the g_k params in the Larch build).
+  See stage5_destination_choice._estimate_mixed_logit for the mirrored build.
 """
 
 import numpy as np
@@ -37,13 +47,24 @@ class MixedLogitGSE(MixedLogit):
     def setup(self, *args, gradient_scores=None, random_gamma=False, **kwargs):
         self.random_gamma = bool(random_gamma)
         if gradient_scores is not None:
-            # Standardise to O(1) to prevent numerical overflow
+            # Standardise each gradient column to mean 0 / std 1 (O(1)) so the
+            # γ loadings are on a common scale and can't numerically overflow.
+            # Centering matters: an uncentred score folds a spurious γ·mean/std
+            # shift into μ; centring keeps μ interpretable as the population mean.
+            # A constant (zero-variance) column would divide by ~0 and blow up to
+            # ~1e8 — guard it by leaving such columns at 0 (they carry no gradient
+            # information anyway).
             g = np.asarray(gradient_scores, dtype=float)
-            self.gradient_scores = g / (g.std(axis=0, keepdims=True) + 1e-8)
-            gstd = g.std(axis=0)
+            gmu = g.mean(axis=0, keepdims=True)
+            gsd = g.std(axis=0, keepdims=True)
+            gsd_safe = np.where(gsd < 1e-8, 1.0, gsd)
+            self.gradient_scores = (g - gmu) / gsd_safe
+            n_const = int(np.sum(gsd < 1e-8))
             print(f"[MixedLogitGSE] Gradient loadings enabled (Kgrad={len(kwargs.get('randvars', {}))}, "
                   f"random_gamma={self.random_gamma}, "
-                  f"gradient std range=[{gstd.min():.2f}, {gstd.max():.2f}] -> standardised)")
+                  f"raw std range=[{float(gsd.min()):.2f}, {float(gsd.max()):.2f}] -> "
+                  f"centred+standardised"
+                  + (f", {n_const} constant column(s) zeroed" if n_const else "") + ")")
         else:
             self.gradient_scores = None
         super().setup(*args, **kwargs)
@@ -87,7 +108,14 @@ class MixedLogitGSE(MixedLogit):
             self.Kgrad = self.Kr
             self.Kgrad_w = self.Kr if self.random_gamma else 0
             if self.Kgrad_w > 0:
-                self.gamma_draws = np.random.randn(self.N, self.Kgrad)
+                # Seed the random-γ (τ·z) draws so a fit is reproducible across
+                # runs — unseeded np.random.randn made every fit non-deterministic
+                # (and non-comparable in a search). Reuse the model's own seed
+                # when set, mixing in Kgrad so it differs from the η draws' seed.
+                _seed = getattr(self, "seed", None)
+                rng = np.random.default_rng(None if _seed is None
+                                            else int(_seed) + 10007 * self.Kgrad)
+                self.gamma_draws = rng.standard_normal((self.N, self.Kgrad))
         # Force JAX-only (scipy fallback doesn't handle gradient loadings)
         self._jax = True
         super().fit()

{searchlibrium-0.0.153 → searchlibrium-0.0.155}/src/SearchLibrium/__init__.py

@@ -106,6 +106,7 @@ try:
     from .latent_class import LatentClassMixedLogit
     from .mdcev import MDCEVFitResult, MDCEVModel
     from .multinomial_probit import MultinomialProbit
+    from .MixedLogitGSE import MixedLogitGSE
     from .RandomP import RandomParameters
     from .constraints_builder import ConstraintBuilder, create_constraints
     from .search import Parameters
@@ -131,6 +132,7 @@ except ImportError as e:
     from latent_class import LatentClassMixedLogit
     from mdcev import MDCEVFitResult, MDCEVModel
     from multinomial_probit import MultinomialProbit
+    from MixedLogitGSE import MixedLogitGSE
     from RandomP import RandomParameters
     from constraints_builder import ConstraintBuilder, create_constraints
     from search import Parameters

{searchlibrium-0.0.153 → searchlibrium-0.0.155}/src/SearchLibrium/harmony.py

@@ -949,10 +949,11 @@ class HarmonySearch(Search):
         """Identify groups of variables that measure similar constructs
         and can be substituted for one another."""
         groups = []
-        # Group 1: destination size measures
+        # Group 1: destination size measures (now includes per-type ACDC)
         size_measures = [v for v in asvars
                          if v in {'ln_dest_trips', 'osm_destination_pull',
-                                  'acdc_aggl', 'osm_poi_intensity'}]
+                                  'acdc_aggl', 'osm_poi_intensity'}
+                         or v.startswith('acdc_aggl_')]
         for i in range(len(size_measures)):
             for j in range(i + 1, len(size_measures)):
                 groups.append((size_measures[i], size_measures[j]))
@@ -972,6 +973,25 @@ class HarmonySearch(Search):
             for j in range(i + 1, len(osm_measures)):
                 groups.append((osm_measures[i], osm_measures[j]))
 
+        # Group 4: Per-type ACDC agglomeration terms (substitutable by OSM type)
+        per_type_aggl = [v for v in asvars if v.startswith('acdc_aggl_')]
+        for i in range(len(per_type_aggl)):
+            for j in range(i + 1, len(per_type_aggl)):
+                groups.append((per_type_aggl[i], per_type_aggl[j]))
+
+        # Group 5: Per-type ACDC competition terms (substitutable by OSM type)
+        per_type_comp = [v for v in asvars if v.startswith('acdc_comp_')]
+        for i in range(len(per_type_comp)):
+            for j in range(i + 1, len(per_type_comp)):
+                groups.append((per_type_comp[i], per_type_comp[j]))
+
+        # Group 6: Cross-substitution — agglomeration <-> competition for same type
+        for t in ['retail', 'food', 'leisure', 'parks', 'transit', 'cycleway', 'culture']:
+            aggl_var = f'acdc_aggl_{t}'
+            comp_var = f'acdc_comp_{t}'
+            if aggl_var in asvars and comp_var in asvars:
+                groups.append((aggl_var, comp_var))
+
         return groups
 
     def _get_forced_vars(self):

searchlibrium-0.0.155/src/SearchLibrium/version.txt

@@ -0,0 +1 @@
+0.0.155

{searchlibrium-0.0.153 → searchlibrium-0.0.155/src/SearchLibrium.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: SearchLibrium
-Version: 0.0.153
+Version: 0.0.155
 Summary: A Python package for econometric models driven by search
 Author: Mario Fernando Taco Morales, Alexander Paz, Prithvi Beeramole, Robert Burdett
 Author-email: Zeke Ahern <z.ahern@qut.edu.au>

searchlibrium-0.0.153/src/SearchLibrium/version.txt

@@ -1 +0,0 @@
-0.0.153