Explicit error terms production code

activitysim/abm/models/disaggregate_accessibility.py

@@ -15,7 +15,11 @@
 from activitysim.abm.models.util import tour_destination
 from activitysim.abm.tables import shadow_pricing
 from activitysim.core import estimation, los, tracing, util, workflow
-from activitysim.core.configuration.base import PreprocessorSettings, PydanticReadable
+from activitysim.core.configuration.base import (
+    ComputeSettings,
+    PreprocessorSettings,
+    PydanticReadable,
+)
 from activitysim.core.configuration.logit import TourLocationComponentSettings
 from activitysim.core.expressions import assign_columns
 
@@ -184,6 +188,8 @@ class DisaggregateAccessibilitySettings(PydanticReadable, extra="forbid"):
     If not supplied or None, will default to the chunk size in the location choice model settings.
     """
 
+    compute_settings: ComputeSettings | None = None
+
 
 def read_disaggregate_accessibility_yaml(
     state: workflow.State, file_name
@@ -795,6 +801,11 @@ def get_disaggregate_logsums(
         if disagg_model_settings.explicit_chunk is not None:
             model_settings.explicit_chunk = disagg_model_settings.explicit_chunk
 
+        # Can set compute settings for disaggregate accessibility
+        # Otherwise this will be set to whatever is in the location model settings
+        if disagg_model_settings.compute_settings is not None:
+            model_settings.compute_settings = disagg_model_settings.compute_settings
+
         # Include the suffix tags to pass onto downstream logsum models (e.g., tour mode choice)
         if model_settings.LOGSUM_SETTINGS:
             suffixes = util.concat_suffix_dict(disagg_model_settings.suffixes)

activitysim/abm/models/joint_tour_participation.py

@@ -19,9 +19,9 @@
     workflow,
 )
 from activitysim.core.configuration.base import ComputeSettings, PreprocessorSettings
-from activitysim.core.configuration.logit import LogitComponentSettings
-from activitysim.core.util import assign_in_place, reindex
+from activitysim.core.configuration.logit import LogitComponentSettings, LogitNestSpec
 from activitysim.core.exceptions import InvalidTravelError
+from activitysim.core.util import assign_in_place, reindex
 
 logger = logging.getLogger(__name__)
 
@@ -127,10 +127,11 @@ def get_tour_satisfaction(candidates, participate):
 
 def participants_chooser(
     state: workflow.State,
-    probs: pd.DataFrame,
+    probs_or_utils: pd.DataFrame,
     choosers: pd.DataFrame,
     spec: pd.DataFrame,
     trace_label: str,
+    nest_spec: dict | LogitNestSpec | None = None,
 ) -> tuple[pd.Series, pd.Series]:
     """
     custom alternative to logit.make_choices for simulate.simple_simulate
@@ -147,9 +148,10 @@ def participants_chooser(
 
     Parameters
     ----------
-    probs : pandas.DataFrame
+    probs_or_utils : pandas.DataFrame
         Rows for choosers and columns for the alternatives from which they
-        are choosing. Values are expected to be valid probabilities across
+        are choosing. If running with explicit_error_terms, these are utilities.
+        Otherwise, values are expected to be valid probabilities across
         each row, e.g. they should sum to 1.
     choosers : pandas.dataframe
         simple_simulate choosers df
@@ -166,7 +168,7 @@ def participants_chooser(
 
     """
 
-    assert probs.index.equals(choosers.index)
+    assert probs_or_utils.index.equals(choosers.index)
 
     # choice is boolean (participate or not)
     model_settings = JointTourParticipationSettings.read_settings_file(
@@ -202,7 +204,7 @@ def participants_chooser(
                 "%s max iterations exceeded (%s).", trace_label, MAX_ITERATIONS
             )
             diagnostic_cols = ["tour_id", "household_id", "composition", "adult"]
-            unsatisfied_candidates = candidates[diagnostic_cols].join(probs)
+            unsatisfied_candidates = candidates[diagnostic_cols].join(probs_or_utils)
             state.tracing.write_csv(
                 unsatisfied_candidates,
                 file_name="%s.UNSATISFIED" % trace_label,
@@ -215,9 +217,31 @@ def participants_chooser(
                     f"Forcing joint tour participation for {num_tours_remaining} tours."
                 )
                 # anybody with probability > 0 is forced to join the joint tour
-                probs[choice_col] = np.where(probs[choice_col] > 0, 1, 0)
-                non_choice_col = [col for col in probs.columns if col != choice_col][0]
-                probs[non_choice_col] = 1 - probs[choice_col]
+                if state.settings.use_explicit_error_terms:
+                    # need "is valid choice" such that we certainly choose those with non-zero values,
+                    # and do not choose others. Let's use 3.0 as large value here.
+                    probs_or_utils[choice_col] = np.where(
+                        probs_or_utils[choice_col] > logit.UTIL_MIN,
+                        3.0,
+                        logit.UTIL_UNAVAILABLE,
+                    )
+                    non_choice_col = [
+                        col for col in probs_or_utils.columns if col != choice_col
+                    ][0]
+                    probs_or_utils[non_choice_col] = np.where(
+                        probs_or_utils[choice_col] <= logit.UTIL_MIN,
+                        3.0,
+                        logit.UTIL_UNAVAILABLE,
+                    )
+                else:
+                    probs_or_utils[choice_col] = np.where(
+                        probs_or_utils[choice_col] > 0, 1, 0
+                    )
+                    non_choice_col = [
+                        col for col in probs_or_utils.columns if col != choice_col
+                    ][0]
+                    probs_or_utils[non_choice_col] = 1 - probs_or_utils[choice_col]
+
                 if iter > MAX_ITERATIONS + 1:
                     raise InvalidTravelError(
                         f"{num_tours_remaining} tours could not be satisfied even with forcing participation"
@@ -227,9 +251,21 @@ def participants_chooser(
                     f"{num_tours_remaining} tours could not be satisfied after {iter} iterations"
                 )
 
-        choices, rands = logit.make_choices(
-            state, probs, trace_label=trace_label, trace_choosers=choosers
-        )
+        if state.settings.use_explicit_error_terms:
+            choices, rands = logit.make_choices_utility_based(
+                state,
+                probs_or_utils,
+                trace_label=trace_label,
+                trace_choosers=choosers,
+                nest_spec=nest_spec,
+            )
+        else:
+            choices, rands = logit.make_choices(
+                state,
+                probs_or_utils,
+                trace_label=trace_label,
+                trace_choosers=choosers,
+            )
         participate = choices == PARTICIPATE_CHOICE
 
         # satisfaction indexed by tour_id
@@ -252,7 +288,7 @@ def participants_chooser(
             rands_list.append(rands[satisfied])
 
             # remove candidates of satisfied tours
-            probs = probs[~satisfied]
+            probs_or_utils = probs_or_utils[~satisfied]
             candidates = candidates[~satisfied]
 
         logger.debug(
@@ -401,6 +437,8 @@ def joint_tour_participation(
         if i not in model_settings.compute_settings.protect_columns:
             model_settings.compute_settings.protect_columns.append(i)
 
+    custom_chooser = participants_chooser
+
     choices = simulate.simple_simulate_by_chunk_id(
         state,
         choosers=candidates,
@@ -409,7 +447,7 @@ def joint_tour_participation(
         locals_d=constants,
         trace_label=trace_label,
         trace_choice_name="participation",
-        custom_chooser=participants_chooser,
+        custom_chooser=custom_chooser,
         estimator=estimator,
         compute_settings=model_settings.compute_settings,
     )