leaf_engine.adapt.schema.adapt_task_schemas

Classes

AdaptActionContinuousMoveSchema

AdaptActionFlexPerformanceSchema

AdaptActionFlexSchema

AdaptActionFlexUncommittedSchema

AdaptActionFlexWeeklySchema

AdaptActionRoundTripSchema

AdaptActionShortySchema

AdaptActionTriangularCircuitSchema

AdaptConsolidatedNetworkActionSchema

AdaptContinuousMoveSchema

AdaptDBLaneSchema

AdaptExplorerLaneDailySpendSchema

AdaptExplorerLaneDailyVolumeSchema

AdaptExplorerLaneDetailVolumeSchema

AdaptExplorerLaneQuickRefSchema

AdaptExplorerLaneScacDailyVolumeSchema

AdaptExplorerLaneScacSpendSchema

AdaptExplorerLaneSummarySchema

AdaptExplorerLaneWeeklyScacSpendSchema

AdaptExternalLaneSchema

AdaptLaneSchema

AdaptLaneSyntheticRateSchema

AdaptMarketSchema

AdaptMarketSyntheticRateSchema

AdaptObservationActualContractRateSpreadSchema

AdaptObservationCarrierChurnSchema

AdaptObservationDailyPatternSchema

AdaptObservationMarketRateVarianceSchema

AdaptObservationShouldBeFlexSchema

AdaptObservationSpotExposureSchema

AdaptObservationWeeklyPatternSchema

AdaptPatternSchema

AdaptPostprocessingBusinessImpactSchema

AdaptPostprocessingBusinessObjectivesSchema

AdaptPostprocessingCompanyStatsSchema

AdaptPostprocessingFlexLaneSummarySchema

AdaptPostprocessingPortfolioSchema

AdaptRoundTripSchema

AdaptShipmentSchema

AdaptTriangularCircuitSchema

OAPatternSchema

OAShipmentSchema

Functions

transform_round_trip(...)

Module Contents

