SearchLibrium 0.0.265__tar.gz → 0.0.268__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. {searchlibrium-0.0.265/src/SearchLibrium.egg-info → searchlibrium-0.0.268}/PKG-INFO +1 -1
  2. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/pyproject.toml +1 -1
  3. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/__init__.py +3 -1
  4. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/larch_models.py +99 -28
  5. searchlibrium-0.0.268/src/SearchLibrium/version.txt +1 -0
  6. {searchlibrium-0.0.265 → searchlibrium-0.0.268/src/SearchLibrium.egg-info}/PKG-INFO +1 -1
  7. searchlibrium-0.0.265/src/SearchLibrium/version.txt +0 -1
  8. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/LICENSE +0 -0
  9. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/MANIFEST.in +0 -0
  10. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/README.md +0 -0
  11. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/setup.cfg +0 -0
  12. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/BEHier.py +0 -0
  13. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/Halton.py +0 -0
  14. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/MixedLogit.py +0 -0
  15. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/MixedLogitGSE.py +0 -0
  16. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/Mode_Activity_Nested.py +0 -0
  17. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/RandomP.py +0 -0
  18. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/SEARCH_SM_MARIO.py +0 -0
  19. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/Two_Level_Nest.py +0 -0
  20. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/__main__.py +0 -0
  21. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/_choice_model.py +0 -0
  22. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/_device.py +0 -0
  23. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/abm.py +0 -0
  24. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/accessibility.py +0 -0
  25. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/banditsa.py +0 -0
  26. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/boxcox_functions.py +0 -0
  27. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/call_meta.py +0 -0
  28. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/constraints_builder.py +0 -0
  29. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/coupled_solver.py +0 -0
  30. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/data/Swissmetro_final.csv +0 -0
  31. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/data/TravelMode.csv +0 -0
  32. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/data/electricity.csv +0 -0
  33. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/destination_distances.py +0 -0
  34. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/harmony.py +0 -0
  35. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/hspbil.py +0 -0
  36. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/jax_utils.py +0 -0
  37. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/larch_compat.py +0 -0
  38. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/latent_class.py +0 -0
  39. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/latent_spec.py +0 -0
  40. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/logistic_regression.py +0 -0
  41. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/main.py +0 -0
  42. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/main_debug.py +0 -0
  43. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/mdcev.py +0 -0
  44. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/mh_choice_estimator.py +0 -0
  45. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/misc.py +0 -0
  46. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/mixed_logit.py +0 -0
  47. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/mixed_nested.py +0 -0
  48. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/mixedrrm.py +0 -0
  49. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/multinomial_logit.py +0 -0
  50. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/multinomial_nested.py +0 -0
  51. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/multinomial_probit.py +0 -0
  52. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/numba_engine.py +0 -0
  53. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/numba_mxl.py +0 -0
  54. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/numba_rrm.py +0 -0
  55. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/ordered_logit.py +0 -0
  56. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/ordered_logit_mixed.py +0 -0
  57. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/predict.py +0 -0
  58. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/regularization.py +0 -0
  59. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/rrm.py +0 -0
  60. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/sample_data.py +0 -0
  61. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/sapbil.py +0 -0
  62. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/search.py +0 -0
  63. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/selection_models.py +0 -0
  64. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/setup.py +0 -0
  65. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/siman.py +0 -0
  66. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/skims.py +0 -0
  67. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/sparseea_agds.py +0 -0
  68. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/test_lc_de.py +0 -0
  69. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/test_mario_searches.py +0 -0
  70. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/test_sapbil_vs_banditsa.py +0 -0
  71. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/threshold.py +0 -0
  72. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium/zero_inflated_ordered_probit.py +0 -0
  73. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium.egg-info/SOURCES.txt +0 -0
  74. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium.egg-info/dependency_links.txt +0 -0
  75. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium.egg-info/entry_points.txt +0 -0
  76. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium.egg-info/requires.txt +0 -0
  77. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/src/SearchLibrium.egg-info/top_level.txt +0 -0
  78. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/tests/test_destination_distances.py +0 -0
  79. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/tests/test_jax_mask_equivalence.py +0 -0
  80. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/tests/test_larch_integration.py +0 -0
  81. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/tests/test_lc_smart_init.py +0 -0
  82. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/tests/test_mh_choice_estimator.py +0 -0
  83. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/tests/test_mxl_random_starts.py +0 -0
  84. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/tests/test_per_alternative_random.py +0 -0
  85. {searchlibrium-0.0.265 → searchlibrium-0.0.268}/tests/test_zero_inflated_ordered_probit.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: SearchLibrium
3
- Version: 0.0.265
3
+ Version: 0.0.268
4
4
  Summary: Automated specification search for discrete choice models (logit, mixed logit, nested logit, RRM and more) using metaheuristic optimisation
