WeightEngine class

weight_engine

Weight engine for managing and executing weighting schemes.

This module provides the WeightEngine class which manages multiple weighting schemes and coordinates the execution of the RIM algorithm across different data segments and groups.

WeightEngine

get_report()

Return a DataFrame summarising results of the calculated weights.

Used to return the metrics commonly used to measure the effectiveness of the calculated weights. Metrics returned (below) will be broken down by weight variable and weight filter.

• Total: unweighted
• Total: weighted
• Weighting efficiency
• Iterations required
• Mean weight factor
• Minimum weight factor
• Maximum weight factor
• Weight factor ratio

Returns:

Type	Description
DataFrame	DataFrame with weight metrics for each scheme and group