class leaf_engine.adapt.schema.adapt_task_schemas.AdaptActionContinuousMoveSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptActionContinuousMoveSchema'
strict = False
benefit: pandera.typing.Series[float]
days: pandera.typing.Series[float]
deadhead_final: pandera.typing.Series[float]
deadhead_l0_l1: pandera.typing.Series[float]
index: pandera.typing.Index[int]
l0_class_loads_annual: pandera.typing.Series[float]
l0_lane_id: pandera.typing.Series[str]
l0_low: pandera.typing.Series[int]
l0_mean_rpm: pandera.typing.Series[float]
l0_mean_spend: pandera.typing.Series[float]
l0_miles: pandera.typing.Series[float]
l0_name: pandera.typing.Series[str]
l0_outlier_rpm: pandera.typing.Series[int]
l0_owner_name: pandera.typing.Series[str]
l0_weekly_base: pandera.typing.Series[str]
l1_class_loads_annual: pandera.typing.Series[float]
l1_lane_id: pandera.typing.Series[str]
l1_low: pandera.typing.Series[int]
l1_mean_rpm: pandera.typing.Series[float]
l1_mean_spend: pandera.typing.Series[float]
l1_miles: pandera.typing.Series[float]
l1_name: pandera.typing.Series[str]
l1_outlier_rpm: pandera.typing.Series[float]
l1_owner_name: pandera.typing.Series[str]
l1_weekly_base: pandera.typing.Series[str]
low_legs: pandera.typing.Series[int]
margin: pandera.typing.Series[float]
outlier_rpms: pandera.typing.Series[float]
shipper_trigger_linehaul_lsp: pandera.typing.Series[float]
supply_target_day_rate_lsp: pandera.typing.Series[float]
supply_target_day_rate_raw: pandera.typing.Series[float]
supply_target_linehaul_lsp: pandera.typing.Series[float]
total_miles: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptActionFlexPerformanceSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptActionFlexPerformanceSchema'
strict = False
annual_delayed_loads: pandera.typing.Series[float]
annual_loads: pandera.typing.Series[float]
flex_addressed_delayed_loads: pandera.typing.Series[float]
index: pandera.typing.Index[int]
lane: pandera.typing.Series[str]
lane_id: pandera.typing.Series[str]
mean_hist_linehaul_lsp: pandera.typing.Series[float]
on_time_pct_with_flex: pandera.typing.Series[float]
patterns: pandera.typing.Series[str]
pcm_miles: pandera.typing.Series[float]
shipper_trigger_linehaul_lsp: pandera.typing.Series[float]
supply_target_linehaul_lsp: pandera.typing.Series[float]
weekly_base_flex_loads: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptActionFlexSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptActionFlexSchema'
strict = False
annual_total_flex_loads: pandera.typing.Series[float]
index: pandera.typing.Index[int]
lane: pandera.typing.Series[str]
lane_id: pandera.typing.Series[str]
patterns: pandera.typing.Series[str]
pcm_miles: pandera.typing.Series[float]
shipper_trigger_linehaul_lsp: pandera.typing.Series[float]
supply_target_linehaul_lsp: pandera.typing.Series[float]
weekly_base_flex_loads: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptActionFlexUncommittedSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptActionFlexUncommittedSchema'
strict = False
annual_loads: pandera.typing.Series[float]
index: pandera.typing.Index[int]
lane: pandera.typing.Series[str]
lane_id: pandera.typing.Series[str]
mean_hist_linehaul_lsp: pandera.typing.Series[float]
on_time_pct_with_flex: pandera.typing.Series[float]
pcm_miles: pandera.typing.Series[float]
shipper_trigger_linehaul_lsp: pandera.typing.Series[float]
supply_target_linehaul_lsp: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptActionFlexWeeklySchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptActionFlexWeeklySchema'
strict = False
annual_total_flex_loads: pandera.typing.Series[float]
index: pandera.typing.Index[int]
lane: pandera.typing.Series[str]
lane_id: pandera.typing.Series[str]
patterns: pandera.typing.Series[str]
pcm_miles: pandera.typing.Series[float]
shipper_trigger_linehaul_lsp: pandera.typing.Series[float]
supply_target_linehaul_lsp: pandera.typing.Series[float]
weekly_base_flex_loads: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptActionRoundTripSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptActionRoundTripSchema'
strict = False
benefit: pandera.typing.Series[float]
days: pandera.typing.Series[float]
deadhead_final: pandera.typing.Series[float]
deadhead_l0_l1: pandera.typing.Series[float]
index: pandera.typing.Index[int]
l0_class_loads_annual: pandera.typing.Series[float]
l0_lane_id: pandera.typing.Series[str]
l0_low: pandera.typing.Series[int]
l0_mean_rpm: pandera.typing.Series[float]
l0_mean_spend: pandera.typing.Series[float]
l0_miles: pandera.typing.Series[float]
l0_name: pandera.typing.Series[str]
l0_outlier_rpm: pandera.typing.Series[int]
l0_owner_name: pandera.typing.Series[str]
l0_weekly_base: pandera.typing.Series[str]
l1_class_loads_annual: pandera.typing.Series[float]
l1_lane_id: pandera.typing.Series[str]
l1_low: pandera.typing.Series[int]
l1_mean_rpm: pandera.typing.Series[float]
l1_mean_spend: pandera.typing.Series[float]
l1_miles: pandera.typing.Series[float]
l1_name: pandera.typing.Series[str]
l1_outlier_rpm: pandera.typing.Series[float]
l1_owner_name: pandera.typing.Series[str]
l1_weekly_base: pandera.typing.Series[str]
low_legs: pandera.typing.Series[int]
margin: pandera.typing.Series[float]
outlier_rpms: pandera.typing.Series[int]
shipper_trigger_linehaul_lsp: pandera.typing.Series[float]
supply_target_day_rate_lsp: pandera.typing.Series[float]
supply_target_day_rate_raw: pandera.typing.Series[float]
supply_target_linehaul_lsp: pandera.typing.Series[float]
total_miles: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptActionShortySchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptActionShortySchema'
strict = False
balance_adj: pandera.typing.Series[float]
benefit: pandera.typing.Series[float]
deadhead_final: pandera.typing.Series[float]
deadhead_l0_l1: pandera.typing.Series[float]
index: pandera.typing.Index[int]
l0_class_loads_annual: pandera.typing.Series[float]
l0_d_market: pandera.typing.Series[str]
l0_lane_id: pandera.typing.Series[str]
l0_low: pandera.typing.Series[int]
l0_mean_rpm: pandera.typing.Series[float]
l0_miles: pandera.typing.Series[float]
l0_name: pandera.typing.Series[str]
l0_o_market: pandera.typing.Series[str]
l0_outlier_rpm: pandera.typing.Series[int]
l0_owner_name: pandera.typing.Series[str]
l0_weekly_base: pandera.typing.Series[str]
l1_class_loads_annual: pandera.typing.Series[float]
l1_d_market: pandera.typing.Series[str]
l1_lane_id: pandera.typing.Series[str]
l1_low: pandera.typing.Series[int]
l1_mean_rpm: pandera.typing.Series[float]
l1_miles: pandera.typing.Series[float]
l1_name: pandera.typing.Series[str]
l1_o_market: pandera.typing.Series[str]
l1_outlier_rpm: pandera.typing.Series[float]
l1_owner_name: pandera.typing.Series[str]
l1_weekly_base: pandera.typing.Series[str]
leaf_daily_linehaul_lsp: pandera.typing.Series[float]
low_legs: pandera.typing.Series[int]
shipper_trigger_linehaul_lsp: pandera.typing.Series[float]
supply_target_linehaul_lsp: pandera.typing.Series[float]
total_days_transit: pandera.typing.Series[float]
total_miles: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptActionTriangularCircuitSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptActionTriangularCircuitSchema'
strict = False
benefit: pandera.typing.Series[float]
days: pandera.typing.Series[float]
deadhead_final: pandera.typing.Series[float]
deadhead_l0_l1: pandera.typing.Series[float]
deadhead_l1_l2: pandera.typing.Series[float]
index: pandera.typing.Index[int]
l0_class_loads_annual: pandera.typing.Series[float]
l0_lane_id: pandera.typing.Series[str]
l0_low: pandera.typing.Series[int]
l0_mean_rpm: pandera.typing.Series[float]
l0_mean_spend: pandera.typing.Series[float]
l0_miles: pandera.typing.Series[float]
l0_name: pandera.typing.Series[str]
l0_outlier_rpm: pandera.typing.Series[float]
l0_owner_name: pandera.typing.Series[str]
l0_weekly_base: pandera.typing.Series[str]
l1_class_loads_annual: pandera.typing.Series[float]
l1_lane_id: pandera.typing.Series[str]
l1_low: pandera.typing.Series[int]
l1_mean_rpm: pandera.typing.Series[float]
l1_mean_spend: pandera.typing.Series[float]
l1_miles: pandera.typing.Series[float]
l1_name: pandera.typing.Series[str]
l1_outlier_rpm: pandera.typing.Series[float]
l1_owner_name: pandera.typing.Series[str]
l1_weekly_base: pandera.typing.Series[str]
l2_class_loads_annual: pandera.typing.Series[float]
l2_lane_id: pandera.typing.Series[str]
l2_low: pandera.typing.Series[int]
l2_mean_rpm: pandera.typing.Series[float]
l2_mean_spend: pandera.typing.Series[float]
l2_miles: pandera.typing.Series[float]
l2_name: pandera.typing.Series[str]
l2_outlier_rpm: pandera.typing.Series[float]
l2_owner_name: pandera.typing.Series[str]
l2_weekly_base: pandera.typing.Series[str]
low_legs: pandera.typing.Series[int]
margin: pandera.typing.Series[float]
outlier_rpms: pandera.typing.Series[float]
shipper_trigger_linehaul_lsp: pandera.typing.Series[float]
supply_target_day_rate_lsp: pandera.typing.Series[float]
supply_target_day_rate_raw: pandera.typing.Series[float]
supply_target_linehaul_lsp: pandera.typing.Series[float]
total_miles: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptConsolidatedNetworkActionSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptConsolidatedNetworkActionSchema'
strict = False
balance_type: pandera.typing.Series[str]
benefit: pandera.typing.Series[float]
complexity: pandera.typing.Series[float]
days: pandera.typing.Series[float]
deadhead_final: pandera.typing.Series[float]
deadhead_l0_l1: pandera.typing.Series[float]
deadhead_l1_l2: pandera.typing.Series[float]
feasibility: pandera.typing.Series[str]
index: pandera.typing.Index[int]
l0_lane_id: pandera.typing.Series[str]
l0_low: pandera.typing.Series[int]
l0_mean_rpm: pandera.typing.Series[float]
l0_miles: pandera.typing.Series[float]
l0_name: pandera.typing.Series[str]
l0_outlier_rpm: pandera.typing.Series[int]
l0_owner_name: pandera.typing.Series[str]
l0_weekly_base: pandera.typing.Series[str]
l1_lane_id: pandera.typing.Series[str]
l1_low: pandera.typing.Series[int]
l1_mean_rpm: pandera.typing.Series[float]
l1_miles: pandera.typing.Series[float]
l1_name: pandera.typing.Series[str]
l1_outlier_rpm: pandera.typing.Series[int]
l1_owner_name: pandera.typing.Series[str]
l1_weekly_base: pandera.typing.Series[str]
l2_lane_id: pandera.typing.Series[str]
l2_low: pandera.typing.Series[int]
l2_mean_rpm: pandera.typing.Series[float]
l2_miles: pandera.typing.Series[float]
l2_name: pandera.typing.Series[str]
l2_outlier_rpm: pandera.typing.Series[int]
l2_owner_name: pandera.typing.Series[str]
l2_weekly_base: pandera.typing.Series[str]
leaf_daily_linehaul_lsp: pandera.typing.Series[float]
low_legs: pandera.typing.Series[int]
margin: pandera.typing.Series[float]
notes: pandera.typing.Series[str]
running_date: pandera.typing.Series[str]
shipper_trigger_linehaul_lsp: pandera.typing.Series[float]
start_date: pandera.typing.Series[str]
status: pandera.typing.Series[str]
supply_target_day_rate_lsp: pandera.typing.Series[float]
supply_target_linehaul_lsp: pandera.typing.Series[float]
total_miles: pandera.typing.Series[float]
type: pandera.typing.Series[str]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptContinuousMoveSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptContinuousMoveSchema'
strict = False
hav_dist_final: pandera.typing.Series[float]
hav_dist_l0_l1: pandera.typing.Series[float]
index: pandera.typing.Index[int]
l0_lane_id: pandera.typing.Series[str]
l0_miles: pandera.typing.Series[float]
l1_lane_id: pandera.typing.Series[str]
l1_miles: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptDBLaneSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptDBLaneSchema'
strict = False
d_name: pandera.typing.Series[str]
d_wkt: pandera.typing.Series[str]
dest: pandera.typing.Series[str]
equipment_class: pandera.typing.Series[str]
index: pandera.typing.Index[int]
lane_annualized_total_ships: pandera.typing.Series[float]
lane_id: pandera.typing.Series[str]
miles: pandera.typing.Series[float]
o_name: pandera.typing.Series[str]
o_wkt: pandera.typing.Series[str]
origin: pandera.typing.Series[str]
owner: pandera.typing.Series[int]
owner_name: pandera.typing.Series[str]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptExplorerLaneDailySpendSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptExplorerLaneDailySpendSchema'
strict = False
index: pandera.typing.Index[int]
lane_id: pandera.typing.Series[str]
max_linehaul_lsp_basis: pandera.typing.Series[float]
max_linehaul_lsp_basis_rpm: pandera.typing.Series[float]
max_linehaul_shipper_basis: pandera.typing.Series[float]
max_linehaul_shipper_basis_rpm: pandera.typing.Series[float]
max_total_rpm: pandera.typing.Series[float]
max_total_spend: pandera.typing.Series[float]
mean_linehaul_lsp_basis: pandera.typing.Series[float]
mean_linehaul_lsp_basis_rpm: pandera.typing.Series[float]
mean_linehaul_shipper_basis: pandera.typing.Series[float]
mean_linehaul_shipper_basis_rpm: pandera.typing.Series[float]
mean_total_rpm: pandera.typing.Series[float]
mean_total_spend: pandera.typing.Series[float]
min_linehaul_lsp_basis: pandera.typing.Series[float]
min_linehaul_lsp_basis_rpm: pandera.typing.Series[float]
min_linehaul_shipper_basis: pandera.typing.Series[float]
min_linehaul_shipper_basis_rpm: pandera.typing.Series[float]
min_total_rpm: pandera.typing.Series[float]
min_total_spend: pandera.typing.Series[float]
period: pandera.typing.Series[pandas.Timestamp]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptExplorerLaneDailyVolumeSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptExplorerLaneDailyVolumeSchema'
strict = False
index: pandera.typing.Index[int]
lane_id: pandera.typing.Series[str]
leaf: pandera.typing.Series[float]
period: pandera.typing.Series[pandas.Timestamp]
shipments: pandera.typing.Series[float]
trend: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptExplorerLaneDetailVolumeSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptExplorerLaneDetailVolumeSchema'
strict = False
d_city: pandera.typing.Series[str]
d_state: pandera.typing.Series[str]
d_zip: pandera.typing.Series[str]
detail_lane_id: pandera.typing.Series[str]
index: pandera.typing.Index[int]
lane_id: pandera.typing.Series[str]
name: pandera.typing.Series[str]
o_city: pandera.typing.Series[str]
o_state: pandera.typing.Series[str]
o_zip: pandera.typing.Series[str]
period: pandera.typing.Series[pandas.Timestamp]
shipments: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptExplorerLaneQuickRefSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptExplorerLaneQuickRefSchema'
strict = False
annualized_linehaul_lsp: pandera.typing.Series[float]
annualized_loads: pandera.typing.Series[float]
dest: pandera.typing.Series[str]
equipment_class: pandera.typing.Series[str]
explorer_rel_url: pandera.typing.Series[str]
index: pandera.typing.Index[int]
lane_id: pandera.typing.Series[str]
loads: pandera.typing.Series[int]
mean_linehaul_lsp: pandera.typing.Series[float]
mean_spot_linehaul_lsp: pandera.typing.Series[float]
name: pandera.typing.Series[str]
origin: pandera.typing.Series[str]
pcm_miles: pandera.typing.Series[float]
pct_intra_company: pandera.typing.Series[float]
pct_spot: pandera.typing.Series[float]
total_linehaul_lsp: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptExplorerLaneScacDailyVolumeSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptExplorerLaneScacDailyVolumeSchema'
strict = False
index: pandera.typing.Index[int]
lane_id: pandera.typing.Series[str]
period: pandera.typing.Series[pandas.Timestamp]
scac: pandera.typing.Series[str]
shipments: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptExplorerLaneScacSpendSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptExplorerLaneScacSpendSchema'
strict = False
index: pandera.typing.Index[int]
lane_id: pandera.typing.Series[str]
linehaul_lsp_basis: pandera.typing.Series[float]
linehaul_lsp_basis_rpm: pandera.typing.Series[float]
linehaul_shipper_basis: pandera.typing.Series[float]
linehaul_shipper_basis_rpm: pandera.typing.Series[float]
loads: pandera.typing.Series[int]
scac: pandera.typing.Series[str]
total_rpm: pandera.typing.Series[float]
total_spend: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptExplorerLaneSummarySchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptExplorerLaneSummarySchema'
strict = False
action_count: pandera.typing.Series[float]
actions: pandera.typing.Series[str]
d_wkt: pandera.typing.Series[str]
index: pandera.typing.Index[int]
lane_id: pandera.typing.Series[str]
miles: pandera.typing.Series[float]
name: pandera.typing.Series[str]
o_wkt: pandera.typing.Series[str]
observations: pandera.typing.Series[str]
path: pandera.typing.Series[str]
shipments: pandera.typing.Series[float]
spend: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptExplorerLaneWeeklyScacSpendSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptExplorerLaneWeeklyScacSpendSchema'
strict = False
index: pandera.typing.Index[int]
lane_id: pandera.typing.Series[str]
linehaul_lsp_basis: pandera.typing.Series[float]
linehaul_lsp_basis_rpm: pandera.typing.Series[float]
linehaul_shipper_basis: pandera.typing.Series[float]
linehaul_shipper_basis_rpm: pandera.typing.Series[float]
loads: pandera.typing.Series[int]
scac: pandera.typing.Series[str]
total_rpm: pandera.typing.Series[float]
total_spend: pandera.typing.Series[float]
week: pandera.typing.Series[int]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptExternalLaneSchema

