Preprocessing & Annotation functionality#957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jpn-- merged 9 commits into from
Jul 17, 2025
Merged

Preprocessing & Annotation functionality #957

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7238f16
initial batch of models with pre and post processing added
aletzdy Apr 15, 2025
388219e
nonmand sched and transit pass models
aletzdy Apr 15, 2025
7907069
first pass at preprocessing and annotate functionality in all models
dhensle Jun 17, 2025
52c93b3
fixing bugs in jtf and trip purpose
dhensle Jun 17, 2025
d709d36
adding persons back in to locals_d in jtc
dhensle Jun 17, 2025
353d89c
model name missing in tour scheduling
dhensle Jun 17, 2025
2b71451
missing expressions import in tour sched prob
dhensle Jun 17, 2025
8179e26
ci unit tests & fixing estimation test error
dhensle Jun 18, 2025
c88481e
addressing review comments
dhensle Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion activitysim/abm/models/atwork_subtour_destination.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
import pandas as pd

from activitysim.abm.models.util import tour_destination
from activitysim.core import config, estimation, los, tracing, workflow
from activitysim.core import config, estimation, los, tracing, workflow, expressions
from activitysim.core.configuration.logit import TourLocationComponentSettings
from activitysim.core.util import assign_in_place

Expand DownExpand Up@@ -120,3 +120,11 @@ def atwork_subtour_destination(
state.tracing.trace_df(
tours, label="atwork_subtour_destination", columns=["destination"]
)

expressions.annotate_tables(
state,
locals_dict={},
skims=None,
model_settings=model_settings,
trace_label=trace_label,
)
30 changes: 19 additions & 11 deletions activitysim/abm/models/atwork_subtour_frequency.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,8 @@ class AtworkSubtourFrequencySettings(LogitComponentSettings, extra="forbid"):
Settings for the `atwork_subtour_frequency` component.
"""

preprocessor: PreprocessorSettings | None = None
"""Setting for the preprocessor."""
# no additional fields are required for this component
pass


@workflow.step
Expand DownExpand Up@@ -92,15 +92,15 @@ def atwork_subtour_frequency(
nest_spec = config.get_logit_model_settings(model_settings)
constants = config.get_model_constants(model_settings)

# - preprocessor
preprocessor_settings = model_settings.preprocessor
if preprocessor_settings:
expressions.assign_columns(
state,
df=work_tours,
model_settings=preprocessor_settings,
trace_label=trace_label,
)
# preprocess choosers
expressions.annotate_preprocessors(
state,
df=work_tours,
locals_dict=constants,
skims=None,
model_settings=model_settings,
trace_label=trace_label,
)

if estimator:
estimator.write_spec(model_settings)
Expand DownExpand Up@@ -164,3 +164,11 @@ def atwork_subtour_frequency(

if trace_hh_id:
state.tracing.trace_df(tours, label="atwork_subtour_frequency.tours")

expressions.annotate_tables(
state,
locals_dict=constants,
skims=None,
model_settings=model_settings,
trace_label=trace_label,
)
19 changes: 8 additions & 11 deletions activitysim/abm/models/atwork_subtour_mode_choice.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -195,21 +195,18 @@ def atwork_subtour_mode_choice(
)
state.add_table("tours", tours)

# - annotate tours table
if model_settings.annotate_tours:
tours = state.get_dataframe("tours")
expressions.assign_columns(
state,
df=tours,
model_settings=model_settings.annotate_tours,
trace_label=tracing.extend_trace_label(trace_label, "annotate_tours"),
)
state.add_table("tours", tours)

if trace_hh_id:
state.tracing.trace_df(
tours[tours.tour_category == "atwork"],
label=tracing.extend_trace_label(trace_label, mode_column_name),
slicer="tour_id",
index_label="tour_id",
)

expressions.annotate_tables(
state,
locals_dict=constants,
skims=skims,
model_settings=model_settings,
trace_label=trace_label,
)
8 changes: 8 additions & 0 deletions activitysim/abm/models/atwork_subtour_scheduling.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,3 +141,11 @@ def atwork_subtour_scheduling(
trace_label,
"tour_map",
)

expressions.annotate_tables(
state,
locals_dict=constants,
skims=skims,
model_settings=model_settings,
trace_label=trace_label,
)
39 changes: 18 additions & 21 deletions activitysim/abm/models/auto_ownership.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,8 +18,6 @@
from activitysim.core.configuration.base import PreprocessorSettings, PydanticReadable
from activitysim.core.configuration.logit import LogitComponentSettings

from .util import annotate

logger = logging.getLogger(__name__)


Expand All@@ -28,8 +26,8 @@ class AutoOwnershipSettings(LogitComponentSettings, extra="forbid"):
Settings for the `auto_ownership` component.
"""

preprocessor: PreprocessorSettings | None = None
annotate_households: PreprocessorSettings | None = None
# no additional fields are required for this component
pass


@workflow.step
Expand DownExpand Up@@ -69,20 +67,14 @@ def auto_ownership_simulate(

logger.info("Running %s with %d households", trace_label, len(choosers))

# - preprocessor
preprocessor_settings = model_settings.preprocessor
if preprocessor_settings:
locals_d = {}
if constants is not None:
locals_d.update(constants)

expressions.assign_columns(
state,
df=choosers,
model_settings=preprocessor_settings,
locals_dict=locals_d,
trace_label=trace_label,
)
expressions.annotate_preprocessors(
state,
df=choosers,
locals_dict=constants,
skims=None,
model_settings=model_settings,
trace_label=trace_label,
)

if estimator:
estimator.write_model_settings(model_settings, model_settings_file_name)
Expand DownExpand Up@@ -120,8 +112,13 @@ def auto_ownership_simulate(
"auto_ownership", households.auto_ownership, value_counts=True
)

if model_settings.annotate_households:
annotate.annotate_households(state, model_settings, trace_label)

if trace_hh_id:
state.tracing.trace_df(households, label="auto_ownership", warn_if_empty=True)

expressions.annotate_tables(
state,
locals_dict=constants,
skims=None,
model_settings=model_settings,
trace_label=trace_label,
)
41 changes: 25 additions & 16 deletions activitysim/abm/models/cdap.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,12 +36,17 @@ class CdapSettings(PydanticReadable, extra="forbid"):
JOINT_TOUR_COEFFICIENTS: str = "cdap_joint_tour_coefficients.csv"
JOINT_TOUR_USEFUL_COLUMNS: list[str] | None = None
"""Columns to include from the persons table that will be need to calculate household joint tour utility."""
annotate_persons: PreprocessorSettings | None = None
annotate_households: PreprocessorSettings | None = None
COEFFICIENTS: Path
CONSTANTS: dict[str, Any] = {}
compute_settings: ComputeSettings | None = None

preprocessor: PreprocessorSettings | None = None
"""Preprocess choosers tables before running the model."""
annotate_persons: PreprocessorSettings | None = None

@jpn--jpn--Jun 27, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automatic documentation tools will work better if annotate_persons has its own docstring, even though it's clear to a human reader the one docstring below applies to both.

@dhensledhensleJul 1, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

"""Postprocess persons table after model completion."""
annotate_households: PreprocessorSettings | None = None
"""Postprocess households table after model completion."""


@workflow.step
def cdap_simulate(
Expand DownExpand Up@@ -171,6 +176,16 @@ def cdap_simulate(
index=True,
)

# preprocess choosers
expressions.annotate_preprocessors(
state,
df=persons_merged,
locals_dict=constants,
skims=None,
model_settings=model_settings,
trace_label=trace_label,
)

if estimator:
estimator.write_model_settings(model_settings, "cdap.yaml")
estimator.write_spec(model_settings, tag="INDIV_AND_HHSIZE1_SPEC")
Expand DownExpand Up@@ -241,31 +256,25 @@ def cdap_simulate(
cap_cat_type = pd.api.types.CategoricalDtype(["", "M", "N", "H"], ordered=False)
choices = choices.astype(cap_cat_type)
persons["cdap_activity"] = choices

expressions.assign_columns(
state,
df=persons,
model_settings=model_settings.annotate_persons,
trace_label=tracing.extend_trace_label(trace_label, "annotate_persons"),
)

state.add_table("persons", persons)

# - annotate households table
if add_joint_tour_utility:
hh_joint = hh_joint.reindex(households.index)
households["has_joint_tour"] = hh_joint

expressions.assign_columns(
state,
df=households,
model_settings=model_settings.annotate_households,
trace_label=tracing.extend_trace_label(trace_label, "annotate_households"),
)
state.add_table("households", households)

tracing.print_summary("cdap_activity", persons.cdap_activity, value_counts=True)
logger.info(
"cdap crosstabs:\n%s"
% pd.crosstab(persons.ptype, persons.cdap_activity, margins=True)
)

expressions.annotate_tables(
state,
locals_dict=constants,
skims=None,
model_settings=model_settings,
trace_label=trace_label,
)
35 changes: 17 additions & 18 deletions activitysim/abm/models/free_parking.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,9 +26,6 @@ class FreeParkingSettings(LogitComponentSettings, extra="forbid"):
Settings for the `free_parking` component.
"""

preprocessor: PreprocessorSettings | None = None
"""Setting for the preprocessor."""

FREE_PARKING_ALT: int
"""The code for free parking."""

Expand DownExpand Up@@ -78,21 +75,6 @@ def free_parking(

constants = model_settings.CONSTANTS or {}

# - preprocessor
preprocessor_settings = model_settings.preprocessor
if preprocessor_settings:
locals_d = {}
if constants is not None:
locals_d.update(constants)

expressions.assign_columns(
state,
df=choosers,
model_settings=preprocessor_settings,
locals_dict=locals_d,
trace_label=trace_label,
)

model_spec = state.filesystem.read_model_spec(file_name=model_settings.SPEC)
coefficients_df = state.filesystem.read_model_coefficients(model_settings)
model_spec = simulate.eval_coefficients(
Expand All@@ -101,6 +83,15 @@ def free_parking(

nest_spec = config.get_logit_model_settings(model_settings)

expressions.annotate_preprocessors(
state,
df=choosers,
locals_dict=constants,
skims=None,
model_settings=model_settings,
trace_label=trace_label,
)

if estimator:
estimator.write_model_settings(model_settings, model_settings_file_name)
estimator.write_spec(file_name=model_settings.SPEC)
Expand DownExpand Up@@ -144,3 +135,11 @@ def free_parking(

if state.settings.trace_hh_id:
state.tracing.trace_df(persons, label=trace_label, warn_if_empty=True)

expressions.annotate_tables(
state,
locals_dict=constants,
skims=None,
model_settings=model_settings,
trace_label=trace_label,
)
51 changes: 29 additions & 22 deletions activitysim/abm/models/joint_tour_composition.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
from activitysim.core.configuration.base import PreprocessorSettings
from activitysim.core.configuration.logit import LogitComponentSettings


logger = logging.getLogger(__name__)


Expand All@@ -36,8 +37,7 @@ class JointTourCompositionSettings(LogitComponentSettings, extra="forbid"):
Settings for the `joint_tour_composition` component.
"""

preprocessor: PreprocessorSettings | None = None
"""Setting for the preprocessor."""
pass


@workflow.step
Expand DownExpand Up@@ -78,26 +78,6 @@ def joint_tour_composition(
"Running joint_tour_composition with %d joint tours" % joint_tours.shape[0]
)

# - run preprocessor
preprocessor_settings = model_settings.preprocessor
if preprocessor_settings:
locals_dict = {
"persons": persons,
"hh_time_window_overlap": lambda *x: hh_time_window_overlap(state, *x),
}

expressions.assign_columns(
state,
df=households,
model_settings=preprocessor_settings,
locals_dict=locals_dict,
trace_label=trace_label,
)

joint_tours_merged = pd.merge(
joint_tours, households, left_on="household_id", right_index=True, how="left"
)

# - simple_simulate
model_spec = state.filesystem.read_model_spec(file_name=model_settings.SPEC)
coefficients_df = state.filesystem.read_model_coefficients(model_settings)
Expand All@@ -108,6 +88,25 @@ def joint_tour_composition(
nest_spec = config.get_logit_model_settings(model_settings)
constants = config.get_model_constants(model_settings)

locals_dict = {
"persons": persons,
"hh_time_window_overlap": lambda *x: hh_time_window_overlap(state, *x),
}
locals_dict.update(constants)

expressions.annotate_preprocessors(
state,
df=households,
locals_dict=locals_dict,
skims=None,
model_settings=model_settings,
trace_label=trace_label,
)

joint_tours_merged = pd.merge(
joint_tours, households, left_on="household_id", right_index=True, how="left"
)

if estimator:
estimator.write_spec(model_settings)
estimator.write_model_settings(model_settings, model_settings_file_name)
Expand DownExpand Up@@ -156,3 +155,11 @@ def joint_tour_composition(
label="joint_tour_composition.joint_tours",
slicer="household_id",
)

expressions.annotate_tables(
state,
locals_dict=locals_dict,
skims=None,
model_settings=model_settings,
trace_label=trace_label,
)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Preprocessing & Annotation functionality#957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jpn--
merged 9 commits into

from

Jul 17, 2025
 Merged


Preprocessing & Annotation functionality
#957
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
7238f16

initial batch of models with pre and post processing added


aletzdy Apr 15, 2025
388219e

nonmand sched and transit pass models


aletzdy Apr 15, 2025
7907069

first pass at preprocessing and annotate functionality in all models


dhensle Jun 17, 2025
52c93b3

fixing bugs in jtf and trip purpose


dhensle Jun 17, 2025
d709d36

adding persons back in to locals_d in jtc


dhensle Jun 17, 2025
353d89c

model name missing in tour scheduling


dhensle Jun 17, 2025
2b71451

missing expressions import in tour sched prob


dhensle Jun 17, 2025
8179e26

ci unit tests & fixing estimation test error


dhensle Jun 18, 2025
c88481e

addressing review comments


dhensle Jul 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 9 additions & 1 deletion
activitysim/abm/models/atwork_subtour_destination.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
import pandas as pd

from activitysim.abm.models.util import tour_destination
from activitysim.core import config, estimation, los, tracing, workflow
from activitysim.core import config, estimation, los, tracing, workflow, expressions
from activitysim.core.configuration.logit import TourLocationComponentSettings
from activitysim.core.util import assign_in_place

Expand DownExpand Up@@ -120,3 +120,11 @@ def atwork_subtour_destination(
 state.tracing.trace_df(
 tours, label="atwork_subtour_destination", columns=["destination"]
 )

 expressions.annotate_tables(
 state,
 locals_dict={},
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

30 changes: 19 additions & 11 deletions
activitysim/abm/models/atwork_subtour_frequency.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,8 @@ class AtworkSubtourFrequencySettings(LogitComponentSettings, extra="forbid"):
 Settings for the `atwork_subtour_frequency` component.
 """

preprocessor: PreprocessorSettings | None = None
"""Setting for the preprocessor."""
# no additional fields are required for this component
pass


@workflow.step
Expand DownExpand Up@@ -92,15 +92,15 @@ def atwork_subtour_frequency(
 nest_spec = config.get_logit_model_settings(model_settings)
 constants = config.get_model_constants(model_settings)

 # - preprocessor
preprocessor_settings = model_settings.preprocessor
if preprocessor_settings:
expressions.assign_columns(
 state,
 df=work_tours,
model_settings=preprocessor_settings,
trace_label=trace_label,
)
 # preprocess choosers
expressions.annotate_preprocessors(
 state,
df=work_tours,
locals_dict=constants,
skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_spec(model_settings)
Expand DownExpand Up@@ -164,3 +164,11 @@ def atwork_subtour_frequency(

 if trace_hh_id:
 state.tracing.trace_df(tours, label="atwork_subtour_frequency.tours")

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

19 changes: 8 additions & 11 deletions
activitysim/abm/models/atwork_subtour_mode_choice.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -195,21 +195,18 @@ def atwork_subtour_mode_choice(
 )
 state.add_table("tours", tours)

 # - annotate tours table
 if model_settings.annotate_tours:
 tours = state.get_dataframe("tours")
 expressions.assign_columns(
 state,
 df=tours,
 model_settings=model_settings.annotate_tours,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_tours"),
 )
 state.add_table("tours", tours)

 if trace_hh_id:
 state.tracing.trace_df(
 tours[tours.tour_category == "atwork"],
 label=tracing.extend_trace_label(trace_label, mode_column_name),
 slicer="tour_id",
 index_label="tour_id",
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=skims,
 model_settings=model_settings,
 trace_label=trace_label,
 )

8 changes: 8 additions & 0 deletions
activitysim/abm/models/atwork_subtour_scheduling.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,3 +141,11 @@ def atwork_subtour_scheduling(
 trace_label,
 "tour_map",
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=skims,
 model_settings=model_settings,
 trace_label=trace_label,
 )

39 changes: 18 additions & 21 deletions
activitysim/abm/models/auto_ownership.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,8 +18,6 @@
from activitysim.core.configuration.base import PreprocessorSettings, PydanticReadable
from activitysim.core.configuration.logit import LogitComponentSettings

from .util import annotate

logger = logging.getLogger(__name__)


Expand All@@ -28,8 +26,8 @@ class AutoOwnershipSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `auto_ownership` component.
 """

preprocessor: PreprocessorSettings | None = None
annotate_households: PreprocessorSettings | None = None
# no additional fields are required for this component
pass


@workflow.step
Expand DownExpand Up@@ -69,20 +67,14 @@ def auto_ownership_simulate(

 logger.info("Running %s with %d households", trace_label, len(choosers))

 # - preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_d = {}
 if constants is not None:
 locals_d.update(constants)

 expressions.assign_columns(
 state,
 df=choosers,
 model_settings=preprocessor_settings,
 locals_dict=locals_d,
 trace_label=trace_label,
 )
 expressions.annotate_preprocessors(
 state,
 df=choosers,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, model_settings_file_name)
Expand DownExpand Up@@ -120,8 +112,13 @@ def auto_ownership_simulate(
 "auto_ownership", households.auto_ownership, value_counts=True
 )

 if model_settings.annotate_households:
 annotate.annotate_households(state, model_settings, trace_label)

 if trace_hh_id:
 state.tracing.trace_df(households, label="auto_ownership", warn_if_empty=True)

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

41 changes: 25 additions & 16 deletions
activitysim/abm/models/cdap.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,12 +36,17 @@ class CdapSettings(PydanticReadable, extra="forbid"):
 JOINT_TOUR_COEFFICIENTS: str = "cdap_joint_tour_coefficients.csv"
 JOINT_TOUR_USEFUL_COLUMNS: list[str] | None = None
 """Columns to include from the persons table that will be need to calculate household joint tour utility."""
 annotate_persons: PreprocessorSettings | None = None
 annotate_households: PreprocessorSettings | None = None
 COEFFICIENTS: Path
 CONSTANTS: dict[str, Any] = {}
 compute_settings: ComputeSettings | None = None

 preprocessor: PreprocessorSettings | None = None
 """Preprocess choosers tables before running the model."""
 annotate_persons: PreprocessorSettings | None = None
@jpn--jpn--Jun 27, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automatic documentation tools will work better if annotate_persons has its own docstring, even though it's clear to a human reader the one docstring below applies to both.
@dhensledhensleJul 1, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done
 """Postprocess persons table after model completion."""
 annotate_households: PreprocessorSettings | None = None
 """Postprocess households table after model completion."""


@workflow.step
def cdap_simulate(
Expand DownExpand Up@@ -171,6 +176,16 @@ def cdap_simulate(
 index=True,
 )

 # preprocess choosers
 expressions.annotate_preprocessors(
 state,
 df=persons_merged,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, "cdap.yaml")
 estimator.write_spec(model_settings, tag="INDIV_AND_HHSIZE1_SPEC")
Expand DownExpand Up@@ -241,31 +256,25 @@ def cdap_simulate(
 cap_cat_type = pd.api.types.CategoricalDtype(["", "M", "N", "H"], ordered=False)
 choices = choices.astype(cap_cat_type)
 persons["cdap_activity"] = choices

 expressions.assign_columns(
 state,
 df=persons,
 model_settings=model_settings.annotate_persons,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_persons"),
 )

 state.add_table("persons", persons)

 # - annotate households table
 if add_joint_tour_utility:
 hh_joint = hh_joint.reindex(households.index)
 households["has_joint_tour"] = hh_joint

 expressions.assign_columns(
 state,
 df=households,
 model_settings=model_settings.annotate_households,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_households"),
 )
 state.add_table("households", households)

 tracing.print_summary("cdap_activity", persons.cdap_activity, value_counts=True)
 logger.info(
 "cdap crosstabs:\n%s"
 % pd.crosstab(persons.ptype, persons.cdap_activity, margins=True)
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

35 changes: 17 additions & 18 deletions
activitysim/abm/models/free_parking.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,9 +26,6 @@ class FreeParkingSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `free_parking` component.
 """

 preprocessor: PreprocessorSettings | None = None
 """Setting for the preprocessor."""

 FREE_PARKING_ALT: int
 """The code for free parking."""

Expand DownExpand Up@@ -78,21 +75,6 @@ def free_parking(

 constants = model_settings.CONSTANTS or {}

 # - preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_d = {}
 if constants is not None:
 locals_d.update(constants)

 expressions.assign_columns(
 state,
 df=choosers,
 model_settings=preprocessor_settings,
 locals_dict=locals_d,
 trace_label=trace_label,
 )

 model_spec = state.filesystem.read_model_spec(file_name=model_settings.SPEC)
 coefficients_df = state.filesystem.read_model_coefficients(model_settings)
 model_spec = simulate.eval_coefficients(
Expand All@@ -101,6 +83,15 @@ def free_parking(

 nest_spec = config.get_logit_model_settings(model_settings)

 expressions.annotate_preprocessors(
 state,
 df=choosers,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, model_settings_file_name)
 estimator.write_spec(file_name=model_settings.SPEC)
Expand DownExpand Up@@ -144,3 +135,11 @@ def free_parking(

 if state.settings.trace_hh_id:
 state.tracing.trace_df(persons, label=trace_label, warn_if_empty=True)

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

51 changes: 29 additions & 22 deletions
activitysim/abm/models/joint_tour_composition.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
from activitysim.core.configuration.base import PreprocessorSettings
from activitysim.core.configuration.logit import LogitComponentSettings


logger = logging.getLogger(__name__)


Expand All@@ -36,8 +37,7 @@ class JointTourCompositionSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `joint_tour_composition` component.
 """

 preprocessor: PreprocessorSettings | None = None
 """Setting for the preprocessor."""
 pass


@workflow.step
Expand DownExpand Up@@ -78,26 +78,6 @@ def joint_tour_composition(
 "Running joint_tour_composition with %d joint tours" % joint_tours.shape[0]
 )

 # - run preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_dict = {
 "persons": persons,
 "hh_time_window_overlap": lambda *x: hh_time_window_overlap(state, *x),
 }

 expressions.assign_columns(
 state,
 df=households,
 model_settings=preprocessor_settings,
 locals_dict=locals_dict,
 trace_label=trace_label,
 )

 joint_tours_merged = pd.merge(
 joint_tours, households, left_on="household_id", right_index=True, how="left"
 )

 # - simple_simulate
 model_spec = state.filesystem.read_model_spec(file_name=model_settings.SPEC)
 coefficients_df = state.filesystem.read_model_coefficients(model_settings)
Expand All@@ -108,6 +88,25 @@ def joint_tour_composition(
 nest_spec = config.get_logit_model_settings(model_settings)
 constants = config.get_model_constants(model_settings)

 locals_dict = {
 "persons": persons,
 "hh_time_window_overlap": lambda *x: hh_time_window_overlap(state, *x),
 }
 locals_dict.update(constants)

 expressions.annotate_preprocessors(
 state,
 df=households,
 locals_dict=locals_dict,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 joint_tours_merged = pd.merge(
 joint_tours, households, left_on="household_id", right_index=True, how="left"
 )

 if estimator:
 estimator.write_spec(model_settings)
 estimator.write_model_settings(model_settings, model_settings_file_name)
Expand DownExpand Up@@ -156,3 +155,11 @@ def joint_tour_composition(
 label="joint_tour_composition.joint_tours",
 slicer="household_id",
 )

 expressions.annotate_tables(
 state,
 locals_dict=locals_dict,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Preprocessing & Annotation functionality#957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jpn--
merged 9 commits into

from

Jul 17, 2025
 Merged


Preprocessing & Annotation functionality
#957
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
7238f16

initial batch of models with pre and post processing added


aletzdy Apr 15, 2025
388219e

nonmand sched and transit pass models


aletzdy Apr 15, 2025
7907069

first pass at preprocessing and annotate functionality in all models


dhensle Jun 17, 2025
52c93b3

fixing bugs in jtf and trip purpose


dhensle Jun 17, 2025
d709d36

adding persons back in to locals_d in jtc


dhensle Jun 17, 2025
353d89c

model name missing in tour scheduling


dhensle Jun 17, 2025
2b71451

missing expressions import in tour sched prob


dhensle Jun 17, 2025
8179e26

ci unit tests & fixing estimation test error


dhensle Jun 18, 2025
c88481e

addressing review comments


dhensle Jul 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 9 additions & 1 deletion
activitysim/abm/models/atwork_subtour_destination.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
import pandas as pd

from activitysim.abm.models.util import tour_destination
from activitysim.core import config, estimation, los, tracing, workflow
from activitysim.core import config, estimation, los, tracing, workflow, expressions
from activitysim.core.configuration.logit import TourLocationComponentSettings
from activitysim.core.util import assign_in_place

Expand DownExpand Up@@ -120,3 +120,11 @@ def atwork_subtour_destination(
 state.tracing.trace_df(
 tours, label="atwork_subtour_destination", columns=["destination"]
 )

 expressions.annotate_tables(
 state,
 locals_dict={},
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

30 changes: 19 additions & 11 deletions
activitysim/abm/models/atwork_subtour_frequency.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,8 @@ class AtworkSubtourFrequencySettings(LogitComponentSettings, extra="forbid"):
 Settings for the `atwork_subtour_frequency` component.
 """

preprocessor: PreprocessorSettings | None = None
"""Setting for the preprocessor."""
# no additional fields are required for this component
pass


@workflow.step
Expand DownExpand Up@@ -92,15 +92,15 @@ def atwork_subtour_frequency(
 nest_spec = config.get_logit_model_settings(model_settings)
 constants = config.get_model_constants(model_settings)

 # - preprocessor
preprocessor_settings = model_settings.preprocessor
if preprocessor_settings:
expressions.assign_columns(
 state,
 df=work_tours,
model_settings=preprocessor_settings,
trace_label=trace_label,
)
 # preprocess choosers
expressions.annotate_preprocessors(
 state,
df=work_tours,
locals_dict=constants,
skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_spec(model_settings)
Expand DownExpand Up@@ -164,3 +164,11 @@ def atwork_subtour_frequency(

 if trace_hh_id:
 state.tracing.trace_df(tours, label="atwork_subtour_frequency.tours")

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

19 changes: 8 additions & 11 deletions
activitysim/abm/models/atwork_subtour_mode_choice.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -195,21 +195,18 @@ def atwork_subtour_mode_choice(
 )
 state.add_table("tours", tours)

 # - annotate tours table
 if model_settings.annotate_tours:
 tours = state.get_dataframe("tours")
 expressions.assign_columns(
 state,
 df=tours,
 model_settings=model_settings.annotate_tours,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_tours"),
 )
 state.add_table("tours", tours)

 if trace_hh_id:
 state.tracing.trace_df(
 tours[tours.tour_category == "atwork"],
 label=tracing.extend_trace_label(trace_label, mode_column_name),
 slicer="tour_id",
 index_label="tour_id",
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=skims,
 model_settings=model_settings,
 trace_label=trace_label,
 )

8 changes: 8 additions & 0 deletions
activitysim/abm/models/atwork_subtour_scheduling.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,3 +141,11 @@ def atwork_subtour_scheduling(
 trace_label,
 "tour_map",
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=skims,
 model_settings=model_settings,
 trace_label=trace_label,
 )

39 changes: 18 additions & 21 deletions
activitysim/abm/models/auto_ownership.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,8 +18,6 @@
from activitysim.core.configuration.base import PreprocessorSettings, PydanticReadable
from activitysim.core.configuration.logit import LogitComponentSettings

from .util import annotate

logger = logging.getLogger(__name__)


Expand All@@ -28,8 +26,8 @@ class AutoOwnershipSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `auto_ownership` component.
 """

preprocessor: PreprocessorSettings | None = None
annotate_households: PreprocessorSettings | None = None
# no additional fields are required for this component
pass


@workflow.step
Expand DownExpand Up@@ -69,20 +67,14 @@ def auto_ownership_simulate(

 logger.info("Running %s with %d households", trace_label, len(choosers))

 # - preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_d = {}
 if constants is not None:
 locals_d.update(constants)

 expressions.assign_columns(
 state,
 df=choosers,
 model_settings=preprocessor_settings,
 locals_dict=locals_d,
 trace_label=trace_label,
 )
 expressions.annotate_preprocessors(
 state,
 df=choosers,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, model_settings_file_name)
Expand DownExpand Up@@ -120,8 +112,13 @@ def auto_ownership_simulate(
 "auto_ownership", households.auto_ownership, value_counts=True
 )

 if model_settings.annotate_households:
 annotate.annotate_households(state, model_settings, trace_label)

 if trace_hh_id:
 state.tracing.trace_df(households, label="auto_ownership", warn_if_empty=True)

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

41 changes: 25 additions & 16 deletions
activitysim/abm/models/cdap.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,12 +36,17 @@ class CdapSettings(PydanticReadable, extra="forbid"):
 JOINT_TOUR_COEFFICIENTS: str = "cdap_joint_tour_coefficients.csv"
 JOINT_TOUR_USEFUL_COLUMNS: list[str] | None = None
 """Columns to include from the persons table that will be need to calculate household joint tour utility."""
 annotate_persons: PreprocessorSettings | None = None
 annotate_households: PreprocessorSettings | None = None
 COEFFICIENTS: Path
 CONSTANTS: dict[str, Any] = {}
 compute_settings: ComputeSettings | None = None

 preprocessor: PreprocessorSettings | None = None
 """Preprocess choosers tables before running the model."""
 annotate_persons: PreprocessorSettings | None = None
@jpn--jpn--Jun 27, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automatic documentation tools will work better if annotate_persons has its own docstring, even though it's clear to a human reader the one docstring below applies to both.
@dhensledhensleJul 1, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done
 """Postprocess persons table after model completion."""
 annotate_households: PreprocessorSettings | None = None
 """Postprocess households table after model completion."""


@workflow.step
def cdap_simulate(
Expand DownExpand Up@@ -171,6 +176,16 @@ def cdap_simulate(
 index=True,
 )

 # preprocess choosers
 expressions.annotate_preprocessors(
 state,
 df=persons_merged,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, "cdap.yaml")
 estimator.write_spec(model_settings, tag="INDIV_AND_HHSIZE1_SPEC")
Expand DownExpand Up@@ -241,31 +256,25 @@ def cdap_simulate(
 cap_cat_type = pd.api.types.CategoricalDtype(["", "M", "N", "H"], ordered=False)
 choices = choices.astype(cap_cat_type)
 persons["cdap_activity"] = choices

 expressions.assign_columns(
 state,
 df=persons,
 model_settings=model_settings.annotate_persons,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_persons"),
 )

 state.add_table("persons", persons)

 # - annotate households table
 if add_joint_tour_utility:
 hh_joint = hh_joint.reindex(households.index)
 households["has_joint_tour"] = hh_joint

 expressions.assign_columns(
 state,
 df=households,
 model_settings=model_settings.annotate_households,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_households"),
 )
 state.add_table("households", households)

 tracing.print_summary("cdap_activity", persons.cdap_activity, value_counts=True)
 logger.info(
 "cdap crosstabs:\n%s"
 % pd.crosstab(persons.ptype, persons.cdap_activity, margins=True)
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

35 changes: 17 additions & 18 deletions
activitysim/abm/models/free_parking.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,9 +26,6 @@ class FreeParkingSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `free_parking` component.
 """

 preprocessor: PreprocessorSettings | None = None
 """Setting for the preprocessor."""

 FREE_PARKING_ALT: int
 """The code for free parking."""

Expand DownExpand Up@@ -78,21 +75,6 @@ def free_parking(

 constants = model_settings.CONSTANTS or {}

 # - preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_d = {}
 if constants is not None:
 locals_d.update(constants)

 expressions.assign_columns(
 state,
 df=choosers,
 model_settings=preprocessor_settings,
 locals_dict=locals_d,
 trace_label=trace_label,
 )

 model_spec = state.filesystem.read_model_spec(file_name=model_settings.SPEC)
 coefficients_df = state.filesystem.read_model_coefficients(model_settings)
 model_spec = simulate.eval_coefficients(
Expand All@@ -101,6 +83,15 @@ def free_parking(

 nest_spec = config.get_logit_model_settings(model_settings)

 expressions.annotate_preprocessors(
 state,
 df=choosers,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, model_settings_file_name)
 estimator.write_spec(file_name=model_settings.SPEC)
Expand DownExpand Up@@ -144,3 +135,11 @@ def free_parking(

 if state.settings.trace_hh_id:
 state.tracing.trace_df(persons, label=trace_label, warn_if_empty=True)

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

51 changes: 29 additions & 22 deletions
activitysim/abm/models/joint_tour_composition.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
from activitysim.core.configuration.base import PreprocessorSettings
from activitysim.core.configuration.logit import LogitComponentSettings


logger = logging.getLogger(__name__)


Expand All@@ -36,8 +37,7 @@ class JointTourCompositionSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `joint_tour_composition` component.
 """

 preprocessor: PreprocessorSettings | None = None
 """Setting for the preprocessor."""
 pass


@workflow.step
Expand DownExpand Up@@ -78,26 +78,6 @@ def joint_tour_composition(
 "Running joint_tour_composition with %d joint tours" % joint_tours.shape[0]
 )

 # - run preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_dict = {
 "persons": persons,
 "hh_time_window_overlap": lambda *x: hh_time_window_overlap(state, *x),
 }

 expressions.assign_columns(
 state,
 df=households,
 model_settings=preprocessor_settings,
 locals_dict=locals_dict,
 trace_label=trace_label,
 )

 joint_tours_merged = pd.merge(
 joint_tours, households, left_on="household_id", right_index=True, how="left"
 )

 # - simple_simulate
 model_spec = state.filesystem.read_model_spec(file_name=model_settings.SPEC)
 coefficients_df = state.filesystem.read_model_coefficients(model_settings)
Expand All@@ -108,6 +88,25 @@ def joint_tour_composition(
 nest_spec = config.get_logit_model_settings(model_settings)
 constants = config.get_model_constants(model_settings)

 locals_dict = {
 "persons": persons,
 "hh_time_window_overlap": lambda *x: hh_time_window_overlap(state, *x),
 }
 locals_dict.update(constants)

 expressions.annotate_preprocessors(
 state,
 df=households,
 locals_dict=locals_dict,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 joint_tours_merged = pd.merge(
 joint_tours, households, left_on="household_id", right_index=True, how="left"
 )

 if estimator:
 estimator.write_spec(model_settings)
 estimator.write_model_settings(model_settings, model_settings_file_name)
Expand DownExpand Up@@ -156,3 +155,11 @@ def joint_tour_composition(
 label="joint_tour_composition.joint_tours",
 slicer="household_id",
 )

 expressions.annotate_tables(
 state,
 locals_dict=locals_dict,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Preprocessing & Annotation functionality#957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jpn--
merged 9 commits into

from

Jul 17, 2025
 Merged


Preprocessing & Annotation functionality
#957
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
7238f16

initial batch of models with pre and post processing added


aletzdy Apr 15, 2025
388219e

nonmand sched and transit pass models


aletzdy Apr 15, 2025
7907069

first pass at preprocessing and annotate functionality in all models


dhensle Jun 17, 2025
52c93b3

fixing bugs in jtf and trip purpose


dhensle Jun 17, 2025
d709d36

adding persons back in to locals_d in jtc


dhensle Jun 17, 2025
353d89c

model name missing in tour scheduling


dhensle Jun 17, 2025
2b71451

missing expressions import in tour sched prob


dhensle Jun 17, 2025
8179e26

ci unit tests & fixing estimation test error


dhensle Jun 18, 2025
c88481e

addressing review comments


dhensle Jul 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 9 additions & 1 deletion
activitysim/abm/models/atwork_subtour_destination.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
import pandas as pd

from activitysim.abm.models.util import tour_destination
from activitysim.core import config, estimation, los, tracing, workflow
from activitysim.core import config, estimation, los, tracing, workflow, expressions
from activitysim.core.configuration.logit import TourLocationComponentSettings
from activitysim.core.util import assign_in_place

Expand DownExpand Up@@ -120,3 +120,11 @@ def atwork_subtour_destination(
 state.tracing.trace_df(
 tours, label="atwork_subtour_destination", columns=["destination"]
 )

 expressions.annotate_tables(
 state,
 locals_dict={},
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

30 changes: 19 additions & 11 deletions
activitysim/abm/models/atwork_subtour_frequency.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,8 @@ class AtworkSubtourFrequencySettings(LogitComponentSettings, extra="forbid"):
 Settings for the `atwork_subtour_frequency` component.
 """

preprocessor: PreprocessorSettings | None = None
"""Setting for the preprocessor."""
# no additional fields are required for this component
pass


@workflow.step
Expand DownExpand Up@@ -92,15 +92,15 @@ def atwork_subtour_frequency(
 nest_spec = config.get_logit_model_settings(model_settings)
 constants = config.get_model_constants(model_settings)

 # - preprocessor
preprocessor_settings = model_settings.preprocessor
if preprocessor_settings:
expressions.assign_columns(
 state,
 df=work_tours,
model_settings=preprocessor_settings,
trace_label=trace_label,
)
 # preprocess choosers
expressions.annotate_preprocessors(
 state,
df=work_tours,
locals_dict=constants,
skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_spec(model_settings)
Expand DownExpand Up@@ -164,3 +164,11 @@ def atwork_subtour_frequency(

 if trace_hh_id:
 state.tracing.trace_df(tours, label="atwork_subtour_frequency.tours")

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

19 changes: 8 additions & 11 deletions
activitysim/abm/models/atwork_subtour_mode_choice.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -195,21 +195,18 @@ def atwork_subtour_mode_choice(
 )
 state.add_table("tours", tours)

 # - annotate tours table
 if model_settings.annotate_tours:
 tours = state.get_dataframe("tours")
 expressions.assign_columns(
 state,
 df=tours,
 model_settings=model_settings.annotate_tours,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_tours"),
 )
 state.add_table("tours", tours)

 if trace_hh_id:
 state.tracing.trace_df(
 tours[tours.tour_category == "atwork"],
 label=tracing.extend_trace_label(trace_label, mode_column_name),
 slicer="tour_id",
 index_label="tour_id",
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=skims,
 model_settings=model_settings,
 trace_label=trace_label,
 )

8 changes: 8 additions & 0 deletions
activitysim/abm/models/atwork_subtour_scheduling.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,3 +141,11 @@ def atwork_subtour_scheduling(
 trace_label,
 "tour_map",
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=skims,
 model_settings=model_settings,
 trace_label=trace_label,
 )

39 changes: 18 additions & 21 deletions
activitysim/abm/models/auto_ownership.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,8 +18,6 @@
from activitysim.core.configuration.base import PreprocessorSettings, PydanticReadable
from activitysim.core.configuration.logit import LogitComponentSettings

from .util import annotate

logger = logging.getLogger(__name__)


Expand All@@ -28,8 +26,8 @@ class AutoOwnershipSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `auto_ownership` component.
 """

preprocessor: PreprocessorSettings | None = None
annotate_households: PreprocessorSettings | None = None
# no additional fields are required for this component
pass


@workflow.step
Expand DownExpand Up@@ -69,20 +67,14 @@ def auto_ownership_simulate(

 logger.info("Running %s with %d households", trace_label, len(choosers))

 # - preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_d = {}
 if constants is not None:
 locals_d.update(constants)

 expressions.assign_columns(
 state,
 df=choosers,
 model_settings=preprocessor_settings,
 locals_dict=locals_d,
 trace_label=trace_label,
 )
 expressions.annotate_preprocessors(
 state,
 df=choosers,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, model_settings_file_name)
Expand DownExpand Up@@ -120,8 +112,13 @@ def auto_ownership_simulate(
 "auto_ownership", households.auto_ownership, value_counts=True
 )

 if model_settings.annotate_households:
 annotate.annotate_households(state, model_settings, trace_label)

 if trace_hh_id:
 state.tracing.trace_df(households, label="auto_ownership", warn_if_empty=True)

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

41 changes: 25 additions & 16 deletions
activitysim/abm/models/cdap.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,12 +36,17 @@ class CdapSettings(PydanticReadable, extra="forbid"):
 JOINT_TOUR_COEFFICIENTS: str = "cdap_joint_tour_coefficients.csv"
 JOINT_TOUR_USEFUL_COLUMNS: list[str] | None = None
 """Columns to include from the persons table that will be need to calculate household joint tour utility."""
 annotate_persons: PreprocessorSettings | None = None
 annotate_households: PreprocessorSettings | None = None
 COEFFICIENTS: Path
 CONSTANTS: dict[str, Any] = {}
 compute_settings: ComputeSettings | None = None

 preprocessor: PreprocessorSettings | None = None
 """Preprocess choosers tables before running the model."""
 annotate_persons: PreprocessorSettings | None = None
@jpn--jpn--Jun 27, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automatic documentation tools will work better if annotate_persons has its own docstring, even though it's clear to a human reader the one docstring below applies to both.
@dhensledhensleJul 1, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done
 """Postprocess persons table after model completion."""
 annotate_households: PreprocessorSettings | None = None
 """Postprocess households table after model completion."""


@workflow.step
def cdap_simulate(
Expand DownExpand Up@@ -171,6 +176,16 @@ def cdap_simulate(
 index=True,
 )

 # preprocess choosers
 expressions.annotate_preprocessors(
 state,
 df=persons_merged,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, "cdap.yaml")
 estimator.write_spec(model_settings, tag="INDIV_AND_HHSIZE1_SPEC")
Expand DownExpand Up@@ -241,31 +256,25 @@ def cdap_simulate(
 cap_cat_type = pd.api.types.CategoricalDtype(["", "M", "N", "H"], ordered=False)
 choices = choices.astype(cap_cat_type)
 persons["cdap_activity"] = choices

 expressions.assign_columns(
 state,
 df=persons,
 model_settings=model_settings.annotate_persons,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_persons"),
 )

 state.add_table("persons", persons)

 # - annotate households table
 if add_joint_tour_utility:
 hh_joint = hh_joint.reindex(households.index)
 households["has_joint_tour"] = hh_joint

 expressions.assign_columns(
 state,
 df=households,
 model_settings=model_settings.annotate_households,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_households"),
 )
 state.add_table("households", households)

 tracing.print_summary("cdap_activity", persons.cdap_activity, value_counts=True)
 logger.info(
 "cdap crosstabs:\n%s"
 % pd.crosstab(persons.ptype, persons.cdap_activity, margins=True)
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

35 changes: 17 additions & 18 deletions
activitysim/abm/models/free_parking.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,9 +26,6 @@ class FreeParkingSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `free_parking` component.
 """

 preprocessor: PreprocessorSettings | None = None
 """Setting for the preprocessor."""

 FREE_PARKING_ALT: int
 """The code for free parking."""

Expand DownExpand Up@@ -78,21 +75,6 @@ def free_parking(

 constants = model_settings.CONSTANTS or {}

 # - preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_d = {}
 if constants is not None:
 locals_d.update(constants)

 expressions.assign_columns(
 state,
 df=choosers,
 model_settings=preprocessor_settings,
 locals_dict=locals_d,
 trace_label=trace_label,
 )

 model_spec = state.filesystem.read_model_spec(file_name=model_settings.SPEC)
 coefficients_df = state.filesystem.read_model_coefficients(model_settings)
 model_spec = simulate.eval_coefficients(
Expand All@@ -101,6 +83,15 @@ def free_parking(

 nest_spec = config.get_logit_model_settings(model_settings)

 expressions.annotate_preprocessors(
 state,
 df=choosers,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, model_settings_file_name)
 estimator.write_spec(file_name=model_settings.SPEC)
Expand DownExpand Up@@ -144,3 +135,11 @@ def free_parking(

 if state.settings.trace_hh_id:
 state.tracing.trace_df(persons, label=trace_label, warn_if_empty=True)

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

51 changes: 29 additions & 22 deletions
activitysim/abm/models/joint_tour_composition.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
from activitysim.core.configuration.base import PreprocessorSettings
from activitysim.core.configuration.logit import LogitComponentSettings


logger = logging.getLogger(__name__)


Expand All@@ -36,8 +37,7 @@ class JointTourCompositionSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `joint_tour_composition` component.
 """

 preprocessor: PreprocessorSettings | None = None
 """Setting for the preprocessor."""
 pass


@workflow.step
Expand DownExpand Up@@ -78,26 +78,6 @@ def joint_tour_composition(
 "Running joint_tour_composition with %d joint tours" % joint_tours.shape[0]
 )

 # - run preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_dict = {
 "persons": persons,
 "hh_time_window_overlap": lambda *x: hh_time_window_overlap(state, *x),
 }

 expressions.assign_columns(
 state,
 df=households,
 model_settings=preprocessor_settings,
 locals_dict=locals_dict,
 trace_label=trace_label,
 )

 joint_tours_merged = pd.merge(
 joint_tours, households, left_on="household_id", right_index=True, how="left"
 )

 # - simple_simulate
 model_spec = state.filesystem.read_model_spec(file_name=model_settings.SPEC)
 coefficients_df = state.filesystem.read_model_coefficients(model_settings)
Expand All@@ -108,6 +88,25 @@ def joint_tour_composition(
 nest_spec = config.get_logit_model_settings(model_settings)
 constants = config.get_model_constants(model_settings)

 locals_dict = {
 "persons": persons,
 "hh_time_window_overlap": lambda *x: hh_time_window_overlap(state, *x),
 }
 locals_dict.update(constants)

 expressions.annotate_preprocessors(
 state,
 df=households,
 locals_dict=locals_dict,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 joint_tours_merged = pd.merge(
 joint_tours, households, left_on="household_id", right_index=True, how="left"
 )

 if estimator:
 estimator.write_spec(model_settings)
 estimator.write_model_settings(model_settings, model_settings_file_name)
Expand DownExpand Up@@ -156,3 +155,11 @@ def joint_tour_composition(
 label="joint_tour_composition.joint_tours",
 slicer="household_id",
 )

 expressions.annotate_tables(
 state,
 locals_dict=locals_dict,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Preprocessing & Annotation functionality#957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jpn--
merged 9 commits into

from

Jul 17, 2025
 Merged


Preprocessing & Annotation functionality
#957
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
7238f16

initial batch of models with pre and post processing added


aletzdy Apr 15, 2025
388219e

nonmand sched and transit pass models


aletzdy Apr 15, 2025
7907069

first pass at preprocessing and annotate functionality in all models


dhensle Jun 17, 2025
52c93b3

fixing bugs in jtf and trip purpose


dhensle Jun 17, 2025
d709d36

adding persons back in to locals_d in jtc


dhensle Jun 17, 2025
353d89c

model name missing in tour scheduling


dhensle Jun 17, 2025
2b71451

missing expressions import in tour sched prob


dhensle Jun 17, 2025
8179e26

ci unit tests & fixing estimation test error


dhensle Jun 18, 2025
c88481e

addressing review comments


dhensle Jul 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 9 additions & 1 deletion
activitysim/abm/models/atwork_subtour_destination.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
import pandas as pd

from activitysim.abm.models.util import tour_destination
from activitysim.core import config, estimation, los, tracing, workflow
from activitysim.core import config, estimation, los, tracing, workflow, expressions
from activitysim.core.configuration.logit import TourLocationComponentSettings
from activitysim.core.util import assign_in_place

Expand DownExpand Up@@ -120,3 +120,11 @@ def atwork_subtour_destination(
 state.tracing.trace_df(
 tours, label="atwork_subtour_destination", columns=["destination"]
 )

 expressions.annotate_tables(
 state,
 locals_dict={},
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

30 changes: 19 additions & 11 deletions
activitysim/abm/models/atwork_subtour_frequency.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,8 @@ class AtworkSubtourFrequencySettings(LogitComponentSettings, extra="forbid"):
 Settings for the `atwork_subtour_frequency` component.
 """

preprocessor: PreprocessorSettings | None = None
"""Setting for the preprocessor."""
# no additional fields are required for this component
pass


@workflow.step
Expand DownExpand Up@@ -92,15 +92,15 @@ def atwork_subtour_frequency(
 nest_spec = config.get_logit_model_settings(model_settings)
 constants = config.get_model_constants(model_settings)

 # - preprocessor
preprocessor_settings = model_settings.preprocessor
if preprocessor_settings:
expressions.assign_columns(
 state,
 df=work_tours,
model_settings=preprocessor_settings,
trace_label=trace_label,
)
 # preprocess choosers
expressions.annotate_preprocessors(
 state,
df=work_tours,
locals_dict=constants,
skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_spec(model_settings)
Expand DownExpand Up@@ -164,3 +164,11 @@ def atwork_subtour_frequency(

 if trace_hh_id:
 state.tracing.trace_df(tours, label="atwork_subtour_frequency.tours")

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

19 changes: 8 additions & 11 deletions
activitysim/abm/models/atwork_subtour_mode_choice.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -195,21 +195,18 @@ def atwork_subtour_mode_choice(
 )
 state.add_table("tours", tours)

 # - annotate tours table
 if model_settings.annotate_tours:
 tours = state.get_dataframe("tours")
 expressions.assign_columns(
 state,
 df=tours,
 model_settings=model_settings.annotate_tours,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_tours"),
 )
 state.add_table("tours", tours)

 if trace_hh_id:
 state.tracing.trace_df(
 tours[tours.tour_category == "atwork"],
 label=tracing.extend_trace_label(trace_label, mode_column_name),
 slicer="tour_id",
 index_label="tour_id",
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=skims,
 model_settings=model_settings,
 trace_label=trace_label,
 )

8 changes: 8 additions & 0 deletions
activitysim/abm/models/atwork_subtour_scheduling.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,3 +141,11 @@ def atwork_subtour_scheduling(
 trace_label,
 "tour_map",
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=skims,
 model_settings=model_settings,
 trace_label=trace_label,
 )

39 changes: 18 additions & 21 deletions
activitysim/abm/models/auto_ownership.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,8 +18,6 @@
from activitysim.core.configuration.base import PreprocessorSettings, PydanticReadable
from activitysim.core.configuration.logit import LogitComponentSettings

from .util import annotate

logger = logging.getLogger(__name__)


Expand All@@ -28,8 +26,8 @@ class AutoOwnershipSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `auto_ownership` component.
 """

preprocessor: PreprocessorSettings | None = None
annotate_households: PreprocessorSettings | None = None
# no additional fields are required for this component
pass


@workflow.step
Expand DownExpand Up@@ -69,20 +67,14 @@ def auto_ownership_simulate(

 logger.info("Running %s with %d households", trace_label, len(choosers))

 # - preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_d = {}
 if constants is not None:
 locals_d.update(constants)

 expressions.assign_columns(
 state,
 df=choosers,
 model_settings=preprocessor_settings,
 locals_dict=locals_d,
 trace_label=trace_label,
 )
 expressions.annotate_preprocessors(
 state,
 df=choosers,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, model_settings_file_name)
Expand DownExpand Up@@ -120,8 +112,13 @@ def auto_ownership_simulate(
 "auto_ownership", households.auto_ownership, value_counts=True
 )

 if model_settings.annotate_households:
 annotate.annotate_households(state, model_settings, trace_label)

 if trace_hh_id:
 state.tracing.trace_df(households, label="auto_ownership", warn_if_empty=True)

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

41 changes: 25 additions & 16 deletions
activitysim/abm/models/cdap.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,12 +36,17 @@ class CdapSettings(PydanticReadable, extra="forbid"):
 JOINT_TOUR_COEFFICIENTS: str = "cdap_joint_tour_coefficients.csv"
 JOINT_TOUR_USEFUL_COLUMNS: list[str] | None = None
 """Columns to include from the persons table that will be need to calculate household joint tour utility."""
 annotate_persons: PreprocessorSettings | None = None
 annotate_households: PreprocessorSettings | None = None
 COEFFICIENTS: Path
 CONSTANTS: dict[str, Any] = {}
 compute_settings: ComputeSettings | None = None

 preprocessor: PreprocessorSettings | None = None
 """Preprocess choosers tables before running the model."""
 annotate_persons: PreprocessorSettings | None = None
@jpn--jpn--Jun 27, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automatic documentation tools will work better if annotate_persons has its own docstring, even though it's clear to a human reader the one docstring below applies to both.
@dhensledhensleJul 1, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done
 """Postprocess persons table after model completion."""
 annotate_households: PreprocessorSettings | None = None
 """Postprocess households table after model completion."""


@workflow.step
def cdap_simulate(
Expand DownExpand Up@@ -171,6 +176,16 @@ def cdap_simulate(
 index=True,
 )

 # preprocess choosers
 expressions.annotate_preprocessors(
 state,
 df=persons_merged,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, "cdap.yaml")
 estimator.write_spec(model_settings, tag="INDIV_AND_HHSIZE1_SPEC")
Expand DownExpand Up@@ -241,31 +256,25 @@ def cdap_simulate(
 cap_cat_type = pd.api.types.CategoricalDtype(["", "M", "N", "H"], ordered=False)
 choices = choices.astype(cap_cat_type)
 persons["cdap_activity"] = choices

 expressions.assign_columns(
 state,
 df=persons,
 model_settings=model_settings.annotate_persons,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_persons"),
 )

 state.add_table("persons", persons)

 # - annotate households table
 if add_joint_tour_utility:
 hh_joint = hh_joint.reindex(households.index)
 households["has_joint_tour"] = hh_joint

 expressions.assign_columns(
 state,
 df=households,
 model_settings=model_settings.annotate_households,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_households"),
 )
 state.add_table("households", households)

 tracing.print_summary("cdap_activity", persons.cdap_activity, value_counts=True)
 logger.info(
 "cdap crosstabs:\n%s"
 % pd.crosstab(persons.ptype, persons.cdap_activity, margins=True)
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

35 changes: 17 additions & 18 deletions
activitysim/abm/models/free_parking.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,9 +26,6 @@ class FreeParkingSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `free_parking` component.
 """

 preprocessor: PreprocessorSettings | None = None
 """Setting for the preprocessor."""

 FREE_PARKING_ALT: int
 """The code for free parking."""

Expand DownExpand Up@@ -78,21 +75,6 @@ def free_parking(

 constants = model_settings.CONSTANTS or {}

 # - preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_d = {}
 if constants is not None:
 locals_d.update(constants)

 expressions.assign_columns(
 state,
 df=choosers,
 model_settings=preprocessor_settings,
 locals_dict=locals_d,
 trace_label=trace_label,
 )

 model_spec = state.filesystem.read_model_spec(file_name=model_settings.SPEC)
 coefficients_df = state.filesystem.read_model_coefficients(model_settings)
 model_spec = simulate.eval_coefficients(
Expand All@@ -101,6 +83,15 @@ def free_parking(

 nest_spec = config.get_logit_model_settings(model_settings)

 expressions.annotate_preprocessors(
 state,
 df=choosers,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, model_settings_file_name)
 estimator.write_spec(file_name=model_settings.SPEC)
Expand DownExpand Up@@ -144,3 +135,11 @@ def free_parking(

 if state.settings.trace_hh_id:
 state.tracing.trace_df(persons, label=trace_label, warn_if_empty=True)

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

51 changes: 29 additions & 22 deletions
activitysim/abm/models/joint_tour_composition.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
from activitysim.core.configuration.base import PreprocessorSettings
from activitysim.core.configuration.logit import LogitComponentSettings


logger = logging.getLogger(__name__)


Expand All@@ -36,8 +37,7 @@ class JointTourCompositionSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `joint_tour_composition` component.
 """

 preprocessor: PreprocessorSettings | None = None
 """Setting for the preprocessor."""
 pass


@workflow.step
Expand DownExpand Up@@ -78,26 +78,6 @@ def joint_tour_composition(
 "Running joint_tour_composition with %d joint tours" % joint_tours.shape[0]
 )

 # - run preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_dict = {
 "persons": persons,
 "hh_time_window_overlap": lambda *x: hh_time_window_overlap(state, *x),
 }

 expressions.assign_columns(
 state,
 df=households,
 model_settings=preprocessor_settings,
 locals_dict=locals_dict,
 trace_label=trace_label,
 )

 joint_tours_merged = pd.merge(
 joint_tours, households, left_on="household_id", right_index=True, how="left"
 )

 # - simple_simulate
 model_spec = state.filesystem.read_model_spec(file_name=model_settings.SPEC)
 coefficients_df = state.filesystem.read_model_coefficients(model_settings)
Expand All@@ -108,6 +88,25 @@ def joint_tour_composition(
 nest_spec = config.get_logit_model_settings(model_settings)
 constants = config.get_model_constants(model_settings)

 locals_dict = {
 "persons": persons,
 "hh_time_window_overlap": lambda *x: hh_time_window_overlap(state, *x),
 }
 locals_dict.update(constants)

 expressions.annotate_preprocessors(
 state,
 df=households,
 locals_dict=locals_dict,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 joint_tours_merged = pd.merge(
 joint_tours, households, left_on="household_id", right_index=True, how="left"
 )

 if estimator:
 estimator.write_spec(model_settings)
 estimator.write_model_settings(model_settings, model_settings_file_name)
Expand DownExpand Up@@ -156,3 +155,11 @@ def joint_tour_composition(
 label="joint_tour_composition.joint_tours",
 slicer="household_id",
 )

 expressions.annotate_tables(
 state,
 locals_dict=locals_dict,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Preprocessing & Annotation functionality#957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jpn--
merged 9 commits into

from

Jul 17, 2025
 Merged


Preprocessing & Annotation functionality
#957
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
7238f16

initial batch of models with pre and post processing added


aletzdy Apr 15, 2025
388219e

nonmand sched and transit pass models


aletzdy Apr 15, 2025
7907069

first pass at preprocessing and annotate functionality in all models


dhensle Jun 17, 2025
52c93b3

fixing bugs in jtf and trip purpose


dhensle Jun 17, 2025
d709d36

adding persons back in to locals_d in jtc


dhensle Jun 17, 2025
353d89c

model name missing in tour scheduling


dhensle Jun 17, 2025
2b71451

missing expressions import in tour sched prob


dhensle Jun 17, 2025
8179e26

ci unit tests & fixing estimation test error


dhensle Jun 18, 2025
c88481e

addressing review comments


dhensle Jul 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 9 additions & 1 deletion
activitysim/abm/models/atwork_subtour_destination.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
import pandas as pd

from activitysim.abm.models.util import tour_destination
from activitysim.core import config, estimation, los, tracing, workflow
from activitysim.core import config, estimation, los, tracing, workflow, expressions
from activitysim.core.configuration.logit import TourLocationComponentSettings
from activitysim.core.util import assign_in_place

Expand DownExpand Up@@ -120,3 +120,11 @@ def atwork_subtour_destination(
 state.tracing.trace_df(
 tours, label="atwork_subtour_destination", columns=["destination"]
 )

 expressions.annotate_tables(
 state,
 locals_dict={},
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

30 changes: 19 additions & 11 deletions
activitysim/abm/models/atwork_subtour_frequency.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,8 @@ class AtworkSubtourFrequencySettings(LogitComponentSettings, extra="forbid"):
 Settings for the `atwork_subtour_frequency` component.
 """

preprocessor: PreprocessorSettings | None = None
"""Setting for the preprocessor."""
# no additional fields are required for this component
pass


@workflow.step
Expand DownExpand Up@@ -92,15 +92,15 @@ def atwork_subtour_frequency(
 nest_spec = config.get_logit_model_settings(model_settings)
 constants = config.get_model_constants(model_settings)

 # - preprocessor
preprocessor_settings = model_settings.preprocessor
if preprocessor_settings:
expressions.assign_columns(
 state,
 df=work_tours,
model_settings=preprocessor_settings,
trace_label=trace_label,
)
 # preprocess choosers
expressions.annotate_preprocessors(
 state,
df=work_tours,
locals_dict=constants,
skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_spec(model_settings)
Expand DownExpand Up@@ -164,3 +164,11 @@ def atwork_subtour_frequency(

 if trace_hh_id:
 state.tracing.trace_df(tours, label="atwork_subtour_frequency.tours")

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

19 changes: 8 additions & 11 deletions
activitysim/abm/models/atwork_subtour_mode_choice.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -195,21 +195,18 @@ def atwork_subtour_mode_choice(
 )
 state.add_table("tours", tours)

 # - annotate tours table
 if model_settings.annotate_tours:
 tours = state.get_dataframe("tours")
 expressions.assign_columns(
 state,
 df=tours,
 model_settings=model_settings.annotate_tours,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_tours"),
 )
 state.add_table("tours", tours)

 if trace_hh_id:
 state.tracing.trace_df(
 tours[tours.tour_category == "atwork"],
 label=tracing.extend_trace_label(trace_label, mode_column_name),
 slicer="tour_id",
 index_label="tour_id",
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=skims,
 model_settings=model_settings,
 trace_label=trace_label,
 )

8 changes: 8 additions & 0 deletions
activitysim/abm/models/atwork_subtour_scheduling.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,3 +141,11 @@ def atwork_subtour_scheduling(
 trace_label,
 "tour_map",
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=skims,
 model_settings=model_settings,
 trace_label=trace_label,
 )

39 changes: 18 additions & 21 deletions
activitysim/abm/models/auto_ownership.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,8 +18,6 @@
from activitysim.core.configuration.base import PreprocessorSettings, PydanticReadable
from activitysim.core.configuration.logit import LogitComponentSettings

from .util import annotate

logger = logging.getLogger(__name__)


Expand All@@ -28,8 +26,8 @@ class AutoOwnershipSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `auto_ownership` component.
 """

preprocessor: PreprocessorSettings | None = None
annotate_households: PreprocessorSettings | None = None
# no additional fields are required for this component
pass


@workflow.step
Expand DownExpand Up@@ -69,20 +67,14 @@ def auto_ownership_simulate(

 logger.info("Running %s with %d households", trace_label, len(choosers))

 # - preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_d = {}
 if constants is not None:
 locals_d.update(constants)

 expressions.assign_columns(
 state,
 df=choosers,
 model_settings=preprocessor_settings,
 locals_dict=locals_d,
 trace_label=trace_label,
 )
 expressions.annotate_preprocessors(
 state,
 df=choosers,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, model_settings_file_name)
Expand DownExpand Up@@ -120,8 +112,13 @@ def auto_ownership_simulate(
 "auto_ownership", households.auto_ownership, value_counts=True
 )

 if model_settings.annotate_households:
 annotate.annotate_households(state, model_settings, trace_label)

 if trace_hh_id:
 state.tracing.trace_df(households, label="auto_ownership", warn_if_empty=True)

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

41 changes: 25 additions & 16 deletions
activitysim/abm/models/cdap.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,12 +36,17 @@ class CdapSettings(PydanticReadable, extra="forbid"):
 JOINT_TOUR_COEFFICIENTS: str = "cdap_joint_tour_coefficients.csv"
 JOINT_TOUR_USEFUL_COLUMNS: list[str] | None = None
 """Columns to include from the persons table that will be need to calculate household joint tour utility."""
 annotate_persons: PreprocessorSettings | None = None
 annotate_households: PreprocessorSettings | None = None
 COEFFICIENTS: Path
 CONSTANTS: dict[str, Any] = {}
 compute_settings: ComputeSettings | None = None

 preprocessor: PreprocessorSettings | None = None
 """Preprocess choosers tables before running the model."""
 annotate_persons: PreprocessorSettings | None = None
@jpn--jpn--Jun 27, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automatic documentation tools will work better if annotate_persons has its own docstring, even though it's clear to a human reader the one docstring below applies to both.
@dhensledhensleJul 1, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done
 """Postprocess persons table after model completion."""
 annotate_households: PreprocessorSettings | None = None
 """Postprocess households table after model completion."""


@workflow.step
def cdap_simulate(
Expand DownExpand Up@@ -171,6 +176,16 @@ def cdap_simulate(
 index=True,
 )

 # preprocess choosers
 expressions.annotate_preprocessors(
 state,
 df=persons_merged,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, "cdap.yaml")
 estimator.write_spec(model_settings, tag="INDIV_AND_HHSIZE1_SPEC")
Expand DownExpand Up@@ -241,31 +256,25 @@ def cdap_simulate(
 cap_cat_type = pd.api.types.CategoricalDtype(["", "M", "N", "H"], ordered=False)
 choices = choices.astype(cap_cat_type)
 persons["cdap_activity"] = choices

 expressions.assign_columns(
 state,
 df=persons,
 model_settings=model_settings.annotate_persons,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_persons"),
 )

 state.add_table("persons", persons)

 # - annotate households table
 if add_joint_tour_utility:
 hh_joint = hh_joint.reindex(households.index)
 households["has_joint_tour"] = hh_joint

 expressions.assign_columns(
 state,
 df=households,
 model_settings=model_settings.annotate_households,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_households"),
 )
 state.add_table("households", households)

 tracing.print_summary("cdap_activity", persons.cdap_activity, value_counts=True)
 logger.info(
 "cdap crosstabs:\n%s"
 % pd.crosstab(persons.ptype, persons.cdap_activity, margins=True)
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

35 changes: 17 additions & 18 deletions
activitysim/abm/models/free_parking.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,9 +26,6 @@ class FreeParkingSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `free_parking` component.
 """

 preprocessor: PreprocessorSettings | None = None
 """Setting for the preprocessor."""

 FREE_PARKING_ALT: int
 """The code for free parking."""

Expand DownExpand Up@@ -78,21 +75,6 @@ def free_parking(

 constants = model_settings.CONSTANTS or {}

 # - preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_d = {}
 if constants is not None:
 locals_d.update(constants)

 expressions.assign_columns(
 state,
 df=choosers,
 model_settings=preprocessor_settings,
 locals_dict=locals_d,
 trace_label=trace_label,
 )

 model_spec = state.filesystem.read_model_spec(file_name=model_settings.SPEC)
 coefficients_df = state.filesystem.read_model_coefficients(model_settings)
 model_spec = simulate.eval_coefficients(
Expand All@@ -101,6 +83,15 @@ def free_parking(

 nest_spec = config.get_logit_model_settings(model_settings)

 expressions.annotate_preprocessors(
 state,
 df=choosers,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, model_settings_file_name)
 estimator.write_spec(file_name=model_settings.SPEC)
Expand DownExpand Up@@ -144,3 +135,11 @@ def free_parking(

 if state.settings.trace_hh_id:
 state.tracing.trace_df(persons, label=trace_label, warn_if_empty=True)

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

51 changes: 29 additions & 22 deletions
activitysim/abm/models/joint_tour_composition.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
from activitysim.core.configuration.base import PreprocessorSettings
from activitysim.core.configuration.logit import LogitComponentSettings


logger = logging.getLogger(__name__)


Expand All@@ -36,8 +37,7 @@ class JointTourCompositionSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `joint_tour_composition` component.
 """

 preprocessor: PreprocessorSettings | None = None
 """Setting for the preprocessor."""
 pass


@workflow.step
Expand DownExpand Up@@ -78,26 +78,6 @@ def joint_tour_composition(
 "Running joint_tour_composition with %d joint tours" % joint_tours.shape[0]
 )

 # - run preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_dict = {
 "persons": persons,
 "hh_time_window_overlap": lambda *x: hh_time_window_overlap(state, *x),
 }

 expressions.assign_columns(
 state,
 df=households,
 model_settings=preprocessor_settings,
 locals_dict=locals_dict,
 trace_label=trace_label,
 )

 joint_tours_merged = pd.merge(
 joint_tours, households, left_on="household_id", right_index=True, how="left"
 )

 # - simple_simulate
 model_spec = state.filesystem.read_model_spec(file_name=model_settings.SPEC)
 coefficients_df = state.filesystem.read_model_coefficients(model_settings)
Expand All@@ -108,6 +88,25 @@ def joint_tour_composition(
 nest_spec = config.get_logit_model_settings(model_settings)
 constants = config.get_model_constants(model_settings)

 locals_dict = {
 "persons": persons,
 "hh_time_window_overlap": lambda *x: hh_time_window_overlap(state, *x),
 }
 locals_dict.update(constants)

 expressions.annotate_preprocessors(
 state,
 df=households,
 locals_dict=locals_dict,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 joint_tours_merged = pd.merge(
 joint_tours, households, left_on="household_id", right_index=True, how="left"
 )

 if estimator:
 estimator.write_spec(model_settings)
 estimator.write_model_settings(model_settings, model_settings_file_name)
Expand DownExpand Up@@ -156,3 +155,11 @@ def joint_tour_composition(
 label="joint_tour_composition.joint_tours",
 slicer="household_id",
 )

 expressions.annotate_tables(
 state,
 locals_dict=locals_dict,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Preprocessing & Annotation functionality#957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jpn--
merged 9 commits into

from

Jul 17, 2025
 Merged


Preprocessing & Annotation functionality
#957
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
7238f16

initial batch of models with pre and post processing added


aletzdy Apr 15, 2025
388219e

nonmand sched and transit pass models


aletzdy Apr 15, 2025
7907069

first pass at preprocessing and annotate functionality in all models


dhensle Jun 17, 2025
52c93b3

fixing bugs in jtf and trip purpose


dhensle Jun 17, 2025
d709d36

adding persons back in to locals_d in jtc


dhensle Jun 17, 2025
353d89c

model name missing in tour scheduling


dhensle Jun 17, 2025
2b71451

missing expressions import in tour sched prob


dhensle Jun 17, 2025
8179e26

ci unit tests & fixing estimation test error


dhensle Jun 18, 2025
c88481e

addressing review comments


dhensle Jul 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 9 additions & 1 deletion
activitysim/abm/models/atwork_subtour_destination.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
import pandas as pd

from activitysim.abm.models.util import tour_destination
from activitysim.core import config, estimation, los, tracing, workflow
from activitysim.core import config, estimation, los, tracing, workflow, expressions
from activitysim.core.configuration.logit import TourLocationComponentSettings
from activitysim.core.util import assign_in_place

Expand DownExpand Up@@ -120,3 +120,11 @@ def atwork_subtour_destination(
 state.tracing.trace_df(
 tours, label="atwork_subtour_destination", columns=["destination"]
 )

 expressions.annotate_tables(
 state,
 locals_dict={},
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

30 changes: 19 additions & 11 deletions
activitysim/abm/models/atwork_subtour_frequency.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,8 @@ class AtworkSubtourFrequencySettings(LogitComponentSettings, extra="forbid"):
 Settings for the `atwork_subtour_frequency` component.
 """

preprocessor: PreprocessorSettings | None = None
"""Setting for the preprocessor."""
# no additional fields are required for this component
pass


@workflow.step
Expand DownExpand Up@@ -92,15 +92,15 @@ def atwork_subtour_frequency(
 nest_spec = config.get_logit_model_settings(model_settings)
 constants = config.get_model_constants(model_settings)

 # - preprocessor
preprocessor_settings = model_settings.preprocessor
if preprocessor_settings:
expressions.assign_columns(
 state,
 df=work_tours,
model_settings=preprocessor_settings,
trace_label=trace_label,
)
 # preprocess choosers
expressions.annotate_preprocessors(
 state,
df=work_tours,
locals_dict=constants,
skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_spec(model_settings)
Expand DownExpand Up@@ -164,3 +164,11 @@ def atwork_subtour_frequency(

 if trace_hh_id:
 state.tracing.trace_df(tours, label="atwork_subtour_frequency.tours")

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

19 changes: 8 additions & 11 deletions
activitysim/abm/models/atwork_subtour_mode_choice.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -195,21 +195,18 @@ def atwork_subtour_mode_choice(
 )
 state.add_table("tours", tours)

 # - annotate tours table
 if model_settings.annotate_tours:
 tours = state.get_dataframe("tours")
 expressions.assign_columns(
 state,
 df=tours,
 model_settings=model_settings.annotate_tours,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_tours"),
 )
 state.add_table("tours", tours)

 if trace_hh_id:
 state.tracing.trace_df(
 tours[tours.tour_category == "atwork"],
 label=tracing.extend_trace_label(trace_label, mode_column_name),
 slicer="tour_id",
 index_label="tour_id",
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=skims,
 model_settings=model_settings,
 trace_label=trace_label,
 )

8 changes: 8 additions & 0 deletions
activitysim/abm/models/atwork_subtour_scheduling.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,3 +141,11 @@ def atwork_subtour_scheduling(
 trace_label,
 "tour_map",
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=skims,
 model_settings=model_settings,
 trace_label=trace_label,
 )

39 changes: 18 additions & 21 deletions
activitysim/abm/models/auto_ownership.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,8 +18,6 @@
from activitysim.core.configuration.base import PreprocessorSettings, PydanticReadable
from activitysim.core.configuration.logit import LogitComponentSettings

from .util import annotate

logger = logging.getLogger(__name__)


Expand All@@ -28,8 +26,8 @@ class AutoOwnershipSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `auto_ownership` component.
 """

preprocessor: PreprocessorSettings | None = None
annotate_households: PreprocessorSettings | None = None
# no additional fields are required for this component
pass


@workflow.step
Expand DownExpand Up@@ -69,20 +67,14 @@ def auto_ownership_simulate(

 logger.info("Running %s with %d households", trace_label, len(choosers))

 # - preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_d = {}
 if constants is not None:
 locals_d.update(constants)

 expressions.assign_columns(
 state,
 df=choosers,
 model_settings=preprocessor_settings,
 locals_dict=locals_d,
 trace_label=trace_label,
 )
 expressions.annotate_preprocessors(
 state,
 df=choosers,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, model_settings_file_name)
Expand DownExpand Up@@ -120,8 +112,13 @@ def auto_ownership_simulate(
 "auto_ownership", households.auto_ownership, value_counts=True
 )

 if model_settings.annotate_households:
 annotate.annotate_households(state, model_settings, trace_label)

 if trace_hh_id:
 state.tracing.trace_df(households, label="auto_ownership", warn_if_empty=True)

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

41 changes: 25 additions & 16 deletions
activitysim/abm/models/cdap.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,12 +36,17 @@ class CdapSettings(PydanticReadable, extra="forbid"):
 JOINT_TOUR_COEFFICIENTS: str = "cdap_joint_tour_coefficients.csv"
 JOINT_TOUR_USEFUL_COLUMNS: list[str] | None = None
 """Columns to include from the persons table that will be need to calculate household joint tour utility."""
 annotate_persons: PreprocessorSettings | None = None
 annotate_households: PreprocessorSettings | None = None
 COEFFICIENTS: Path
 CONSTANTS: dict[str, Any] = {}
 compute_settings: ComputeSettings | None = None

 preprocessor: PreprocessorSettings | None = None
 """Preprocess choosers tables before running the model."""
 annotate_persons: PreprocessorSettings | None = None
@jpn--jpn--Jun 27, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automatic documentation tools will work better if annotate_persons has its own docstring, even though it's clear to a human reader the one docstring below applies to both.
@dhensledhensleJul 1, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done
 """Postprocess persons table after model completion."""
 annotate_households: PreprocessorSettings | None = None
 """Postprocess households table after model completion."""


@workflow.step
def cdap_simulate(
Expand DownExpand Up@@ -171,6 +176,16 @@ def cdap_simulate(
 index=True,
 )

 # preprocess choosers
 expressions.annotate_preprocessors(
 state,
 df=persons_merged,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, "cdap.yaml")
 estimator.write_spec(model_settings, tag="INDIV_AND_HHSIZE1_SPEC")
Expand DownExpand Up@@ -241,31 +256,25 @@ def cdap_simulate(
 cap_cat_type = pd.api.types.CategoricalDtype(["", "M", "N", "H"], ordered=False)
 choices = choices.astype(cap_cat_type)
 persons["cdap_activity"] = choices

 expressions.assign_columns(
 state,
 df=persons,
 model_settings=model_settings.annotate_persons,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_persons"),
 )

 state.add_table("persons", persons)

 # - annotate households table
 if add_joint_tour_utility:
 hh_joint = hh_joint.reindex(households.index)
 households["has_joint_tour"] = hh_joint

 expressions.assign_columns(
 state,
 df=households,
 model_settings=model_settings.annotate_households,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_households"),
 )
 state.add_table("households", households)

 tracing.print_summary("cdap_activity", persons.cdap_activity, value_counts=True)
 logger.info(
 "cdap crosstabs:\n%s"
 % pd.crosstab(persons.ptype, persons.cdap_activity, margins=True)
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

35 changes: 17 additions & 18 deletions
activitysim/abm/models/free_parking.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,9 +26,6 @@ class FreeParkingSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `free_parking` component.
 """

 preprocessor: PreprocessorSettings | None = None
 """Setting for the preprocessor."""

 FREE_PARKING_ALT: int
 """The code for free parking."""

Expand DownExpand Up@@ -78,21 +75,6 @@ def free_parking(

 constants = model_settings.CONSTANTS or {}

 # - preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_d = {}
 if constants is not None:
 locals_d.update(constants)

 expressions.assign_columns(
 state,
 df=choosers,
 model_settings=preprocessor_settings,
 locals_dict=locals_d,
 trace_label=trace_label,
 )

 model_spec = state.filesystem.read_model_spec(file_name=model_settings.SPEC)
 coefficients_df = state.filesystem.read_model_coefficients(model_settings)
 model_spec = simulate.eval_coefficients(
Expand All@@ -101,6 +83,15 @@ def free_parking(

 nest_spec = config.get_logit_model_settings(model_settings)

 expressions.annotate_preprocessors(
 state,
 df=choosers,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, model_settings_file_name)
 estimator.write_spec(file_name=model_settings.SPEC)
Expand DownExpand Up@@ -144,3 +135,11 @@ def free_parking(

 if state.settings.trace_hh_id:
 state.tracing.trace_df(persons, label=trace_label, warn_if_empty=True)

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

51 changes: 29 additions & 22 deletions
activitysim/abm/models/joint_tour_composition.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
from activitysim.core.configuration.base import PreprocessorSettings
from activitysim.core.configuration.logit import LogitComponentSettings


logger = logging.getLogger(__name__)


Expand All@@ -36,8 +37,7 @@ class JointTourCompositionSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `joint_tour_composition` component.
 """

 preprocessor: PreprocessorSettings | None = None
 """Setting for the preprocessor."""
 pass


@workflow.step
Expand DownExpand Up@@ -78,26 +78,6 @@ def joint_tour_composition(
 "Running joint_tour_composition with %d joint tours" % joint_tours.shape[0]
 )

 # - run preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_dict = {
 "persons": persons,
 "hh_time_window_overlap": lambda *x: hh_time_window_overlap(state, *x),
 }

 expressions.assign_columns(
 state,
 df=households,
 model_settings=preprocessor_settings,
 locals_dict=locals_dict,
 trace_label=trace_label,
 )

 joint_tours_merged = pd.merge(
 joint_tours, households, left_on="household_id", right_index=True, how="left"
 )

 # - simple_simulate
 model_spec = state.filesystem.read_model_spec(file_name=model_settings.SPEC)
 coefficients_df = state.filesystem.read_model_coefficients(model_settings)
Expand All@@ -108,6 +88,25 @@ def joint_tour_composition(
 nest_spec = config.get_logit_model_settings(model_settings)
 constants = config.get_model_constants(model_settings)

 locals_dict = {
 "persons": persons,
 "hh_time_window_overlap": lambda *x: hh_time_window_overlap(state, *x),
 }
 locals_dict.update(constants)

 expressions.annotate_preprocessors(
 state,
 df=households,
 locals_dict=locals_dict,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 joint_tours_merged = pd.merge(
 joint_tours, households, left_on="household_id", right_index=True, how="left"
 )

 if estimator:
 estimator.write_spec(model_settings)
 estimator.write_model_settings(model_settings, model_settings_file_name)
Expand DownExpand Up@@ -156,3 +155,11 @@ def joint_tour_composition(
 label="joint_tour_composition.joint_tours",
 slicer="household_id",
 )

 expressions.annotate_tables(
 state,
 locals_dict=locals_dict,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Preprocessing & Annotation functionality#957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jpn--
merged 9 commits into

from

Jul 17, 2025
 Merged


Preprocessing & Annotation functionality
#957
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
7238f16

initial batch of models with pre and post processing added


aletzdy Apr 15, 2025
388219e

nonmand sched and transit pass models


aletzdy Apr 15, 2025
7907069

first pass at preprocessing and annotate functionality in all models


dhensle Jun 17, 2025
52c93b3

fixing bugs in jtf and trip purpose


dhensle Jun 17, 2025
d709d36

adding persons back in to locals_d in jtc


dhensle Jun 17, 2025
353d89c

model name missing in tour scheduling


dhensle Jun 17, 2025
2b71451

missing expressions import in tour sched prob


dhensle Jun 17, 2025
8179e26

ci unit tests & fixing estimation test error


dhensle Jun 18, 2025
c88481e

addressing review comments


dhensle Jul 1, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


10 changes: 9 additions & 1 deletion
activitysim/abm/models/atwork_subtour_destination.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
import pandas as pd

from activitysim.abm.models.util import tour_destination
from activitysim.core import config, estimation, los, tracing, workflow
from activitysim.core import config, estimation, los, tracing, workflow, expressions
from activitysim.core.configuration.logit import TourLocationComponentSettings
from activitysim.core.util import assign_in_place

Expand DownExpand Up@@ -120,3 +120,11 @@ def atwork_subtour_destination(
 state.tracing.trace_df(
 tours, label="atwork_subtour_destination", columns=["destination"]
 )

 expressions.annotate_tables(
 state,
 locals_dict={},
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

30 changes: 19 additions & 11 deletions
activitysim/abm/models/atwork_subtour_frequency.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,8 +37,8 @@ class AtworkSubtourFrequencySettings(LogitComponentSettings, extra="forbid"):
 Settings for the `atwork_subtour_frequency` component.
 """

preprocessor: PreprocessorSettings | None = None
"""Setting for the preprocessor."""
# no additional fields are required for this component
pass


@workflow.step
Expand DownExpand Up@@ -92,15 +92,15 @@ def atwork_subtour_frequency(
 nest_spec = config.get_logit_model_settings(model_settings)
 constants = config.get_model_constants(model_settings)

 # - preprocessor
preprocessor_settings = model_settings.preprocessor
if preprocessor_settings:
expressions.assign_columns(
 state,
 df=work_tours,
model_settings=preprocessor_settings,
trace_label=trace_label,
)
 # preprocess choosers
expressions.annotate_preprocessors(
 state,
df=work_tours,
locals_dict=constants,
skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_spec(model_settings)
Expand DownExpand Up@@ -164,3 +164,11 @@ def atwork_subtour_frequency(

 if trace_hh_id:
 state.tracing.trace_df(tours, label="atwork_subtour_frequency.tours")

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

19 changes: 8 additions & 11 deletions
activitysim/abm/models/atwork_subtour_mode_choice.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -195,21 +195,18 @@ def atwork_subtour_mode_choice(
 )
 state.add_table("tours", tours)

 # - annotate tours table
 if model_settings.annotate_tours:
 tours = state.get_dataframe("tours")
 expressions.assign_columns(
 state,
 df=tours,
 model_settings=model_settings.annotate_tours,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_tours"),
 )
 state.add_table("tours", tours)

 if trace_hh_id:
 state.tracing.trace_df(
 tours[tours.tour_category == "atwork"],
 label=tracing.extend_trace_label(trace_label, mode_column_name),
 slicer="tour_id",
 index_label="tour_id",
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=skims,
 model_settings=model_settings,
 trace_label=trace_label,
 )

8 changes: 8 additions & 0 deletions
activitysim/abm/models/atwork_subtour_scheduling.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,3 +141,11 @@ def atwork_subtour_scheduling(
 trace_label,
 "tour_map",
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=skims,
 model_settings=model_settings,
 trace_label=trace_label,
 )

39 changes: 18 additions & 21 deletions
activitysim/abm/models/auto_ownership.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,8 +18,6 @@
from activitysim.core.configuration.base import PreprocessorSettings, PydanticReadable
from activitysim.core.configuration.logit import LogitComponentSettings

from .util import annotate

logger = logging.getLogger(__name__)


Expand All@@ -28,8 +26,8 @@ class AutoOwnershipSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `auto_ownership` component.
 """

preprocessor: PreprocessorSettings | None = None
annotate_households: PreprocessorSettings | None = None
# no additional fields are required for this component
pass


@workflow.step
Expand DownExpand Up@@ -69,20 +67,14 @@ def auto_ownership_simulate(

 logger.info("Running %s with %d households", trace_label, len(choosers))

 # - preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_d = {}
 if constants is not None:
 locals_d.update(constants)

 expressions.assign_columns(
 state,
 df=choosers,
 model_settings=preprocessor_settings,
 locals_dict=locals_d,
 trace_label=trace_label,
 )
 expressions.annotate_preprocessors(
 state,
 df=choosers,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, model_settings_file_name)
Expand DownExpand Up@@ -120,8 +112,13 @@ def auto_ownership_simulate(
 "auto_ownership", households.auto_ownership, value_counts=True
 )

 if model_settings.annotate_households:
 annotate.annotate_households(state, model_settings, trace_label)

 if trace_hh_id:
 state.tracing.trace_df(households, label="auto_ownership", warn_if_empty=True)

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

41 changes: 25 additions & 16 deletions
activitysim/abm/models/cdap.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,12 +36,17 @@ class CdapSettings(PydanticReadable, extra="forbid"):
 JOINT_TOUR_COEFFICIENTS: str = "cdap_joint_tour_coefficients.csv"
 JOINT_TOUR_USEFUL_COLUMNS: list[str] | None = None
 """Columns to include from the persons table that will be need to calculate household joint tour utility."""
 annotate_persons: PreprocessorSettings | None = None
 annotate_households: PreprocessorSettings | None = None
 COEFFICIENTS: Path
 CONSTANTS: dict[str, Any] = {}
 compute_settings: ComputeSettings | None = None

 preprocessor: PreprocessorSettings | None = None
 """Preprocess choosers tables before running the model."""
 annotate_persons: PreprocessorSettings | None = None
@jpn--jpn--Jun 27, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automatic documentation tools will work better if annotate_persons has its own docstring, even though it's clear to a human reader the one docstring below applies to both.
@dhensledhensleJul 1, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done
 """Postprocess persons table after model completion."""
 annotate_households: PreprocessorSettings | None = None
 """Postprocess households table after model completion."""


@workflow.step
def cdap_simulate(
Expand DownExpand Up@@ -171,6 +176,16 @@ def cdap_simulate(
 index=True,
 )

 # preprocess choosers
 expressions.annotate_preprocessors(
 state,
 df=persons_merged,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, "cdap.yaml")
 estimator.write_spec(model_settings, tag="INDIV_AND_HHSIZE1_SPEC")
Expand DownExpand Up@@ -241,31 +256,25 @@ def cdap_simulate(
 cap_cat_type = pd.api.types.CategoricalDtype(["", "M", "N", "H"], ordered=False)
 choices = choices.astype(cap_cat_type)
 persons["cdap_activity"] = choices

 expressions.assign_columns(
 state,
 df=persons,
 model_settings=model_settings.annotate_persons,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_persons"),
 )

 state.add_table("persons", persons)

 # - annotate households table
 if add_joint_tour_utility:
 hh_joint = hh_joint.reindex(households.index)
 households["has_joint_tour"] = hh_joint

 expressions.assign_columns(
 state,
 df=households,
 model_settings=model_settings.annotate_households,
 trace_label=tracing.extend_trace_label(trace_label, "annotate_households"),
 )
 state.add_table("households", households)

 tracing.print_summary("cdap_activity", persons.cdap_activity, value_counts=True)
 logger.info(
 "cdap crosstabs:\n%s"
 % pd.crosstab(persons.ptype, persons.cdap_activity, margins=True)
 )

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

35 changes: 17 additions & 18 deletions
activitysim/abm/models/free_parking.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,9 +26,6 @@ class FreeParkingSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `free_parking` component.
 """

 preprocessor: PreprocessorSettings | None = None
 """Setting for the preprocessor."""

 FREE_PARKING_ALT: int
 """The code for free parking."""

Expand DownExpand Up@@ -78,21 +75,6 @@ def free_parking(

 constants = model_settings.CONSTANTS or {}

 # - preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_d = {}
 if constants is not None:
 locals_d.update(constants)

 expressions.assign_columns(
 state,
 df=choosers,
 model_settings=preprocessor_settings,
 locals_dict=locals_d,
 trace_label=trace_label,
 )

 model_spec = state.filesystem.read_model_spec(file_name=model_settings.SPEC)
 coefficients_df = state.filesystem.read_model_coefficients(model_settings)
 model_spec = simulate.eval_coefficients(
Expand All@@ -101,6 +83,15 @@ def free_parking(

 nest_spec = config.get_logit_model_settings(model_settings)

 expressions.annotate_preprocessors(
 state,
 df=choosers,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 if estimator:
 estimator.write_model_settings(model_settings, model_settings_file_name)
 estimator.write_spec(file_name=model_settings.SPEC)
Expand DownExpand Up@@ -144,3 +135,11 @@ def free_parking(

 if state.settings.trace_hh_id:
 state.tracing.trace_df(persons, label=trace_label, warn_if_empty=True)

 expressions.annotate_tables(
 state,
 locals_dict=constants,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

51 changes: 29 additions & 22 deletions
activitysim/abm/models/joint_tour_composition.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@
from activitysim.core.configuration.base import PreprocessorSettings
from activitysim.core.configuration.logit import LogitComponentSettings


logger = logging.getLogger(__name__)


Expand All@@ -36,8 +37,7 @@ class JointTourCompositionSettings(LogitComponentSettings, extra="forbid"):
 Settings for the `joint_tour_composition` component.
 """

 preprocessor: PreprocessorSettings | None = None
 """Setting for the preprocessor."""
 pass


@workflow.step
Expand DownExpand Up@@ -78,26 +78,6 @@ def joint_tour_composition(
 "Running joint_tour_composition with %d joint tours" % joint_tours.shape[0]
 )

 # - run preprocessor
 preprocessor_settings = model_settings.preprocessor
 if preprocessor_settings:
 locals_dict = {
 "persons": persons,
 "hh_time_window_overlap": lambda *x: hh_time_window_overlap(state, *x),
 }

 expressions.assign_columns(
 state,
 df=households,
 model_settings=preprocessor_settings,
 locals_dict=locals_dict,
 trace_label=trace_label,
 )

 joint_tours_merged = pd.merge(
 joint_tours, households, left_on="household_id", right_index=True, how="left"
 )

 # - simple_simulate
 model_spec = state.filesystem.read_model_spec(file_name=model_settings.SPEC)
 coefficients_df = state.filesystem.read_model_coefficients(model_settings)
Expand All@@ -108,6 +88,25 @@ def joint_tour_composition(
 nest_spec = config.get_logit_model_settings(model_settings)
 constants = config.get_model_constants(model_settings)

 locals_dict = {
 "persons": persons,
 "hh_time_window_overlap": lambda *x: hh_time_window_overlap(state, *x),
 }
 locals_dict.update(constants)

 expressions.annotate_preprocessors(
 state,
 df=households,
 locals_dict=locals_dict,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )

 joint_tours_merged = pd.merge(
 joint_tours, households, left_on="household_id", right_index=True, how="left"
 )

 if estimator:
 estimator.write_spec(model_settings)
 estimator.write_model_settings(model_settings, model_settings_file_name)
Expand DownExpand Up@@ -156,3 +155,11 @@ def joint_tour_composition(
 label="joint_tour_composition.joint_tours",
 slicer="household_id",
 )

 expressions.annotate_tables(
 state,
 locals_dict=locals_dict,
 skims=None,
 model_settings=model_settings,
 trace_label=trace_label,
 )
Loading