Skip to content

Adds explicit metadata for bias intervention #130

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
micahwoodard merged 1 commit into from
Jul 8, 2026
+12 −2
Merged

Adds explicit metadata for bias intervention #130

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 12 additions & 2 deletions ...aind_behavior_dynamic_foraging/task_logic/trial_generators/block_based_trial_generator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ class BlockBasedTrialMetadata(BaseModel):
"""Metadata for block based trial. These fields will NOT be used by the task engine."""

is_autowater: bool = Field(default=False, description="Flag indicating if autowater is given for trial.")
is_bias_water_intervention: bool = Field(
default=False, description="Flag indicating if bias water intervention is given for trial."
)
is_bias_stage_intervention: bool = Field(
default=False, description="Flag indicating if bias stage intervention is given for trial."
)


class AutoWaterParameters(BaseModel):
Expand Down Expand Up @@ -203,7 +209,7 @@ def next(self) -> Trial | None:

# determine bias correction. Overrides autowater
lickspout_offset_delta = 0
if self.bias_intervention.are_antibias_conditions_met(self.bias):
if is_bias_intervention := self.bias_intervention.are_antibias_conditions_met(self.bias):
is_auto_reward_right, lickspout_offset_delta = self.bias_intervention.determine_antibias_intervention(
self.bias
)
Expand All @@ -224,7 +230,11 @@ def next(self) -> Trial | None:
metadata=Metadata(
p_reward_left=self.block.p_left_reward,
p_reward_right=self.block.p_right_reward,
extra=BlockBasedTrialMetadata(is_autowater=is_autowater),
extra=BlockBasedTrialMetadata(
is_autowater=is_autowater and not is_bias_intervention,
is_bias_water_intervention=is_bias_intervention and is_auto_reward_right is not None,
is_bias_stage_intervention=is_bias_intervention and lickspout_offset_delta != 0,
),
),
)

Expand Down