Bases: pandera.SeriesSchema

class Config
coerce = True
name = 'AdaptExternalLaneSchema'
strict = False
all_loads_annual: pandera.typing.Series[float]
all_loads_db: pandera.typing.Series[int]
d_market: pandera.typing.Series[str]
d_pt: pandera.typing.Series[str]
dest: pandera.typing.Series[str]
dest_id: pandera.typing.Series[str]
equipment_class: pandera.typing.Series[str]
index: pandera.typing.Index[int]
lane_id: pandera.typing.Series[str]
o_market: pandera.typing.Series[str]
o_pt: pandera.typing.Series[str]
origin: pandera.typing.Series[str]
origin_id: pandera.typing.Series[str]
owner: pandera.typing.Series[int]
owner_name: pandera.typing.Series[str]
pcm_miles: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptLaneSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptLaneSchema'
strict = False
all_loads_annual: pandera.typing.Series[float]
annualization_factor: pandera.typing.Series[float]
base_business_days: pandera.typing.Series[float] | None
base_weekly: pandera.typing.Series[float] | None
d_market: pandera.typing.Series[str]
d_pt: pandera.typing.Series[str]
d_zip: pandera.typing.Series[str]
dest: pandera.typing.Series[str]
index: pandera.typing.Index[int]
lane: pandera.typing.Series[str]
lane_id: pandera.typing.Series[str]
o_market: pandera.typing.Series[str]
o_pt: pandera.typing.Series[str]
o_zip: pandera.typing.Series[str]
origin: pandera.typing.Series[str]
owner: pandera.typing.Series[int]
owner_name: pandera.typing.Series[str]
pcm_lane_path: pandera.typing.Series[str]
pcm_miles: pandera.typing.Series[float]
weekly_pattern: pandera.typing.Series[str] | None
window_days: pandera.typing.Series[int]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptLaneSyntheticRateSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptLaneSyntheticRateSchema'
strict = False
direction: pandera.typing.Series[str]
index: pandera.typing.Index[int]
lane_id: pandera.typing.Series[str]
pcm_miles: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptMarketSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptMarketSchema'
strict = False
airportcode: pandera.typing.Series[str]
index: pandera.typing.Index[int]
reference_city: pandera.typing.Series[str]
reference_state: pandera.typing.Series[str]
zip3: pandera.typing.Series[str]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptMarketSyntheticRateSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptMarketSyntheticRateSchema'
strict = False
d_market: pandera.typing.Series[str]
index: pandera.typing.Index[int]
o_market: pandera.typing.Series[str]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptObservationActualContractRateSpreadSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptObservationActualContractRateSpreadSchema'
strict = False
affected_class_loads_annual: pandera.typing.Series[float]
affected_class_loads_window: pandera.typing.Series[int]
affected_linehaul_zero_peg_annual: pandera.typing.Series[float]
affected_linehaul_zero_peg_window: pandera.typing.Series[float]
annualization_factor: pandera.typing.Series[float]
class_loads_annual: pandera.typing.Series[float]
class_loads_window: pandera.typing.Series[int]
index: pandera.typing.Index[int]
lane_id: pandera.typing.Series[str]
max_linehaul_zero_peg_window: pandera.typing.Series[float]
mean_linehaul_zero_peg_window: pandera.typing.Series[float]
min_linehaul_zero_peg_window: pandera.typing.Series[float]
pcm_miles_mean: pandera.typing.Series[float]
pcm_rpm_mean: pandera.typing.Series[float]
window_days: pandera.typing.Series[int]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptObservationCarrierChurnSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptObservationCarrierChurnSchema'
strict = False
affected_class_loads_annual: pandera.typing.Series[float]
affected_class_loads_window: pandera.typing.Series[int]
affected_linehaul_zero_peg_annual: pandera.typing.Series[float]
affected_linehaul_zero_peg_window: pandera.typing.Series[float]
annualization_factor: pandera.typing.Series[float]
class_loads_annual: pandera.typing.Series[float]
class_loads_window: pandera.typing.Series[int]
dest: pandera.typing.Series[str]
index: pandera.typing.Index[int]
lane: pandera.typing.Series[str]
lane_id: pandera.typing.Series[str]
origin: pandera.typing.Series[str]
window_days: pandera.typing.Series[int]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptObservationDailyPatternSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptObservationDailyPatternSchema'
strict = False
affected_class_loads_annual: pandera.typing.Series[float]
affected_linehaul_annual: pandera.typing.Series[float]
all_loads_annual: pandera.typing.Series[float]
class_loads_annual: pandera.typing.Series[float]
index: pandera.typing.Index[int]
lane: pandera.typing.Series[str]
lane_id: pandera.typing.Series[str]
patterns: pandera.typing.Series[str]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptObservationMarketRateVarianceSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptObservationMarketRateVarianceSchema'
strict = False
affected_class_loads_annual: pandera.typing.Series[float]
affected_class_loads_window: pandera.typing.Series[int]
affected_linehaul_zero_peg_annual: pandera.typing.Series[float]
affected_linehaul_zero_peg_window: pandera.typing.Series[float]
annualization_factor: pandera.typing.Series[float]
d_zip: pandera.typing.Series[str]
index: pandera.typing.Index[int]
lane_id: pandera.typing.Series[str]
mean_linehaul_zero_peg_window: pandera.typing.Series[float]
o_zip: pandera.typing.Series[str]
pcm_miles_mean: pandera.typing.Series[float]
pcm_rpm_mean: pandera.typing.Series[float]
var_vs_spot: pandera.typing.Series[float]
window_days: pandera.typing.Series[int]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptObservationShouldBeFlexSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptObservationShouldBeFlexSchema'
strict = False
affected_class_loads_annual: pandera.typing.Series[float]
affected_linehaul_zero_peg_annual: pandera.typing.Series[float]
all_loads_annual: pandera.typing.Series[float]
class_loads_annual: pandera.typing.Series[float]
index: pandera.typing.Index[int]
lane: pandera.typing.Series[str]
lane_id: pandera.typing.Series[str]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptObservationSpotExposureSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptObservationSpotExposureSchema'
strict = False
spot_percent_greater_than_threshold(df: pandas.DataFrame) pandera.typing.Series[bool]
Parameters:

