syntropy package

Syntropy: A package for multivariate information theory on discrete and continuous random variables.

This package provides tools for computing information-theoretic quantities including entropy, mutual information, and various multivariate decompositions for discrete, Gaussian, and general continuous distributions.

Subpackages

• syntropy.discrete package
  • shannon_entropy()
  • conditional_entropy()
  • mutual_information()
  • conditional_mutual_information()
  • kullback_leibler_divergence()
  • total_correlation()
  • dual_total_correlation()
  • s_information()
  • o_information()
  • tse_complexity()
  • description_complexity()
  • co_information()
  • connected_information()
  • partial_entropy_decomposition()
  • partial_information_decomposition()
  • generalized_information_decomposition()
  • representational_complexity()
  • lempel_ziv_complexity()
  • lempel_ziv_mutual_information()
  • lempel_ziv_total_correlation()
  • cross_lempel_ziv_complexity()
  • Submodules
  • syntropy.discrete.alpha_synergy module
    • alpha_synergistic_entropy()
    • partial_entropy_spectra()
    • partial_kullback_leibler_spectra()
    • partial_total_correlation_spectra()
    • partial_information_spectra()
  • syntropy.discrete.optimization module
    • constrained_maximum_entropy_distributions()
  • syntropy.discrete.temporal module
    • lempel_ziv_complexity()
    • lempel_ziv_mutual_information()
    • conditional_lempel_ziv_complexity()
    • lempel_ziv_total_correlation()
    • cross_lempel_ziv_complexity()
  • syntropy.discrete.utils module
    • make_powerset()
    • clean_distribution()
    • reduce_state()
    • construct_joint_distribution()
    • get_marginal_distribution()
    • marginalize_out()
    • get_all_marginal_distributions()
    • product_distribution()
    • generate_closed_distribution()
• syntropy.gaussian package
  • differential_entropy()
  • local_differential_entropy()
  • conditional_entropy()
  • local_conditional_entropy()
  • mutual_information()
  • local_mutual_information()
  • conditional_mutual_information()
  • local_conditional_mutual_information()
  • kullback_leibler_divergence()
  • local_kullback_leibler_divergence()
  • local_total_correlation()
  • total_correlation()
  • local_dual_total_correlation()
  • dual_total_correlation()
  • local_s_information()
  • s_information()
  • local_o_information()
  • o_information()
  • tse_complexity()
  • description_complexity()
  • partial_entropy_decomposition()
  • partial_information_decomposition()
  • generalized_information_decomposition()
  • representational_complexity()
  • differential_entropy_rate()
  • mutual_information_rate()
  • total_correlation_rate()
  • dual_total_correlation_rate()
  • s_information_rate()
  • o_information_rate()
  • Submodules
  • syntropy.gaussian.optimization module
    • neg_o_information()
    • simulated_annealing()
    • irreducible_synergy()
  • syntropy.gaussian.utils module
    • check_cov()
    • make_powerset()
    • correlation_to_mutual_information()
• syntropy.knn package
  • differential_entropy()
  • mutual_information()
  • conditional_mutual_information()
  • total_correlation()
  • dual_total_correlation()
  • s_information()
  • o_information()
  • Submodules
  • syntropy.knn.multivariate_mi module
    • total_correlation()
    • total_correlation_1()
    • total_correlation_2()
    • dual_total_correlation()
    • s_information()
    • o_information()
  • syntropy.knn.shannon module
    • differential_entropy()
    • mutual_information()
    • mutual_information_1()
    • mutual_information_2()
    • conditional_mutual_information()
  • syntropy.knn.utils module
    • check_idxs()
    • build_tree_and_get_distances()
    • get_counts_from_tree()
• syntropy.lattices package
• syntropy.neural package
  • differential_entropy()
  • mutual_information()
  • total_correlation()
  • higher_order_information()
  • Submodules
  • syntropy.neural.multivariate_mi module
    • total_correlation()
    • higher_order_information()
  • syntropy.neural.shannon module
    • differential_entropy()
    • conditional_entropy()
    • mutual_information()
    • conditional_mutual_information()
  • syntropy.neural.utils module
    • initialize_flow()
    • train_flow()
    • evaluate_flow()
• syntropy.mixed package
  • shannon_entropy()
  • conditional_entropy()
  • mutual_information()
  • Submodules
  • syntropy.mixed.shannon module
    • shannon_entropy()
    • conditional_entropy()
    • mutual_information()
  • syntropy.mixed.utils module