5
5
  Author: Zeke Ahern, Mario Fernando Taco Morales, Alexander Paz, Prithvi Beeramole, Robert Burdett
6
6
  Maintainer-email: Zeke Ahern <z.ahern@qut.edu.au>
@@ -132,7 +132,7 @@ Documentation = "https://pypi.org/project/SearchLibrium/"
132
132
  realpython = "SearchLibrium.__main__:main"
133
133
 
134
134
  [tool.bumpver]
135
- current_version = "0.0.265"
135
+ current_version = "0.0.268"
136
136
  version_pattern = "MAJOR.MINOR.PATCH"
137
137
  commit_message = "[skip ci] Bump version {old_version} -> {new_version}"
138
138
  commit = true
@@ -193,7 +193,8 @@ _IMPORT_GROUPS = [
193
193
  ('jax_utils', ['ensure_jax_environment', 'is_large_model',
194
194
  'estimate_row_guard', 'check_gradient_health']),
195
195
  ('larch_compat', ['apply_larch_patches']),
196
- ('larch_models', ['LarchMNL', 'LarchNestedLogit', 'LarchMixedLogit']),
196
+ ('larch_models', ['LarchMNL', 'LarchNestedLogit', 'LarchMixedLogit',
197
+ 'build_latent_class']),
197
198
  ('skims', ['omx_to_dataframe', 'read_omx_skims', 'prepare_skims_from_omx',
198
199
  'merge_skim_component']),
199
200
  ('destination_distances', ['haversine_km', 'pick_skim_matrices',
@@ -252,6 +253,7 @@ __all__ = [
252
253
  "elasticnet_objective", "elasticnet_penalty_and_grad", "nl_identification_priors",
253
254
  "ensure_jax_environment", "is_large_model", "estimate_row_guard", "check_gradient_health",
254
255
  "apply_larch_patches", "LarchMNL", "LarchNestedLogit", "LarchMixedLogit",
256
+ "build_latent_class",
255
257
  "omx_to_dataframe", "read_omx_skims", "prepare_skims_from_omx", "merge_skim_component",
256
258
  "haversine_km", "pick_skim_matrices", "load_skim_matrices",
257
259
  "build_case_alt_distances", "summarize_distance_sources",
@@ -867,35 +867,22 @@ class LarchLatentClass(_LarchBase):
867
867
  # ("could not broadcast (N,K) into (N,1)").
868
868
  membership = self._build_membership_model(lx, P, LX, ds)
869
869
 
870
- latent = lx.LatentClass(
871
- membership, choice_models, datatree=ds,
870
+ # Assemble + symmetry-break through the shared builder so this path
871
+ # and the ABM Stage-5 driver cannot drift apart. Honour a
872
+ # caller-supplied ``init_coeff`` instead of the symmetry break.
873
+ _do_symmetry = self.init_coeff is None
874
+ latent = build_latent_class(
875
+ choice_models, membership, ds,
876
+ num_classes=self.num_classes,
877
+ symmetry_break=_do_symmetry,
878
+ class_param_names={
879
+ k: [self._class_parameter_name(k, v)
880
+ for v in self.class_params_spec[k]]
881
+ for k in range(self.num_classes)},
882
+ membership_intercepts={
883
+ k: f"LCM{k}_intercept" for k in range(self.num_classes)},
872
884
  float_dtype=self.float_dtype)
873
- latent.compute_engine = "jax"
874
- # Break the class-collapse symmetry. With identical per-class specs
875
- # and all-zero starting values the marginal likelihood is symmetric
876
- # under relabelling the classes, so the optimiser settles on the
877
- # degenerate single-class solution (every class gets the same
878
- # coefficients, membership stays at 0). Seed each class's
879
- # coefficients with a small deterministic class-specific offset and
880
- # give the membership intercepts a mild spread so the classes start
881
- # distinguishable. Honour a caller-supplied ``init_coeff`` instead
882
- # when one is given.
883
- if self.init_coeff is None:
884
- try:
885
- pnames_set = {str(n) for n in latent.pnames}
886
- jitter = np.linspace(-0.3, 0.3, self.num_classes)
887
- for k in range(self.num_classes):
888
- for v in self.class_params_spec[k]:
889
- nm = self._class_parameter_name(k, v)
890
- if nm in pnames_set:
891
- latent.set_value(nm, float(jitter[k]))
892
- mnm = f"LCM{k}_intercept"
893
- if mnm in pnames_set:
894
- latent.set_value(mnm, float(0.5 * jitter[k]))
895
- except Exception:
896
- logger.debug("LCCM symmetry-break init skipped",
897
- exc_info=True)
898
- else:
885
+ if not _do_symmetry:
899
886
  try:
900
887
  latent.pvals = np.asarray(
901
888
  self.init_coeff, dtype=float)[:len(latent.pnames)]
@@ -933,6 +920,90 @@ class LarchLatentClass(_LarchBase):
933
920
  return self._fail(names, self.sample_size)
934
921
 
935
922
 
923
+ def _symmetry_break_latent_class(latent, num_classes, class_param_names=None,
924
+ membership_intercepts=None, jitter=0.3):
925
+ """Seed class-specific starts so the EM/optimiser does not collapse classes.
926
+
927
+ With identical per-class specs and all-zero starting values the marginal
928
+ likelihood is symmetric under relabelling the classes, so the optimiser
929
+ settles on the degenerate single-class solution (every class gets the same
930
+ coefficients, membership stays at 0). This gives each class a small
931
+ deterministic offset and spreads the membership intercepts so the classes
932
+ start distinguishable. Only names actually present in ``latent.pnames`` are
933
+ touched, so it is safe to pass a superset.
934
+
935
+ Parameters
936
+ ----------
937
+ class_param_names : dict[int, list[str]] | None
938
+ Per-class lists of class-specific coefficient names to offset.
939
+ membership_intercepts : dict[int, str] | None
940
+ Per-class membership-intercept parameter name to spread.
941
+ jitter : float
942
+ Half-width of the symmetric offset spread across classes.
943
+ """
944
+ try:
945
+ pnames_set = {str(n) for n in latent.pnames}
946
+ except Exception:
947
+ logger.debug("symmetry-break: pnames unavailable", exc_info=True)
948
+ return latent
949
+ offsets = np.linspace(-abs(jitter), abs(jitter), int(num_classes))
950
+ for k in range(int(num_classes)):
951
+ for nm in (class_param_names or {}).get(k, []):
952
+ if str(nm) in pnames_set:
953
+ try:
954
+ latent.set_value(str(nm), float(offsets[k]))
955
+ except Exception:
956
+ pass
957
+ mnm = (membership_intercepts or {}).get(k)
958
+ if mnm and str(mnm) in pnames_set:
959
+ try:
960
+ latent.set_value(str(mnm), float(0.5 * offsets[k]))
961
+ except Exception:
962
+ pass
963
+ return latent
964
+
965
+
966
+ def build_latent_class(choice_models, membership_model, datatree, *,
967
+ num_classes, symmetry_break=True,
968
+ class_param_names=None, membership_intercepts=None,
969
+ float_dtype=None, jitter=0.3):
970
+ """Assemble a larch ``LatentClass`` from pre-built submodels.
971
+
972
+ This is the single source of truth for wiring a larch latent-class model so
973
+ callers (SearchLibrium's own :class:`LarchLatentClass` and the production
974
+ ABM Stage-5 driver) share one construction and cannot drift apart. The
975
+ caller supplies ready per-class choice models and a membership model that
976
+ already carries a valid K-class graph (see
977
+ :meth:`LarchLatentClass._build_membership_model` for the flat-skeleton
978
+ builder, or build a dedicated class datatree for dotted membership
979
+ covariates). This function attaches them, sets the JAX engine, and applies
980
+ the class-collapse symmetry break.
981
+
982
+ Parameters
983
+ ----------
984
+ choice_models : dict[int, larch.Model]
985
+ Per-class choice models, keyed by class id (0..K-1).
986
+ membership_model : larch.Model
987
+ Class-membership model with a K-elemental graph of its own.
988
+ datatree : larch Dataset or DataTree
989
+ Shared choice data for the class models.
990
+ num_classes : int
991
+ symmetry_break, class_param_names, membership_intercepts, jitter
992
+ Forwarded to :func:`_symmetry_break_latent_class`.
993
+ """
994
+ lx, _P, _LX = _require_larch()
995
+ kw = {} if float_dtype is None else {"float_dtype": float_dtype}
996
+ latent = lx.LatentClass(membership_model, choice_models,
997
+ datatree=datatree, **kw)
998
+ latent.compute_engine = "jax"
999
+ if symmetry_break:
1000
+ _symmetry_break_latent_class(
1001
+ latent, num_classes, class_param_names=class_param_names,
1002
+ membership_intercepts=membership_intercepts, jitter=jitter)
1003
+ return latent
1004
+
1005
+
936
1006
  __all__ = [
937
1007
  "LarchMNL", "LarchNestedLogit", "LarchMixedLogit", "LarchLatentClass",
1008
+ "build_latent_class",
938
1009
  ]
@@ -0,0 +1 @@
1
+ 0.0.268
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: SearchLibrium
3
- Version: 0.0.265
3
+ Version: 0.0.268
4
4
  Summary: Automated specification search for discrete choice models (logit, mixed logit, nested logit, RRM and more) using metaheuristic optimisation
5
5
  Author: Zeke Ahern, Mario Fernando Taco Morales, Alexander Paz, Prithvi Beeramole, Robert Burdett
6
6
  Maintainer-email: Zeke Ahern <z.ahern@qut.edu.au>
@@ -1 +0,0 @@
1
- 0.0.265
File without changes