API Reference

• balance
  • help()
  • setup_logging()
  • balance.adjustment
    • apply_transformations()
    • default_transformations()
    • trim_weights()
  • balance.balance_frame
    • BalanceFrame
      • BalanceFrame.responders
      • BalanceFrame.target
      • BalanceFrame.is_adjusted
      • BalanceFrame.adjust()
      • BalanceFrame.covars()
      • BalanceFrame.design_matrix()
      • BalanceFrame.df
      • BalanceFrame.df_all
      • BalanceFrame.df_ignored
      • BalanceFrame.df_responders
      • BalanceFrame.df_responders_unadjusted
      • BalanceFrame.df_target
      • BalanceFrame.diagnostics()
      • BalanceFrame.fit()
      • BalanceFrame.from_sample()
      • BalanceFrame.has_target
      • BalanceFrame.id_column
      • BalanceFrame.id_series
      • BalanceFrame.is_adjusted
      • BalanceFrame.keep_only_some_rows_columns()
      • BalanceFrame.model
      • BalanceFrame.model_matrix()
      • BalanceFrame.outcomes()
      • BalanceFrame.predict_proba()
      • BalanceFrame.predict_weights()
      • BalanceFrame.responders
      • BalanceFrame.set_as_pre_adjust()
      • BalanceFrame.set_fitted_model()
      • BalanceFrame.set_target()
      • BalanceFrame.set_unadjusted()
      • BalanceFrame.set_weights()
      • BalanceFrame.summary()
      • BalanceFrame.target
      • BalanceFrame.to_csv()
      • BalanceFrame.to_download()
      • BalanceFrame.to_sample()
      • BalanceFrame.trim()
      • BalanceFrame.unadjusted
      • BalanceFrame.weight_series
      • BalanceFrame.weights()
  • balance.balancedf_class
    • BalanceDF
      • BalanceDF.asmd()
      • BalanceDF.asmd_improvement()
      • BalanceDF.ci_of_mean()
      • BalanceDF.cvmd()
      • BalanceDF.df
      • BalanceDF.emd()
      • BalanceDF.kld()
      • BalanceDF.ks()
      • BalanceDF.mean()
      • BalanceDF.mean_with_ci()
      • BalanceDF.model_matrix()
      • BalanceDF.names()
      • BalanceDF.plot()
      • BalanceDF.std()
      • BalanceDF.summary()
      • BalanceDF.to_csv()
      • BalanceDF.to_download()
      • BalanceDF.var_of_mean()
    • BalanceDFCovars
      • BalanceDFCovars.from_frame()
      • BalanceDFCovars.model_matrix()
    • BalanceDFOutcomes
      • BalanceDFOutcomes.outcome_sd_prop()
      • BalanceDFOutcomes.outcome_variance_ratio()
      • BalanceDFOutcomes.relative_response_rates()
      • BalanceDFOutcomes.summary()
      • BalanceDFOutcomes.target_response_rates()
      • BalanceDFOutcomes.weights_impact_on_outcome_ss()
    • BalanceDFSource
      • BalanceDFSource.weight_series
      • BalanceDFSource.id_series
      • BalanceDFSource._links
      • BalanceDFSource._outcome_columns
      • BalanceDFSource._covar_columns()
      • BalanceDFSource.set_weights()
      • BalanceDFSource.trim()
    • BalanceDFWeights
      • BalanceDFWeights.design_effect()
      • BalanceDFWeights.design_effect_prop()
      • BalanceDFWeights.df
      • BalanceDFWeights.plot()
      • BalanceDFWeights.r_indicator()
      • BalanceDFWeights.summary()
      • BalanceDFWeights.trim()
  • balance.cli
    • BalanceCLI
      • BalanceCLI.adapt_output()
      • BalanceCLI.batch_columns()
      • BalanceCLI.check_input_columns()
      • BalanceCLI.covariate_columns()
      • BalanceCLI.covariate_columns_for_diagnostics()
      • BalanceCLI.formula()
      • BalanceCLI.has_batch_columns()
      • BalanceCLI.has_keep_columns()
      • BalanceCLI.has_keep_row_column()
      • BalanceCLI.has_outcome_columns()
      • BalanceCLI.id_column()
      • BalanceCLI.keep_columns()
      • BalanceCLI.keep_row_column()
      • BalanceCLI.lambda_max()
      • BalanceCLI.lambda_min()
      • BalanceCLI.load_and_check_input()
      • BalanceCLI.logistic_regression_kwargs()
      • BalanceCLI.logistic_regression_model()
      • BalanceCLI.main()
      • BalanceCLI.max_de()
      • BalanceCLI.method()
      • BalanceCLI.num_lambdas()
      • BalanceCLI.one_hot_encoding()
      • BalanceCLI.outcome_columns()
      • BalanceCLI.process_batch()
      • BalanceCLI.rows_to_keep_for_diagnostics()
      • BalanceCLI.sample_column()
      • BalanceCLI.split_sample()
      • BalanceCLI.standardize_types()
      • BalanceCLI.transformations()
      • BalanceCLI.update_attributes_for_main_used_by_adjust()
      • BalanceCLI.weight_column()
      • BalanceCLI.weight_trimming_mean_ratio()
      • BalanceCLI.weights_impact_on_outcome_method()
      • BalanceCLI.write_outputs()
    • add_arguments_to_parser()
    • main()
    • make_parser()
  • balance.sample_class
    • Sample
      • Sample.id_column
      • Sample.weight_series
      • Sample.from_frame()
      • Sample.to_balance_frame()
      • Sample.to_sample_frame()
  • balance.sample_frame
    • SampleFrame
      • SampleFrame.add_weight_column()
      • SampleFrame.covar_columns
      • SampleFrame.covars()
      • SampleFrame.df
      • SampleFrame.df_covars
      • SampleFrame.df_ignored
      • SampleFrame.df_outcomes
      • SampleFrame.df_weights
      • SampleFrame.from_frame()
      • SampleFrame.from_sample()
      • SampleFrame.id_column
      • SampleFrame.id_series
      • SampleFrame.ignored_columns
      • SampleFrame.outcome_columns
      • SampleFrame.outcomes()
      • SampleFrame.predicted_outcome_columns
      • SampleFrame.rename_weight_column()
      • SampleFrame.set_active_weight()
      • SampleFrame.set_weight_metadata()
      • SampleFrame.set_weights()
      • SampleFrame.trim()
      • SampleFrame.weight_column
      • SampleFrame.weight_columns_all
      • SampleFrame.weight_metadata()
      • SampleFrame.weight_series
      • SampleFrame.weights()
  • balance.stats_and_plots
    • balance.stats_and_plots.ascii_plots
      • ascii_comparative_hist()
      • ascii_plot_bar()
      • ascii_plot_dist()
      • ascii_plot_hist()
    • balance.stats_and_plots.general_stats
      • relative_response_rates()
    • balance.stats_and_plots.impact_of_weights_on_outcome
      • compare_adjusted_weighted_outcome_ss()
      • weights_impact_on_outcome_ss()
    • balance.stats_and_plots.weighted_comparisons_plots
      • DataFrameWithWeight
      • naming_legend()
      • plot_bar()
      • plot_dist()
      • plot_hist_kde()
      • plot_qq()
      • plot_qq_categorical()
      • plotly_plot_bar()
      • plotly_plot_density()
      • plotly_plot_dist()
      • plotly_plot_qq()
      • seaborn_plot_dist()
      • set_xy_axes_to_use_the_same_lim()
    • balance.stats_and_plots.weighted_comparisons_stats
      • asmd()
      • asmd_improvement()
      • cvmd()
      • emd()
      • kld()
      • ks()
      • outcome_variance_ratio()
      • r_indicator()
    • balance.stats_and_plots.weighted_stats
      • ci_of_weighted_mean()
      • descriptive_stats()
      • relative_frequency_table()
      • var_of_weighted_mean()
      • weighted_mean()
      • weighted_quantile()
      • weighted_sd()
      • weighted_var()
    • balance.stats_and_plots.weights_stats
      • PropAboveBelowResult
      • design_effect()
      • nonparametric_skew()
      • prop_above_and_below()
      • weighted_median_breakdown_point()
  • balance.summary_utils
  • balance.testutil
    • BalanceTestCase
      • BalanceTestCase.assertEqual()
    • tempfile_path()
  • balance.typing
  • balance.util
    • HighCardinalityFeature
      • HighCardinalityFeature.column
      • HighCardinalityFeature.has_missing
      • HighCardinalityFeature.unique_count
      • HighCardinalityFeature.unique_ratio
    • TruncationFormatter
      • TruncationFormatter.format()
    • add_na_indicator()
    • add_na_indicator_to_combined()
    • auto_spread()
    • build_model_matrix()
    • choose_variables()
    • dot_expansion()
    • drop_na_rows()
    • fct_lump()
    • fct_lump_by()
    • find_items_index_in_list()
    • formula_generator()
    • get_items_from_list_via_indices()
    • guess_id_column()
    • model_matrix()
    • one_hot_encoding_greater_2
    • process_formula()
    • qcut()
    • quantize()
    • rm_mutual_nas()
    • row_pairwise_diffs()
  • balance.weighting_methods
    • balance.weighting_methods.adjust_null
      • adjust_null()
    • balance.weighting_methods.cbps
      • alpha_function()
      • bal_loss()
      • cbps()
      • compute_deff_from_beta()
      • compute_pseudo_weights_from_logit_probs()
      • gmm_function()
      • gmm_loss()
      • logit_truncated()
    • balance.weighting_methods.ipw
      • calc_dev()
      • choose_regularization()
      • ipw()
      • link_transform()
      • model_coefs()
      • weights_from_link()
    • balance.weighting_methods.poststratify
      • poststratify()
    • balance.weighting_methods.rake
      • prepare_marginal_dist_for_raking()
      • rake()