df (pandas.DataFrame) –

Return type:

pandera.typing.Series[bool]

affected_class_loads_annual: pandera.typing.Series[float]
affected_class_loads_window: pandera.typing.Series[int]
affected_linehaul_zero_peg_annual: pandera.typing.Series[float]
affected_linehaul_zero_peg_window: pandera.typing.Series[float]
annualization_factor: pandera.typing.Series[float]
class_loads_annual: pandera.typing.Series[float]
class_loads_window: pandera.typing.Series[int]
index: pandera.typing.Index[int]
lane_id: pandera.typing.Series[str]
pcm_miles_mean: pandera.typing.Series[float]
pcm_rpm_mean: pandera.typing.Series[float]
spot_pct: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptObservationWeeklyPatternSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptObservationWeeklyPatternSchema'
strict = False
affected_class_loads_annual: pandera.typing.Series[float]
affected_linehaul_zero_peg_annual: pandera.typing.Series[float]
all_loads_annual: pandera.typing.Series[float]
class_loads_annual: pandera.typing.Series[float]
index: pandera.typing.Index[int]
lane: pandera.typing.Series[str]
lane_id: pandera.typing.Series[str]
patterns: pandera.typing.Series[str]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptPatternSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = None
strict = False
base: pandera.typing.Series[float]
index: pandera.typing.Index[int]
lane_id: pandera.typing.Series[str]
patterns: pandera.typing.Series[str]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptPostprocessingBusinessImpactSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptPostprocessingBusinessImpactSchema'
strict = False
business_impact_current: pandera.typing.Series[int]
business_impact_current_subtitle: pandera.typing.Series[str]
business_impact_potential: pandera.typing.Series[float]
business_impact_potential_subtitle: pandera.typing.Series[str]
business_impact_unit: pandera.typing.Series[str]
index: pandera.typing.Index[int]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptPostprocessingBusinessObjectivesSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptPostprocessingBusinessObjectivesSchema'
strict = False
current_should_value: pandera.typing.Series[float]
current_value: pandera.typing.Series[float]
current_year_month: pandera.typing.Series[str]
end_value: pandera.typing.Series[float]
end_year_month: pandera.typing.Series[str]
index: pandera.typing.Index[int]
start_value: pandera.typing.Series[float]
start_year_month: pandera.typing.Series[str]
status: pandera.typing.Series[str]
subtitle: pandera.typing.Series[str]
title: pandera.typing.Series[str]
type: pandera.typing.Series[str]
unit: pandera.typing.Series[str]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptPostprocessingCompanyStatsSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptPostprocessingCompanyStatsSchema'
strict = False
data_missing: pandera.typing.Series[str]
index: pandera.typing.Index[int]
metric_name: pandera.typing.Series[str]
metric_unit: pandera.typing.Series[str]
metric_value: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptPostprocessingFlexLaneSummarySchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptPostprocessingFlexLaneSummarySchema'
strict = False
contract_carriers_base_load: pandera.typing.Series[int]
d_name: pandera.typing.Series[str]
d_wkt: pandera.typing.Series[str]
daily_loads: pandera.typing.Series[int]
dow_loads: pandera.typing.Series[int]
dynamic_impact: pandera.typing.Series[int]
dynamic_loads: pandera.typing.Series[int]
equip: pandera.typing.Series[str]
index: pandera.typing.Index[int]
lane_id: pandera.typing.Series[str]
lane_type: pandera.typing.Series[str]
leaf_loads: pandera.typing.Series[int]
leaf_spend_annual: pandera.typing.Series[int]
market_external_lanes: pandera.typing.Series[int]
market_external_shippers: pandera.typing.Series[int]
market_external_weekly_shipments: pandera.typing.Series[int]
max_loads: pandera.typing.Series[int]
miles: pandera.typing.Series[float]
o_name: pandera.typing.Series[str]
o_wkt: pandera.typing.Series[str]
oppy_leaf_loads_impact: pandera.typing.Series[int]
oppy_leaf_loads_impact_ex_rt: pandera.typing.Series[int]
oppy_max_impact: pandera.typing.Series[int]
oppy_max_impact_ex_rt: pandera.typing.Series[float]
path: pandera.typing.Series[str]
primary_oppy_type: pandera.typing.Series[str]
rank: pandera.typing.Series[int]
rate_vol_loads: pandera.typing.Series[float]
rt_loads: pandera.typing.Series[float]
seasonal_loads: pandera.typing.Series[int]
shipments_annual: pandera.typing.Series[float]
spend_annual: pandera.typing.Series[float]
weekly_loads: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptPostprocessingPortfolioSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptPostprocessingPortfolioSchema'
strict = False
index: pandera.typing.Index[int]
spend_dedicated: pandera.typing.Series[float]
spend_flex: pandera.typing.Series[float]
spend_spot: pandera.typing.Series[float]
spend_uncommitted: pandera.typing.Series[float]
year_month: pandera.typing.Series[str]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptRoundTripSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptRoundTripSchema'
strict = False
hav_dist_final: pandera.typing.Series[float]
hav_dist_l0_l1: pandera.typing.Series[float]
index: pandera.typing.Index[int]
l0_lane_id: pandera.typing.Series[str]
l0_miles: pandera.typing.Series[float]
l1_lane_id: pandera.typing.Series[str]
l1_miles: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptShipmentSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptPatternSchema'
strict = False
accessorials: pandera.typing.Series[float]
all_loads_annual: pandera.typing.Series[float]
all_loads_window: pandera.typing.Series[int]
annualization_factor: pandera.typing.Series[float]
base_business_days: pandera.typing.Series[float] | None
base_weekly: pandera.typing.Series[float] | None
carrier_type: pandera.typing.Series[str]
class_loads_annual: pandera.typing.Series[float]
class_loads_window: pandera.typing.Series[int]
d_address: pandera.typing.Series[str]
d_city: pandera.typing.Series[str]
d_market: pandera.typing.Series[str]
d_pt: pandera.typing.Series[str]
d_site: pandera.typing.Series[str]
d_state: pandera.typing.Series[str]
d_zip: pandera.typing.Series[str]
dest: pandera.typing.Series[str]
equipment_class: pandera.typing.Series[str]
equipment_type: pandera.typing.Series[str]
exclude_shipment: pandera.typing.Series[bool]
fuel_peg: pandera.typing.Series[int | float]
fuel_surcharge: pandera.typing.Series[int | float]
index: pandera.typing.Index[int]
lane: pandera.typing.Series[str]
lane_id: pandera.typing.Series[str]
linehaul: pandera.typing.Series[int | float]
linehaul_zero_peg: pandera.typing.Series[int | float]
load_type: pandera.typing.Series[str]
month: pandera.typing.Series[int]
move_type: pandera.typing.Series[str]
o_address: pandera.typing.Series[str]
o_city: pandera.typing.Series[str]
o_market: pandera.typing.Series[str]
o_pt: pandera.typing.Series[str]
o_site: pandera.typing.Series[str]
o_state: pandera.typing.Series[str]
o_zip: pandera.typing.Series[str]
origin: pandera.typing.Series[str]
owner: pandera.typing.Series[int]
owner_name: pandera.typing.Series[str]
pcm_hours: pandera.typing.Series[float]
pcm_lane_path: pandera.typing.Series[str]
pcm_miles: pandera.typing.Series[float]
period: pandera.typing.Series[pandas.Timestamp]
protection: pandera.typing.Series[str]
rate_type: pandera.typing.Series[str]
rounded_linehaul: pandera.typing.Series[int | float]
rpm_pcm: pandera.typing.Series[float]
scac: pandera.typing.Series[str]
shipment_id: pandera.typing.Series[str]
spend: pandera.typing.Series[float]
week: pandera.typing.Series[int]
weekly_pattern: pandera.typing.Series[str] | None
window_days: pandera.typing.Series[int]
year: pandera.typing.Series[int]
class leaf_engine.adapt.schema.adapt_task_schemas.AdaptTriangularCircuitSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'AdaptTriangularCircuitSchema'
strict = False
hav_dist_final: pandera.typing.Series[float]
hav_dist_l0_l1: pandera.typing.Series[float]
hav_dist_l1_l2: pandera.typing.Series[float]
index: pandera.typing.Index[int]
l0_lane_id: pandera.typing.Series[str]
l0_miles: pandera.typing.Series[float]
l1_lane_id: pandera.typing.Series[str]
l1_miles: pandera.typing.Series[float]
l2_lane_id: pandera.typing.Series[str]
l2_miles: pandera.typing.Series[float]
class leaf_engine.adapt.schema.adapt_task_schemas.OAPatternSchema

