multi_area#

caf.distribute.gravity_model.multi_area Module#

Implementation of a self-calibrating single area gravity model.

Functions#

dataclass([cls, init, repr, eq, order, ...])

Add dunder methods based on the fields defined in the class.

gravity_model(row_targets, col_targets, ...)

Run a gravity model and returns the distributed row/col targets.

Classes#

Any(*args, **kwargs)

Special type indicating an unconstrained type.

BaseConfig()

Base class for storing model parameters.

GMCalibParams([furness_jac, diff_step, ...])

Parameters required for the multi tld gravity mode calibrate method.

GravityModelResults(cost_distribution, ...)

A collection of results from the Gravity Model.

MGMCostDistribution(name, cost_distribution, ...)

Dataclass for storing needed info for a MultiCostDistribution model.

MultiAreaGravityModelCalibrator(row_targets, ...)

A self-calibrating multi-area gravity model.

MultiCostDistribution(distributions)

Cost distributions to be used for the multi-cost distribution gravity model.

MultiDistInput(*, tld_file, tld_lookup_file, ...)

Input to multi cost distribution calibrator.

Path(*args, **kwargs)

PurePath subclass that can make system calls.