Bases: pandera.SchemaModel

class Config
coerce = True
name = 'OAPatternSchema'
strict = False
base: pandera.typing.Series[float]
equipment_class: pandera.typing.Series[str]
index: pandera.typing.Index[int]
power_lane_id: pandera.typing.Series[str]
type: pandera.typing.Series[str]
weekdays: pandera.typing.Series[str]
class leaf_engine.adapt.schema.adapt_task_schemas.OAShipmentSchema

Bases: pandera.SchemaModel

class Config
coerce = False
name = 'OAShipmentSchema'
strict = False
accessorials: pandera.typing.Series[int | float]
carrier_name: pandera.typing.Series[str]
carrier_scac: pandera.typing.Series[str]
carrier_type: pandera.typing.Series[str]
currency: pandera.typing.Series[str]
d_address: pandera.typing.Series[str]
d_city: pandera.typing.Series[str]
d_cluster_id: pandera.typing.Series[str]
d_country: pandera.typing.Series[str]
d_h3_index: pandera.typing.Series[str]
d_lat: pandera.typing.Series[float]
d_location_id: pandera.typing.Series[str]
d_lon: pandera.typing.Series[float]
d_site: pandera.typing.Series[str]
d_state: pandera.typing.Series[str]
d_zip: pandera.typing.Series[str]
equipment_class: pandera.typing.Series[str]
equipment_type: pandera.typing.Series[str]
exclude_shipment: pandera.typing.Series[bool]
fuel_peg: pandera.typing.Series[int | float]
fuel_surcharge: pandera.typing.Series[int | float]
hazardous: pandera.typing.Series[bool]
index: pandera.typing.Index[int]
linehaul: pandera.typing.Series[int | float]
linehaul_zero_peg: pandera.typing.Series[int | float]
load_type: pandera.typing.Series[str]
mode: pandera.typing.Series[str]
move_type: pandera.typing.Series[str]
o_address: pandera.typing.Series[str]
o_city: pandera.typing.Series[str]
o_cluster_id: pandera.typing.Series[str]
o_country: pandera.typing.Series[str]
o_geometry_string: pandera.typing.Series[str]
o_h3_index: pandera.typing.Series[str]
o_lat: pandera.typing.Series[float]
o_location_id: pandera.typing.Series[str]
o_lon: pandera.typing.Series[float]
o_site: pandera.typing.Series[str]
o_state: pandera.typing.Series[str]
o_zip: pandera.typing.Series[str]
pcm_hours: pandera.typing.Series[float]
pcm_lane_path: pandera.typing.Series[str]
pcm_miles: pandera.typing.Series[float]
period: pandera.typing.Series[pandas.Timestamp]
power_lane_id: pandera.typing.Series[str]
protection: pandera.typing.Series[str]
ptp_lane_id: pandera.typing.Series[str]
shipment_id: pandera.typing.Series[str]
spend: pandera.typing.Series[int | float]
spend_flagged: pandera.typing.Series[bool]
weight: pandera.typing.Series[int]
weight_flagged: pandera.typing.Series[bool]
leaf_engine.adapt.schema.adapt_task_schemas.transform_round_trip(action: leaf_engine.adapt.adapt_actions.Action, round_trip_candidates: AdaptRoundTripSchema) pandera.typing.DataFrame[AdaptActionRoundTripSchema]
Parameters:
Return type:

pandera.typing.DataFrame[AdaptActionRoundTripSchema]