dit 2.2__tar.gz → 2.4__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- dit-2.4/.gitignore +66 -0
- dit-2.4/PKG-INFO +589 -0
- dit-2.4/README.rst +475 -0
- dit-2.4/dit/__init__.py +47 -0
- dit-2.4/dit/algorithms/__init__.py +63 -0
- dit-2.4/dit/algorithms/broja_cone.py +371 -0
- dit-2.4/dit/algorithms/broja_method.py +224 -0
- dit-2.4/dit/algorithms/broja_util.py +15 -0
- dit-2.4/dit/algorithms/channelcapacity.py +886 -0
- dit-2.4/dit/algorithms/convex_maximization.py +91 -0
- dit-2.4/dit/algorithms/distribution_optimizers.py +1002 -0
- dit-2.4/dit/algorithms/marginal_lifts.py +190 -0
- dit-2.4/dit/algorithms/maxentropy.py +734 -0
- dit-2.4/dit/algorithms/minimal_sufficient_statistic.py +253 -0
- dit-2.4/dit/algorithms/mixture_of_products.py +263 -0
- dit-2.4/dit/algorithms/mprojection.py +606 -0
- dit-2.4/dit/algorithms/optimization.py +2301 -0
- dit-2.4/dit/algorithms/optimization_jax.py +2333 -0
- dit-2.4/dit/algorithms/optimization_pytensor.py +1981 -0
- dit-2.4/dit/algorithms/optimization_torch.py +2197 -0
- dit-2.4/dit/algorithms/optutil.py +339 -0
- dit-2.4/dit/algorithms/pid_broja.py +970 -0
- dit-2.4/dit/algorithms/pid_references.py +197 -0
- dit-2.4/dit/algorithms/support_spectrum.py +165 -0
- dit-2.4/dit/bgm.py +316 -0
- dit-2.4/dit/cdisthelpers.py +82 -0
- dit-2.4/dit/channelorder/_utils.py +189 -0
- dit-2.4/dit/coding/__init__.py +113 -0
- dit-2.4/dit/coding/_channel.py +286 -0
- dit-2.4/dit/coding/base.py +259 -0
- dit-2.4/dit/coding/codes.py +392 -0
- dit-2.4/dit/coding/convolutional.py +160 -0
- dit-2.4/dit/coding/feedback.py +519 -0
- dit-2.4/dit/coding/ldpc.py +156 -0
- dit-2.4/dit/coding/linear.py +192 -0
- dit-2.4/dit/coding/polar.py +136 -0
- dit-2.4/dit/coding/source_polar.py +516 -0
- dit-2.4/dit/coding/tunstall.py +182 -0
- dit-2.4/dit/distconst.py +1639 -0
- dit-2.4/dit/distribution.py +2679 -0
- dit-2.4/dit/divergences/__init__.py +54 -0
- dit-2.4/dit/divergences/copy_mutual_information.py +86 -0
- dit-2.4/dit/divergences/cross_entropy.py +124 -0
- dit-2.4/dit/divergences/earth_movers_distance.py +232 -0
- dit-2.4/dit/divergences/generalized_divergences.py +324 -0
- dit-2.4/dit/divergences/hypercontractivity_coefficient.py +308 -0
- dit-2.4/dit/divergences/jensen_shannon_divergence.py +175 -0
- dit-2.4/dit/divergences/kullback_leibler_divergence.py +50 -0
- dit-2.4/dit/divergences/maximal_cross_entropy.py +271 -0
- dit-2.4/dit/divergences/variational_distance.py +205 -0
- dit-2.4/dit/example_dists/__init__.py +27 -0
- dit-2.4/dit/example_dists/common_information.py +263 -0
- dit-2.4/dit/example_dists/genetic_code.py +155 -0
- dit-2.4/dit/example_dists/giant_bit.py +57 -0
- dit-2.4/dit/example_dists/intrinsic.py +213 -0
- dit-2.4/dit/example_dists/n_mod_m.py +46 -0
- dit-2.4/dit/example_dists/nonsignalling_boxes.py +271 -0
- dit-2.4/dit/helpers.py +422 -0
- dit-2.4/dit/inference/__init__.py +46 -0
- dit-2.4/dit/inference/_advanced_estimators.py +386 -0
- dit-2.4/dit/inference/_symbols.py +223 -0
- dit-2.4/dit/inference/binning.py +242 -0
- dit-2.4/dit/inference/counts.py +266 -0
- dit-2.4/dit/inference/estimators.py +976 -0
- dit-2.4/dit/inference/gaussian_copula.py +86 -0
- dit-2.4/dit/inference/interaction.py +205 -0
- dit-2.4/dit/inference/knn_estimators.py +490 -0
- dit-2.4/dit/inference/markov_order.py +291 -0
- dit-2.4/dit/inference/posterior.py +129 -0
- dit-2.4/dit/inference/surrogates.py +337 -0
- dit-2.4/dit/inference/time_series.py +85 -0
- dit-2.4/dit/math/__init__.py +47 -0
- dit-2.4/dit/math/ops.py +744 -0
- dit-2.4/dit/math/pmfops.py +460 -0
- dit-2.4/dit/math/sampling.py +452 -0
- dit-2.4/dit/math/sigmaalgebra.py +286 -0
- dit-2.4/dit/multivariate/__init__.py +31 -0
- dit-2.4/dit/multivariate/alpha_synergy.py +259 -0
- dit-2.4/dit/multivariate/common_informations/__init__.py +19 -0
- dit-2.4/dit/multivariate/common_informations/_functional_partition.py +146 -0
- dit-2.4/dit/multivariate/common_informations/base_markov_optimizer.py +384 -0
- dit-2.4/dit/multivariate/common_informations/channel_synthesis.py +356 -0
- dit-2.4/dit/multivariate/common_informations/exact_common_information.py +89 -0
- dit-2.4/dit/multivariate/common_informations/exact_common_information_rate.py +969 -0
- dit-2.4/dit/multivariate/common_informations/functional_common_information.py +375 -0
- dit-2.4/dit/multivariate/common_informations/mss_common_information.py +47 -0
- dit-2.4/dit/multivariate/common_informations/symbolic_ansatz.py +105 -0
- dit-2.4/dit/multivariate/common_informations/tension_common_information.py +433 -0
- dit-2.4/dit/multivariate/deweese.py +367 -0
- dit-2.4/dit/multivariate/frustration.py +696 -0
- dit-2.4/dit/multivariate/higher_order_common_information.py +498 -0
- dit-2.4/dit/multivariate/kirkwood.py +215 -0
- dit-2.4/dit/multivariate/logarithmic_decomposition.py +829 -0
- dit-2.4/dit/multivariate/o_information.py +50 -0
- dit-2.4/dit/multivariate/pointwise.py +519 -0
- dit-2.4/dit/multivariate/secret_key_agreement/__init__.py +59 -0
- dit-2.4/dit/multivariate/secret_key_agreement/base_skar_optimizers.py +1028 -0
- dit-2.4/dit/multivariate/secret_key_agreement/interactive_intrinsic_mutual_informations.py +186 -0
- dit-2.4/dit/multivariate/secret_key_agreement/iterated_discarding.py +147 -0
- dit-2.4/dit/multivariate/secret_key_agreement/less_noisy_intrinsic_mutual_information.py +266 -0
- dit-2.4/dit/multivariate/secret_key_agreement/minimal_intrinsic_mutual_informations.py +206 -0
- dit-2.4/dit/multivariate/secret_key_agreement/multiterminal_skar.py +174 -0
- dit-2.4/dit/multivariate/secret_key_agreement/one_way_skar.py +232 -0
- dit-2.4/dit/multivariate/secret_key_agreement/reduced_intrinsic_mutual_informations.py +206 -0
- dit-2.4/dit/multivariate/secret_key_agreement/relaxed_two_part_intrinsic_mutual_informations.py +226 -0
- dit-2.4/dit/multivariate/secret_key_agreement/secrecy_capacity.py +71 -0
- dit-2.4/dit/multivariate/secret_key_agreement/secret_key_cost.py +229 -0
- dit-2.4/dit/multivariate/secret_key_agreement/skar_lower_bounds.py +86 -0
- dit-2.4/dit/multivariate/secret_key_agreement/two_part_intrinsic_mutual_informations.py +177 -0
- dit-2.4/dit/multivariate/secret_key_agreement/two_way_skar.py +136 -0
- dit-2.4/dit/multivariate/synergistic_disclosure.py +219 -0
- dit-2.4/dit/multivariate/transmission.py +58 -0
- dit-2.4/dit/multivariate/union_information.py +207 -0
- dit-2.4/dit/multivariate/w_information.py +593 -0
- dit-2.4/dit/other/cumulative_residual_entropy.py +243 -0
- dit-2.4/dit/other/disequilibrium.py +76 -0
- dit-2.4/dit/other/lautum_information.py +76 -0
- dit-2.4/dit/other/perplexity.py +39 -0
- dit-2.4/dit/other/renyi_entropy.py +63 -0
- dit-2.4/dit/other/sibson_mutual_information.py +285 -0
- dit-2.4/dit/other/tsallis_entropy.py +51 -0
- dit-2.4/dit/pid/__init__.py +56 -0
- dit-2.4/dit/pid/_utils.py +152 -0
- dit-2.4/dit/pid/bounds.py +672 -0
- dit-2.4/dit/pid/conditional.py +461 -0
- dit-2.4/dit/pid/diagnostics.py +577 -0
- dit-2.4/dit/pid/distributions/__init__.py +57 -0
- dit-2.4/dit/pid/distributions/trivariate.py +96 -0
- dit-2.4/dit/pid/emergence.py +159 -0
- dit-2.4/dit/pid/gid.py +130 -0
- dit-2.4/dit/pid/helpers.py +209 -0
- dit-2.4/dit/pid/hmos.py +122 -0
- dit-2.4/dit/pid/hsx.py +95 -0
- dit-2.4/dit/pid/layercake.py +178 -0
- dit-2.4/dit/pid/measures/__init__.py +106 -0
- dit-2.4/dit/pid/measures/ibroja.py +75 -0
- dit-2.4/dit/pid/measures/ici.py +244 -0
- dit-2.4/dit/pid/measures/ict.py +141 -0
- dit-2.4/dit/pid/measures/ideg.py +602 -0
- dit-2.4/dit/pid/measures/idelta.py +110 -0
- dit-2.4/dit/pid/measures/ideltalambda.py +274 -0
- dit-2.4/dit/pid/measures/idep.py +319 -0
- dit-2.4/dit/pid/measures/ido.py +139 -0
- dit-2.4/dit/pid/measures/igh.py +314 -0
- dit-2.4/dit/pid/measures/ihifi.py +121 -0
- dit-2.4/dit/pid/measures/iig.py +268 -0
- dit-2.4/dit/pid/measures/iipid.py +163 -0
- dit-2.4/dit/pid/measures/iln.py +300 -0
- dit-2.4/dit/pid/measures/imc.py +309 -0
- dit-2.4/dit/pid/measures/imes.py +50 -0
- dit-2.4/dit/pid/measures/imin.py +134 -0
- dit-2.4/dit/pid/measures/immi.py +54 -0
- dit-2.4/dit/pid/measures/ipm.py +75 -0
- dit-2.4/dit/pid/measures/iprec.py +135 -0
- dit-2.4/dit/pid/measures/iproj.py +147 -0
- dit-2.4/dit/pid/measures/irav.py +52 -0
- dit-2.4/dit/pid/measures/irdr.py +192 -0
- dit-2.4/dit/pid/measures/irr.py +47 -0
- dit-2.4/dit/pid/measures/iskar.py +194 -0
- dit-2.4/dit/pid/measures/isx.py +100 -0
- dit-2.4/dit/pid/measures/iwedge.py +132 -0
- dit-2.4/dit/pid/ped.py +174 -0
- dit-2.4/dit/pid/phiid.py +491 -0
- dit-2.4/dit/pid/pid.py +1468 -0
- dit-2.4/dit/pid/properties.py +1573 -0
- dit-2.4/dit/pid/syndisc.py +590 -0
- dit-2.4/dit/profiles/__init__.py +14 -0
- dit-2.4/dit/profiles/binding_mixture.py +141 -0
- dit-2.4/dit/profiles/information_partitions.py +629 -0
- dit-2.4/dit/profiles/marginal_lift.py +93 -0
- dit-2.4/dit/profiles/marginal_utility_of_information.py +160 -0
- dit-2.4/dit/profiles/mflat.py +127 -0
- dit-2.4/dit/profiles/schneidman.py +65 -0
- dit-2.4/dit/rate_distortion/__init__.py +24 -0
- dit-2.4/dit/rate_distortion/blahut_arimoto.py +267 -0
- dit-2.4/dit/rate_distortion/bottleneck_algorithms.py +626 -0
- dit-2.4/dit/rate_distortion/curves.py +786 -0
- dit-2.4/dit/rate_distortion/distortions.py +53 -0
- dit-2.4/dit/rate_distortion/gray_wyner/__init__.py +71 -0
- dit-2.4/dit/rate_distortion/gray_wyner/curve.py +150 -0
- dit-2.4/dit/rate_distortion/gray_wyner/extension.py +999 -0
- dit-2.4/dit/rate_distortion/gray_wyner/extension_plotting.py +808 -0
- dit-2.4/dit/rate_distortion/gray_wyner/network.py +465 -0
- dit-2.4/dit/rate_distortion/gray_wyner/optimizer.py +482 -0
- dit-2.4/dit/rate_distortion/gray_wyner/plotting.py +166 -0
- dit-2.4/dit/rate_distortion/gray_wyner/region.py +498 -0
- dit-2.4/dit/rate_distortion/gray_wyner/shape.py +310 -0
- dit-2.4/dit/rate_distortion/information_bottleneck.py +790 -0
- dit-2.4/dit/rate_distortion/plotting.py +448 -0
- dit-2.4/dit/rate_distortion/privacy_funnel.py +569 -0
- dit-2.4/dit/rate_distortion/rate_distortion.py +395 -0
- dit-2.4/dit/samplespace.py +445 -0
- dit-2.4/dit/shannon/shannon.py +167 -0
- dit-2.4/dit/utils/context.py +68 -0
- dit-2.4/dit/utils/deprecation.py +27 -0
- dit-2.4/dit/utils/latexarray.py +249 -0
- dit-2.4/dit/utils/logger.py +43 -0
- dit-2.4/dit/utils/misc.py +555 -0
- dit-2.4/dit/utils/optimization.py +364 -0
- dit-2.4/dit/utils/table.py +43 -0
- dit-2.4/dit/utils/testing.py +338 -0
- dit-2.4/dit/utils/units.py +121 -0
- dit-2.4/dit/validate.py +259 -0
- dit-2.4/pyproject.toml +323 -0
- dit-2.4/tests/algorithms/test_admui.py +196 -0
- dit-2.4/tests/algorithms/test_broja_cone.py +57 -0
- dit-2.4/tests/algorithms/test_broja_method.py +141 -0
- dit-2.4/tests/algorithms/test_caekl_psp.py +238 -0
- dit-2.4/tests/algorithms/test_channelcapacity.py +780 -0
- dit-2.4/tests/algorithms/test_mixture_of_products.py +136 -0
- dit-2.4/tests/algorithms/test_mprojection.py +200 -0
- dit-2.4/tests/algorithms/test_optimization.py +501 -0
- dit-2.4/tests/algorithms/test_optimizers.py +521 -0
- dit-2.4/tests/algorithms/test_optutil.py +67 -0
- dit-2.4/tests/algorithms/test_review_fixes.py +43 -0
- dit-2.4/tests/algorithms/test_support_spectrum.py +100 -0
- dit-2.4/tests/channelorder/test_utils.py +115 -0
- dit-2.4/tests/coding/test_channel_codes.py +146 -0
- dit-2.4/tests/coding/test_channel_protocol.py +252 -0
- dit-2.4/tests/coding/test_edge_cases.py +157 -0
- dit-2.4/tests/coding/test_feedback.py +335 -0
- dit-2.4/tests/coding/test_linear.py +115 -0
- dit-2.4/tests/coding/test_review_fixes.py +51 -0
- dit-2.4/tests/conftest.py +16 -0
- dit-2.4/tests/divergences/test_copy_mutual_information.py +32 -0
- dit-2.4/tests/divergences/test_emd.py +133 -0
- dit-2.4/tests/divergences/test_generalized_divergences.py +320 -0
- dit-2.4/tests/divergences/test_hypercontractivity_coefficient.py +78 -0
- dit-2.4/tests/divergences/test_maximal_cross_entropy.py +135 -0
- dit-2.4/tests/example_dists/empirical/test_music.py +132 -0
- dit-2.4/tests/example_dists/test_common_information.py +226 -0
- dit-2.4/tests/example_dists/test_dependencies.py +58 -0
- dit-2.4/tests/example_dists/test_genetic_code.py +198 -0
- dit-2.4/tests/example_dists/test_giant_bit.py +36 -0
- dit-2.4/tests/example_dists/test_n_mod_m.py +53 -0
- dit-2.4/tests/example_dists/test_pr_box.py +141 -0
- dit-2.4/tests/inference/test_advanced_estimators.py +167 -0
- dit-2.4/tests/inference/test_binning.py +41 -0
- dit-2.4/tests/inference/test_cmi.py +82 -0
- dit-2.4/tests/inference/test_complexity_estimators.py +85 -0
- dit-2.4/tests/inference/test_continuous_estimators.py +128 -0
- dit-2.4/tests/inference/test_estimators.py +307 -0
- dit-2.4/tests/inference/test_interaction.py +152 -0
- dit-2.4/tests/inference/test_knn_estimators.py +129 -0
- dit-2.4/tests/inference/test_markov_order.py +107 -0
- dit-2.4/tests/inference/test_ordinal.py +105 -0
- dit-2.4/tests/inference/test_posterior.py +48 -0
- dit-2.4/tests/inference/test_surrogates.py +104 -0
- dit-2.4/tests/inference/test_tier3.py +58 -0
- dit-2.4/tests/inference/test_timeseries.py +88 -0
- dit-2.4/tests/inference/test_trials.py +149 -0
- dit-2.4/tests/math/test_aitchison.py +416 -0
- dit-2.4/tests/math/test_pmfops.py +168 -0
- dit-2.4/tests/math/test_sampling.py +248 -0
- dit-2.4/tests/multivariate/common_informations/test_beta_common_information.py +304 -0
- dit-2.4/tests/multivariate/common_informations/test_channel_synthesis.py +220 -0
- dit-2.4/tests/multivariate/common_informations/test_exact_common_information.py +79 -0
- dit-2.4/tests/multivariate/common_informations/test_exact_common_information_rate.py +211 -0
- dit-2.4/tests/multivariate/common_informations/test_functional_common_information.py +236 -0
- dit-2.4/tests/multivariate/common_informations/test_tension_common_information.py +221 -0
- dit-2.4/tests/multivariate/common_informations/test_wyner_common_information.py +100 -0
- dit-2.4/tests/multivariate/secret_key_agreement/test_abin_gohari_sources.py +95 -0
- dit-2.4/tests/multivariate/secret_key_agreement/test_intrinsic_mutual_information.py +259 -0
- dit-2.4/tests/multivariate/secret_key_agreement/test_iterated_discarding.py +84 -0
- dit-2.4/tests/multivariate/secret_key_agreement/test_known_rates.py +222 -0
- dit-2.4/tests/multivariate/secret_key_agreement/test_less_noisy_intrinsic_mutual_information.py +120 -0
- dit-2.4/tests/multivariate/secret_key_agreement/test_minimal_intrinsic_mutual_information.py +68 -0
- dit-2.4/tests/multivariate/secret_key_agreement/test_multiterminal_skar.py +102 -0
- dit-2.4/tests/multivariate/secret_key_agreement/test_one_way_skar.py +50 -0
- dit-2.4/tests/multivariate/secret_key_agreement/test_reduced_intrinsic_mutual_information.py +102 -0
- dit-2.4/tests/multivariate/secret_key_agreement/test_relaxed_two_part_intrinsic_mutual_information.py +41 -0
- dit-2.4/tests/multivariate/secret_key_agreement/test_secret_key_cost.py +112 -0
- dit-2.4/tests/multivariate/secret_key_agreement/test_skars.py +67 -0
- dit-2.4/tests/multivariate/secret_key_agreement/test_two_part_intrinsic_mutual_information.py +82 -0
- dit-2.4/tests/multivariate/secret_key_agreement/test_two_way_skar.py +42 -0
- dit-2.4/tests/multivariate/test_alpha_synergy.py +101 -0
- dit-2.4/tests/multivariate/test_backend.py +342 -0
- dit-2.4/tests/multivariate/test_frustration.py +232 -0
- dit-2.4/tests/multivariate/test_higher_order_common_information.py +211 -0
- dit-2.4/tests/multivariate/test_kirkwood.py +292 -0
- dit-2.4/tests/multivariate/test_logarithmic_decomposition.py +1409 -0
- dit-2.4/tests/multivariate/test_pointwise.py +260 -0
- dit-2.4/tests/multivariate/test_synergistic_disclosure.py +187 -0
- dit-2.4/tests/multivariate/test_w_information.py +302 -0
- dit-2.4/tests/other/test_cumulative_residual_entropy.py +205 -0
- dit-2.4/tests/other/test_sibson_mutual_information.py +159 -0
- dit-2.4/tests/pid/test_bounds.py +345 -0
- dit-2.4/tests/pid/test_conditional.py +241 -0
- dit-2.4/tests/pid/test_degenerate.py +412 -0
- dit-2.4/tests/pid/test_emergence.py +115 -0
- dit-2.4/tests/pid/test_gid.py +102 -0
- dit-2.4/tests/pid/test_hsx.py +72 -0
- dit-2.4/tests/pid/test_ibroja.py +331 -0
- dit-2.4/tests/pid/test_ici.py +205 -0
- dit-2.4/tests/pid/test_ict.py +113 -0
- dit-2.4/tests/pid/test_ideg.py +306 -0
- dit-2.4/tests/pid/test_idelta.py +94 -0
- dit-2.4/tests/pid/test_idep.py +120 -0
- dit-2.4/tests/pid/test_idep_reference.py +243 -0
- dit-2.4/tests/pid/test_igh.py +115 -0
- dit-2.4/tests/pid/test_ihifi.py +279 -0
- dit-2.4/tests/pid/test_iig.py +155 -0
- dit-2.4/tests/pid/test_iipid.py +109 -0
- dit-2.4/tests/pid/test_iln.py +145 -0
- dit-2.4/tests/pid/test_imc.py +133 -0
- dit-2.4/tests/pid/test_imes.py +33 -0
- dit-2.4/tests/pid/test_iprec.py +208 -0
- dit-2.4/tests/pid/test_irav.py +50 -0
- dit-2.4/tests/pid/test_irdr.py +213 -0
- dit-2.4/tests/pid/test_iskar.py +88 -0
- dit-2.4/tests/pid/test_isx.py +233 -0
- dit-2.4/tests/pid/test_iwedge.py +66 -0
- dit-2.4/tests/pid/test_layercake.py +108 -0
- dit-2.4/tests/pid/test_overlap.py +226 -0
- dit-2.4/tests/pid/test_phiid.py +520 -0
- dit-2.4/tests/pid/test_properties.py +696 -0
- dit-2.4/tests/pid/test_reference_families.py +222 -0
- dit-2.4/tests/pid/test_review_fixes.py +74 -0
- dit-2.4/tests/profiles/test_binding_mixture.py +32 -0
- dit-2.4/tests/profiles/test_dual_dependency_decomposition.py +128 -0
- dit-2.4/tests/profiles/test_information_partitions.py +351 -0
- dit-2.4/tests/profiles/test_marginal_lift.py +75 -0
- dit-2.4/tests/profiles/test_mflat_connected.py +99 -0
- dit-2.4/tests/rate_distortion/test_bottleneck_algorithms.py +332 -0
- dit-2.4/tests/rate_distortion/test_curves.py +304 -0
- dit-2.4/tests/rate_distortion/test_extension_profile.py +443 -0
- dit-2.4/tests/rate_distortion/test_gray_wyner.py +179 -0
- dit-2.4/tests/rate_distortion/test_ib.py +107 -0
- dit-2.4/tests/rate_distortion/test_ib_rate.py +105 -0
- dit-2.4/tests/rate_distortion/test_privacy_funnel.py +313 -0
- dit-2.4/tests/rate_distortion/test_review_fixes.py +86 -0
- dit-2.4/tests/rate_distortion/test_tension.py +350 -0
- dit-2.4/tests/shannon/test_shannon.py +98 -0
- dit-2.4/tests/symbolic/test_common_information.py +145 -0
- dit-2.4/tests/test_distconst.py +865 -0
- dit-2.4/tests/test_distribution.py +1709 -0
- dit-2.4/tests/test_distribution_coverage.py +675 -0
- dit-2.4/tests/test_inequalities.py +314 -0
- dit-2.4/tests/test_log_bases.py +174 -0
- dit-2.4/tests/test_review_core_fixes.py +109 -0
- dit-2.4/tests/utils/test_logger.py +20 -0
- dit-2.4/tests/utils/test_table.py +68 -0
- dit-2.2/.gitignore +0 -63
- dit-2.2/PKG-INFO +0 -494
- dit-2.2/README.rst +0 -384
- dit-2.2/dit/__init__.py +0 -41
- dit-2.2/dit/algorithms/__init__.py +0 -39
- dit-2.2/dit/algorithms/broja_cone.py +0 -368
- dit-2.2/dit/algorithms/broja_method.py +0 -178
- dit-2.2/dit/algorithms/broja_util.py +0 -11
- dit-2.2/dit/algorithms/channelcapacity.py +0 -145
- dit-2.2/dit/algorithms/convex_maximization.py +0 -89
- dit-2.2/dit/algorithms/distribution_optimizers.py +0 -871
- dit-2.2/dit/algorithms/maxentropy.py +0 -730
- dit-2.2/dit/algorithms/minimal_sufficient_statistic.py +0 -254
- dit-2.2/dit/algorithms/optimization.py +0 -2280
- dit-2.2/dit/algorithms/optimization_jax.py +0 -2316
- dit-2.2/dit/algorithms/optimization_pytensor.py +0 -1979
- dit-2.2/dit/algorithms/optimization_torch.py +0 -2188
- dit-2.2/dit/algorithms/optutil.py +0 -329
- dit-2.2/dit/algorithms/pid_broja.py +0 -964
- dit-2.2/dit/bgm.py +0 -317
- dit-2.2/dit/cdisthelpers.py +0 -77
- dit-2.2/dit/channelorder/_utils.py +0 -190
- dit-2.2/dit/coding/__init__.py +0 -90
- dit-2.2/dit/coding/_channel.py +0 -119
- dit-2.2/dit/coding/base.py +0 -248
- dit-2.2/dit/coding/codes.py +0 -391
- dit-2.2/dit/coding/convolutional.py +0 -166
- dit-2.2/dit/coding/ldpc.py +0 -154
- dit-2.2/dit/coding/linear.py +0 -197
- dit-2.2/dit/coding/polar.py +0 -134
- dit-2.2/dit/coding/source_polar.py +0 -508
- dit-2.2/dit/coding/tunstall.py +0 -181
- dit-2.2/dit/distconst.py +0 -1289
- dit-2.2/dit/distribution.py +0 -2626
- dit-2.2/dit/divergences/__init__.py +0 -51
- dit-2.2/dit/divergences/copy_mutual_information.py +0 -82
- dit-2.2/dit/divergences/cross_entropy.py +0 -124
- dit-2.2/dit/divergences/earth_movers_distance.py +0 -233
- dit-2.2/dit/divergences/generalized_divergences.py +0 -284
- dit-2.2/dit/divergences/hypercontractivity_coefficient.py +0 -236
- dit-2.2/dit/divergences/jensen_shannon_divergence.py +0 -173
- dit-2.2/dit/divergences/kullback_leibler_divergence.py +0 -46
- dit-2.2/dit/divergences/variational_distance.py +0 -203
- dit-2.2/dit/example_dists/__init__.py +0 -12
- dit-2.2/dit/example_dists/giant_bit.py +0 -57
- dit-2.2/dit/example_dists/intrinsic.py +0 -30
- dit-2.2/dit/example_dists/n_mod_m.py +0 -46
- dit-2.2/dit/example_dists/nonsignalling_boxes.py +0 -43
- dit-2.2/dit/helpers.py +0 -398
- dit-2.2/dit/inference/__init__.py +0 -9
- dit-2.2/dit/inference/binning.py +0 -109
- dit-2.2/dit/inference/counts.py +0 -209
- dit-2.2/dit/inference/estimators.py +0 -104
- dit-2.2/dit/inference/knn_estimators.py +0 -234
- dit-2.2/dit/inference/time_series.py +0 -53
- dit-2.2/dit/math/__init__.py +0 -20
- dit-2.2/dit/math/_close.pyx +0 -35
- dit-2.2/dit/math/equal.py +0 -97
- dit-2.2/dit/math/ops.py +0 -741
- dit-2.2/dit/math/pmfops.py +0 -462
- dit-2.2/dit/math/sampling.py +0 -463
- dit-2.2/dit/math/sigmaalgebra.py +0 -286
- dit-2.2/dit/multivariate/__init__.py +0 -25
- dit-2.2/dit/multivariate/common_informations/__init__.py +0 -16
- dit-2.2/dit/multivariate/common_informations/_functional_partition.py +0 -223
- dit-2.2/dit/multivariate/common_informations/base_markov_optimizer.py +0 -379
- dit-2.2/dit/multivariate/common_informations/exact_common_information.py +0 -85
- dit-2.2/dit/multivariate/common_informations/functional_common_information.py +0 -572
- dit-2.2/dit/multivariate/common_informations/mss_common_information.py +0 -47
- dit-2.2/dit/multivariate/common_informations/symbolic_ansatz.py +0 -103
- dit-2.2/dit/multivariate/deweese.py +0 -364
- dit-2.2/dit/multivariate/logarithmic_decomposition.py +0 -468
- dit-2.2/dit/multivariate/o_information.py +0 -50
- dit-2.2/dit/multivariate/secret_key_agreement/__init__.py +0 -50
- dit-2.2/dit/multivariate/secret_key_agreement/base_skar_optimizers.py +0 -892
- dit-2.2/dit/multivariate/secret_key_agreement/interactive_intrinsic_mutual_informations.py +0 -186
- dit-2.2/dit/multivariate/secret_key_agreement/minimal_intrinsic_mutual_informations.py +0 -196
- dit-2.2/dit/multivariate/secret_key_agreement/one_way_skar.py +0 -118
- dit-2.2/dit/multivariate/secret_key_agreement/reduced_intrinsic_mutual_informations.py +0 -109
- dit-2.2/dit/multivariate/secret_key_agreement/secrecy_capacity.py +0 -65
- dit-2.2/dit/multivariate/secret_key_agreement/skar_lower_bounds.py +0 -86
- dit-2.2/dit/multivariate/secret_key_agreement/two_part_intrinsic_mutual_informations.py +0 -167
- dit-2.2/dit/multivariate/secret_key_agreement/two_way_skar.py +0 -133
- dit-2.2/dit/multivariate/synergistic_disclosure.py +0 -218
- dit-2.2/dit/multivariate/transmission.py +0 -56
- dit-2.2/dit/multivariate/union_information.py +0 -205
- dit-2.2/dit/other/cumulative_residual_entropy.py +0 -224
- dit-2.2/dit/other/disequilibrium.py +0 -75
- dit-2.2/dit/other/lautum_information.py +0 -54
- dit-2.2/dit/other/perplexity.py +0 -38
- dit-2.2/dit/other/renyi_entropy.py +0 -61
- dit-2.2/dit/other/sibson_mutual_information.py +0 -309
- dit-2.2/dit/other/tsallis_entropy.py +0 -50
- dit-2.2/dit/pid/__init__.py +0 -9
- dit-2.2/dit/pid/distributions/__init__.py +0 -55
- dit-2.2/dit/pid/distributions/trivariate.py +0 -85
- dit-2.2/dit/pid/helpers.py +0 -112
- dit-2.2/dit/pid/hmos.py +0 -224
- dit-2.2/dit/pid/measures/__init__.py +0 -56
- dit-2.2/dit/pid/measures/ibroja.py +0 -157
- dit-2.2/dit/pid/measures/ict.py +0 -77
- dit-2.2/dit/pid/measures/ideg.py +0 -187
- dit-2.2/dit/pid/measures/idelta.py +0 -107
- dit-2.2/dit/pid/measures/ideltalambda.py +0 -257
- dit-2.2/dit/pid/measures/idep.py +0 -253
- dit-2.2/dit/pid/measures/ido.py +0 -132
- dit-2.2/dit/pid/measures/igh.py +0 -185
- dit-2.2/dit/pid/measures/iig.py +0 -130
- dit-2.2/dit/pid/measures/iipid.py +0 -148
- dit-2.2/dit/pid/measures/imc.py +0 -301
- dit-2.2/dit/pid/measures/imes.py +0 -39
- dit-2.2/dit/pid/measures/imin.py +0 -88
- dit-2.2/dit/pid/measures/immi.py +0 -45
- dit-2.2/dit/pid/measures/ipm.py +0 -97
- dit-2.2/dit/pid/measures/iprec.py +0 -220
- dit-2.2/dit/pid/measures/iproj.py +0 -225
- dit-2.2/dit/pid/measures/irav.py +0 -106
- dit-2.2/dit/pid/measures/irdr.py +0 -166
- dit-2.2/dit/pid/measures/irr.py +0 -45
- dit-2.2/dit/pid/measures/iskar.py +0 -179
- dit-2.2/dit/pid/measures/isx.py +0 -105
- dit-2.2/dit/pid/measures/iwedge.py +0 -44
- dit-2.2/dit/pid/ped.py +0 -56
- dit-2.2/dit/pid/pid.py +0 -957
- dit-2.2/dit/pid/syndisc.py +0 -585
- dit-2.2/dit/profiles/__init__.py +0 -11
- dit-2.2/dit/profiles/information_partitions.py +0 -453
- dit-2.2/dit/profiles/marginal_utility_of_information.py +0 -162
- dit-2.2/dit/profiles/schneidman.py +0 -58
- dit-2.2/dit/rate_distortion/__init__.py +0 -13
- dit-2.2/dit/rate_distortion/blahut_arimoto.py +0 -229
- dit-2.2/dit/rate_distortion/bottleneck_algorithms.py +0 -501
- dit-2.2/dit/rate_distortion/curves.py +0 -641
- dit-2.2/dit/rate_distortion/distortions.py +0 -50
- dit-2.2/dit/rate_distortion/gray_wyner/__init__.py +0 -31
- dit-2.2/dit/rate_distortion/gray_wyner/curve.py +0 -148
- dit-2.2/dit/rate_distortion/gray_wyner/network.py +0 -248
- dit-2.2/dit/rate_distortion/gray_wyner/optimizer.py +0 -298
- dit-2.2/dit/rate_distortion/gray_wyner/plotting.py +0 -49
- dit-2.2/dit/rate_distortion/information_bottleneck.py +0 -442
- dit-2.2/dit/rate_distortion/plotting.py +0 -245
- dit-2.2/dit/rate_distortion/rate_distortion.py +0 -389
- dit-2.2/dit/samplespace.py +0 -449
- dit-2.2/dit/shannon/shannon.py +0 -163
- dit-2.2/dit/utils/context.py +0 -68
- dit-2.2/dit/utils/latexarray.py +0 -273
- dit-2.2/dit/utils/logger.py +0 -45
- dit-2.2/dit/utils/misc.py +0 -567
- dit-2.2/dit/utils/optimization.py +0 -363
- dit-2.2/dit/utils/table.py +0 -35
- dit-2.2/dit/utils/testing.py +0 -284
- dit-2.2/dit/utils/units.py +0 -74
- dit-2.2/dit/validate.py +0 -259
- dit-2.2/pyproject.toml +0 -324
- dit-2.2/tests/algorithms/test_admui.py +0 -80
- dit-2.2/tests/algorithms/test_broja_cone.py +0 -33
- dit-2.2/tests/algorithms/test_channelcapacity.py +0 -201
- dit-2.2/tests/algorithms/test_optimizers.py +0 -300
- dit-2.2/tests/channelorder/test_utils.py +0 -105
- dit-2.2/tests/coding/test_channel_codes.py +0 -146
- dit-2.2/tests/coding/test_edge_cases.py +0 -157
- dit-2.2/tests/coding/test_linear.py +0 -115
- dit-2.2/tests/conftest.py +0 -8
- dit-2.2/tests/divergences/test_copy_mutual_information.py +0 -24
- dit-2.2/tests/divergences/test_emd.py +0 -115
- dit-2.2/tests/divergences/test_generalized_divergences.py +0 -267
- dit-2.2/tests/divergences/test_hypercontractivity_coefficient.py +0 -62
- dit-2.2/tests/example_dists/test_dependencies.py +0 -57
- dit-2.2/tests/example_dists/test_giant_bit.py +0 -30
- dit-2.2/tests/example_dists/test_n_mod_m.py +0 -47
- dit-2.2/tests/example_dists/test_pr_box.py +0 -38
- dit-2.2/tests/inference/test_binning.py +0 -35
- dit-2.2/tests/inference/test_estimators.py +0 -43
- dit-2.2/tests/inference/test_knn_estimators.py +0 -99
- dit-2.2/tests/inference/test_timeseries.py +0 -96
- dit-2.2/tests/math/test_aitchison.py +0 -416
- dit-2.2/tests/math/test_equal.py +0 -89
- dit-2.2/tests/math/test_pmfops.py +0 -168
- dit-2.2/tests/math/test_sampling.py +0 -241
- dit-2.2/tests/multivariate/common_informations/test_beta_common_information.py +0 -303
- dit-2.2/tests/multivariate/common_informations/test_exact_common_information.py +0 -63
- dit-2.2/tests/multivariate/common_informations/test_functional_common_information.py +0 -386
- dit-2.2/tests/multivariate/common_informations/test_wyner_common_information.py +0 -77
- dit-2.2/tests/multivariate/secret_key_agreement/test_intrinsic_mutual_information.py +0 -227
- dit-2.2/tests/multivariate/secret_key_agreement/test_minimal_intrinsic_mutual_information.py +0 -68
- dit-2.2/tests/multivariate/secret_key_agreement/test_reduced_intrinsic_mutual_information.py +0 -118
- dit-2.2/tests/multivariate/secret_key_agreement/test_skars.py +0 -45
- dit-2.2/tests/multivariate/secret_key_agreement/test_two_part_intrinsic_mutual_information.py +0 -82
- dit-2.2/tests/multivariate/secret_key_agreement/test_two_way_skar.py +0 -30
- dit-2.2/tests/multivariate/test_logarithmic_decomposition.py +0 -410
- dit-2.2/tests/multivariate/test_synergistic_disclosure.py +0 -174
- dit-2.2/tests/other/test_cumulative_residual_entropy.py +0 -195
- dit-2.2/tests/other/test_sibson_mutual_information.py +0 -128
- dit-2.2/tests/pid/test_ibroja.py +0 -73
- dit-2.2/tests/pid/test_ict.py +0 -56
- dit-2.2/tests/pid/test_ideg.py +0 -106
- dit-2.2/tests/pid/test_idelta.py +0 -45
- dit-2.2/tests/pid/test_idep.py +0 -80
- dit-2.2/tests/pid/test_igh.py +0 -60
- dit-2.2/tests/pid/test_iig.py +0 -59
- dit-2.2/tests/pid/test_iipid.py +0 -92
- dit-2.2/tests/pid/test_imc.py +0 -121
- dit-2.2/tests/pid/test_imes.py +0 -21
- dit-2.2/tests/pid/test_iprec.py +0 -65
- dit-2.2/tests/pid/test_irav.py +0 -83
- dit-2.2/tests/pid/test_irdr.py +0 -60
- dit-2.2/tests/pid/test_iskar.py +0 -77
- dit-2.2/tests/pid/test_isx.py +0 -244
- dit-2.2/tests/pid/test_iwedge.py +0 -35
- dit-2.2/tests/profiles/test_information_partitions.py +0 -162
- dit-2.2/tests/rate_distortion/test_bottleneck_algorithms.py +0 -83
- dit-2.2/tests/rate_distortion/test_curves.py +0 -174
- dit-2.2/tests/rate_distortion/test_gray_wyner.py +0 -175
- dit-2.2/tests/rate_distortion/test_ib.py +0 -92
- dit-2.2/tests/shannon/test_shannon.py +0 -89
- dit-2.2/tests/symbolic/test_common_information.py +0 -142
- dit-2.2/tests/test_distconst.py +0 -508
- dit-2.2/tests/test_distribution.py +0 -1630
- dit-2.2/tests/test_distribution_coverage.py +0 -447
- dit-2.2/tests/test_inequalities.py +0 -286
- dit-2.2/tests/utils/test_table.py +0 -21
- {dit-2.2 → dit-2.4}/CREDITS.rst +0 -0
- {dit-2.2 → dit-2.4}/LICENSE.txt +0 -0
- {dit-2.2 → dit-2.4}/dit/abc.py +0 -0
- {dit-2.2 → dit-2.4}/dit/abstractdist.py +0 -0
- {dit-2.2 → dit-2.4}/dit/algorithms/admui.py +0 -0
- {dit-2.2 → dit-2.4}/dit/algorithms/caekl_psp.py +0 -0
- {dit-2.2 → dit-2.4}/dit/algorithms/frankwolfe.py +0 -0
- {dit-2.2 → dit-2.4}/dit/algorithms/ipf.py +0 -0
- {dit-2.2 → dit-2.4}/dit/algorithms/lattice.py +0 -0
- {dit-2.2 → dit-2.4}/dit/algorithms/maxentropyfw.py +0 -0
- {dit-2.2 → dit-2.4}/dit/algorithms/prune_expand.py +0 -0
- {dit-2.2 → dit-2.4}/dit/algorithms/stats.py +0 -0
- {dit-2.2 → dit-2.4}/dit/algorithms/submodular.py +0 -0
- {dit-2.2 → dit-2.4}/dit/channelorder/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/dit/channelorder/deficiency.py +0 -0
- {dit-2.2 → dit-2.4}/dit/channelorder/orderings.py +0 -0
- {dit-2.2 → dit-2.4}/dit/coding/_gf2.py +0 -0
- {dit-2.2 → dit-2.4}/dit/coding/_util.py +0 -0
- {dit-2.2 → dit-2.4}/dit/coding/block_codes.py +0 -0
- {dit-2.2 → dit-2.4}/dit/coding/symbol_code.py +0 -0
- {dit-2.2 → dit-2.4}/dit/coding/universal.py +0 -0
- {dit-2.2 → dit-2.4}/dit/divergences/_kl_nonmerge.py +0 -0
- {dit-2.2 → dit-2.4}/dit/divergences/coupling_metrics.py +0 -0
- {dit-2.2 → dit-2.4}/dit/divergences/maximum_correlation.py +0 -0
- {dit-2.2 → dit-2.4}/dit/divergences/pmf.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_channels/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_channels/_util.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_channels/binary.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_channels/qary.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_channels/trivial.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_dists/circuits.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_dists/dependencies.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_dists/dice.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_dists/empirical/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_dists/empirical/_music.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_dists/empirical/bach.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_dists/empirical/blood_types.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_dists/empirical/car.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_dists/empirical/congress.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_dists/empirical/corelli.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_dists/empirical/penguins.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_dists/empirical/student.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_dists/empirical/titanic.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_dists/mdbsi.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_dists/miscellaneous.py +0 -0
- {dit-2.2 → dit-2.4}/dit/example_dists/numeric.py +0 -0
- {dit-2.2 → dit-2.4}/dit/exceptions.py +0 -0
- {dit-2.2 → dit-2.4}/dit/inference/counts.c +0 -0
- {dit-2.2 → dit-2.4}/dit/inference/counts.h +0 -0
- {dit-2.2 → dit-2.4}/dit/inference/pycounts.pyx +0 -0
- {dit-2.2 → dit-2.4}/dit/inference/segmentaxis.py +0 -0
- {dit-2.2 → dit-2.4}/dit/math/_samplediscrete.pyx +0 -0
- {dit-2.2 → dit-2.4}/dit/math/aitchison.py +0 -0
- {dit-2.2 → dit-2.4}/dit/math/combinatorics.py +0 -0
- {dit-2.2 → dit-2.4}/dit/math/fraction.py +0 -0
- {dit-2.2 → dit-2.4}/dit/math/misc.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/_backend.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/caekl_mutual_information.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/cohesion.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/coinformation.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/common_informations/beta_common_information.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/common_informations/gk_common_information.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/common_informations/kamath_common_information.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/common_informations/maxent_function.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/common_informations/stochastic_gk_common_information.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/common_informations/symbolic_markov.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/common_informations/symbolic_solve.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/common_informations/wyner_common_information.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/cross_mutual_information.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/delta_gamma.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/dual_total_correlation.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/entropy.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/interaction_information.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/mmi_psp.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/necessary_conditional_entropy.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/quax_synergy.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/s_information.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/secret_key_agreement/intrinsic_mutual_informations.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/secret_key_agreement/no_communication.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/secret_key_agreement/trivial_bounds.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/total_correlation.py +0 -0
- {dit-2.2 → dit-2.4}/dit/multivariate/tse_complexity.py +0 -0
- {dit-2.2 → dit-2.4}/dit/other/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/dit/other/extropy.py +0 -0
- {dit-2.2 → dit-2.4}/dit/other/negentropy.py +0 -0
- {dit-2.2 → dit-2.4}/dit/params.py +0 -0
- {dit-2.2 → dit-2.4}/dit/pid/distributions/bivariate.py +0 -0
- {dit-2.2 → dit-2.4}/dit/pid/hcs.py +0 -0
- {dit-2.2 → dit-2.4}/dit/pid/measures/iccs.py +0 -0
- {dit-2.2 → dit-2.4}/dit/profiles/base_profile.py +0 -0
- {dit-2.2 → dit-2.4}/dit/profiles/complexity_profile.py +0 -0
- {dit-2.2 → dit-2.4}/dit/profiles/entropy_triangle.py +0 -0
- {dit-2.2 → dit-2.4}/dit/profiles/shapley_info_decomposition.py +0 -0
- {dit-2.2 → dit-2.4}/dit/shannon/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/dit/symbolic/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/dit/symbolic/distributions.py +0 -0
- {dit-2.2 → dit-2.4}/dit/utils/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/dit/utils/bindargs.py +0 -0
- {dit-2.2 → dit-2.4}/dit/visualization/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/dit/visualization/upset.py +0 -0
- {dit-2.2 → dit-2.4}/tests/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/_backends.py +0 -0
- {dit-2.2 → dit-2.4}/tests/algorithms/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/algorithms/test_caekl_psp_optimizer.py +0 -0
- {dit-2.2 → dit-2.4}/tests/algorithms/test_degrees_of_freedom.py +0 -0
- {dit-2.2 → dit-2.4}/tests/algorithms/test_ipf.py +0 -0
- {dit-2.2 → dit-2.4}/tests/algorithms/test_lattice.py +0 -0
- {dit-2.2 → dit-2.4}/tests/algorithms/test_marginal_constraints.py +0 -0
- {dit-2.2 → dit-2.4}/tests/algorithms/test_maxentropy_fast.py +0 -0
- {dit-2.2 → dit-2.4}/tests/algorithms/test_minimal_sufficient_statistic.py +0 -0
- {dit-2.2 → dit-2.4}/tests/algorithms/test_parallel_sweep.py +0 -0
- {dit-2.2 → dit-2.4}/tests/algorithms/test_prune_expand.py +0 -0
- {dit-2.2 → dit-2.4}/tests/algorithms/test_stats.py +0 -0
- {dit-2.2 → dit-2.4}/tests/algorithms/test_submodular.py +0 -0
- {dit-2.2 → dit-2.4}/tests/channelorder/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/channelorder/test_deficiency.py +0 -0
- {dit-2.2 → dit-2.4}/tests/channelorder/test_orderings.py +0 -0
- {dit-2.2 → dit-2.4}/tests/channelorder/test_properties.py +0 -0
- {dit-2.2 → dit-2.4}/tests/coding/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/coding/test_base.py +0 -0
- {dit-2.2 → dit-2.4}/tests/coding/test_channel.py +0 -0
- {dit-2.2 → dit-2.4}/tests/coding/test_gf2.py +0 -0
- {dit-2.2 → dit-2.4}/tests/coding/test_golomb.py +0 -0
- {dit-2.2 → dit-2.4}/tests/coding/test_source_edges.py +0 -0
- {dit-2.2 → dit-2.4}/tests/coding/test_source_polar.py +0 -0
- {dit-2.2 → dit-2.4}/tests/coding/test_symbol_codes.py +0 -0
- {dit-2.2 → dit-2.4}/tests/coding/test_tunstall.py +0 -0
- {dit-2.2 → dit-2.4}/tests/coding/test_universal.py +0 -0
- {dit-2.2 → dit-2.4}/tests/divergences/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/divergences/test_coupling_metrics.py +0 -0
- {dit-2.2 → dit-2.4}/tests/divergences/test_cross_entropy.py +0 -0
- {dit-2.2 → dit-2.4}/tests/divergences/test_jensen_shannon_divergence.py +0 -0
- {dit-2.2 → dit-2.4}/tests/divergences/test_kullback_leibler_divergence.py +0 -0
- {dit-2.2 → dit-2.4}/tests/divergences/test_maximum_correlation.py +0 -0
- {dit-2.2 → dit-2.4}/tests/divergences/test_nonmerge.py +0 -0
- {dit-2.2 → dit-2.4}/tests/divergences/test_variational_distance.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_channels/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_channels/test_binary.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_channels/test_qary.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_channels/test_trivial.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_channels/test_util.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_dists/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_dists/empirical/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_dists/empirical/test_bach.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_dists/empirical/test_blood_types.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_dists/empirical/test_car.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_dists/empirical/test_congress.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_dists/empirical/test_corelli.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_dists/empirical/test_penguins.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_dists/empirical/test_student.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_dists/empirical/test_titanic.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_dists/test_circuits.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_dists/test_dice.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_dists/test_mdbsi.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_dists/test_miscellaneous.py +0 -0
- {dit-2.2 → dit-2.4}/tests/example_dists/test_numeric.py +0 -0
- {dit-2.2 → dit-2.4}/tests/inference/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/inference/test_counts.py +0 -0
- {dit-2.2 → dit-2.4}/tests/inference/test_segmentaxis.py +0 -0
- {dit-2.2 → dit-2.4}/tests/math/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/math/test_combinatorics.py +0 -0
- {dit-2.2 → dit-2.4}/tests/math/test_fraction.py +0 -0
- {dit-2.2 → dit-2.4}/tests/math/test_misc.py +0 -0
- {dit-2.2 → dit-2.4}/tests/math/test_ops.py +0 -0
- {dit-2.2 → dit-2.4}/tests/math/test_sigmaalgebra.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/common_informations/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/common_informations/test_backend_switching.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/common_informations/test_common_informations.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/common_informations/test_gk_common_information.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/common_informations/test_kamath_common_information.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/common_informations/test_maxent_function.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/common_informations/test_mss_common_information.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/common_informations/test_stochastic_gk_common_information.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/secret_key_agreement/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/secret_key_agreement/test_interactive_intrinsic_mutual_information.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/secret_key_agreement/test_lower_intrinsic_mutual_information.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/secret_key_agreement/test_necessary_intrinsic_mutual_information.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/secret_key_agreement/test_secrecy_capacity.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/secret_key_agreement/test_trivial_bounds.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_caekl_mutual_information.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_cohesion.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_coinformation.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_cross_mutual_information.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_delta_gamma.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_deweese.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_dual_total_correlation.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_entropy.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_interaction_information.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_mmi_psp.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_mutual_informations.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_necessary_conditional_entropy.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_o_information.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_quax_synergy.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_s_information.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_total_correlation.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_transmission.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_tse_complexity.py +0 -0
- {dit-2.2 → dit-2.4}/tests/multivariate/test_union_information.py +0 -0
- {dit-2.2 → dit-2.4}/tests/other/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/other/test_disequilibrium.py +0 -0
- {dit-2.2 → dit-2.4}/tests/other/test_extropy.py +0 -0
- {dit-2.2 → dit-2.4}/tests/other/test_lautum_information.py +0 -0
- {dit-2.2 → dit-2.4}/tests/other/test_negentropy.py +0 -0
- {dit-2.2 → dit-2.4}/tests/other/test_perplexity.py +0 -0
- {dit-2.2 → dit-2.4}/tests/other/test_renyi_entropy.py +0 -0
- {dit-2.2 → dit-2.4}/tests/other/test_tsallis_entropy.py +0 -0
- {dit-2.2 → dit-2.4}/tests/pid/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/pid/test_hcs.py +0 -0
- {dit-2.2 → dit-2.4}/tests/pid/test_hmos.py +0 -0
- {dit-2.2 → dit-2.4}/tests/pid/test_iccs.py +0 -0
- {dit-2.2 → dit-2.4}/tests/pid/test_ido.py +0 -0
- {dit-2.2 → dit-2.4}/tests/pid/test_imin.py +0 -0
- {dit-2.2 → dit-2.4}/tests/pid/test_immi.py +0 -0
- {dit-2.2 → dit-2.4}/tests/pid/test_ipm.py +0 -0
- {dit-2.2 → dit-2.4}/tests/pid/test_iproj.py +0 -0
- {dit-2.2 → dit-2.4}/tests/pid/test_irr.py +0 -0
- {dit-2.2 → dit-2.4}/tests/pid/test_modified_syndisc.py +0 -0
- {dit-2.2 → dit-2.4}/tests/pid/test_pid_distribution.py +0 -0
- {dit-2.2 → dit-2.4}/tests/pid/test_syndisc.py +0 -0
- {dit-2.2 → dit-2.4}/tests/pid/test_syndisc_fast.py +0 -0
- {dit-2.2 → dit-2.4}/tests/pid/test_syndisc_lattice.py +0 -0
- {dit-2.2 → dit-2.4}/tests/profiles/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/profiles/test_base_profile.py +0 -0
- {dit-2.2 → dit-2.4}/tests/profiles/test_complexity_profile.py +0 -0
- {dit-2.2 → dit-2.4}/tests/profiles/test_entropy_triangle.py +0 -0
- {dit-2.2 → dit-2.4}/tests/profiles/test_mui.py +0 -0
- {dit-2.2 → dit-2.4}/tests/profiles/test_schneidman.py +0 -0
- {dit-2.2 → dit-2.4}/tests/profiles/test_shapley_info_decomposition.py +0 -0
- {dit-2.2 → dit-2.4}/tests/rate_distortion/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/rate_distortion/test_rd.py +0 -0
- {dit-2.2 → dit-2.4}/tests/shannon/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/symbolic/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/symbolic/test_cross_validation.py +0 -0
- {dit-2.2 → dit-2.4}/tests/symbolic/test_symbolic.py +0 -0
- {dit-2.2 → dit-2.4}/tests/test_abstractdist.py +0 -0
- {dit-2.2 → dit-2.4}/tests/test_bgm.py +0 -0
- {dit-2.2 → dit-2.4}/tests/test_cdisthelpers.py +0 -0
- {dit-2.2 → dit-2.4}/tests/test_exceptions.py +0 -0
- {dit-2.2 → dit-2.4}/tests/test_helpers.py +0 -0
- {dit-2.2 → dit-2.4}/tests/test_params.py +0 -0
- {dit-2.2 → dit-2.4}/tests/test_samplespace.py +0 -0
- {dit-2.2 → dit-2.4}/tests/test_validate.py +0 -0
- {dit-2.2 → dit-2.4}/tests/utils/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/utils/test_bindargs.py +0 -0
- {dit-2.2 → dit-2.4}/tests/utils/test_bindargs3.py +0 -0
- {dit-2.2 → dit-2.4}/tests/utils/test_context.py +0 -0
- {dit-2.2 → dit-2.4}/tests/utils/test_latexarray.py +0 -0
- {dit-2.2 → dit-2.4}/tests/utils/test_misc.py +0 -0
- {dit-2.2 → dit-2.4}/tests/utils/test_optimization.py +0 -0
- {dit-2.2 → dit-2.4}/tests/utils/test_testing.py +0 -0
- {dit-2.2 → dit-2.4}/tests/utils/test_units.py +0 -0
- {dit-2.2 → dit-2.4}/tests/visualization/__init__.py +0 -0
- {dit-2.2 → dit-2.4}/tests/visualization/test_upset.py +0 -0
dit-2.4/.gitignore
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# Python related
|
|
2
|
+
*.pyc
|
|
3
|
+
*.pyo
|
|
4
|
+
*.so
|
|
5
|
+
|
|
6
|
+
# Creating during installation
|
|
7
|
+
MANIFEST
|
|
8
|
+
build/
|
|
9
|
+
dist/
|
|
10
|
+
dit.egg-info/
|
|
11
|
+
|
|
12
|
+
# gedit
|
|
13
|
+
*.*~
|
|
14
|
+
|
|
15
|
+
# known autogenerated .c files
|
|
16
|
+
*.o
|
|
17
|
+
|
|
18
|
+
dit/math/_close.c
|
|
19
|
+
dit/math/_samplediscrete.c
|
|
20
|
+
dit/math/_*.html
|
|
21
|
+
|
|
22
|
+
# ignore coverage information
|
|
23
|
+
.coverage*
|
|
24
|
+
coverage.xml
|
|
25
|
+
|
|
26
|
+
# ignore project files for various IDEs
|
|
27
|
+
|
|
28
|
+
# komodo
|
|
29
|
+
*.kpf
|
|
30
|
+
*.komodoproject
|
|
31
|
+
.komodotools
|
|
32
|
+
|
|
33
|
+
# geany
|
|
34
|
+
*.geany
|
|
35
|
+
|
|
36
|
+
# ignore rope's project directory...
|
|
37
|
+
.ropeproject
|
|
38
|
+
|
|
39
|
+
# vscode
|
|
40
|
+
.vscode
|
|
41
|
+
|
|
42
|
+
# cursor
|
|
43
|
+
.cursor/
|
|
44
|
+
|
|
45
|
+
# vim
|
|
46
|
+
*.swp
|
|
47
|
+
*.swo
|
|
48
|
+
|
|
49
|
+
# ignore the documentation build directory
|
|
50
|
+
docs/_build/
|
|
51
|
+
docs/images/idiagrams.pdf
|
|
52
|
+
docs/images/*.png
|
|
53
|
+
.idea/
|
|
54
|
+
.cache/
|
|
55
|
+
.hypothesis/
|
|
56
|
+
.pypirc
|
|
57
|
+
.pytest_cache/
|
|
58
|
+
.vscode
|
|
59
|
+
dit/inference/pycounts.c
|
|
60
|
+
.mypy_cache
|
|
61
|
+
dit.code-workspace
|
|
62
|
+
newrelic_agent.log
|
|
63
|
+
__marimo__
|
|
64
|
+
|
|
65
|
+
# autosummary output
|
|
66
|
+
docs/api/generated/
|
dit-2.4/PKG-INFO
ADDED
|
@@ -0,0 +1,589 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: dit
|
|
3
|
+
Version: 2.4
|
|
4
|
+
Summary: Python package for information theory on discrete random variables.
|
|
5
|
+
Project-URL: Homepage, http://dit.io
|
|
6
|
+
Project-URL: Repository, https://github.com/dit/dit
|
|
7
|
+
Project-URL: Documentation, http://docs.dit.io
|
|
8
|
+
Author-email: chebee7i <admin@dit.io>, "Ryan G. James" <dit@autoplectic.com>
|
|
9
|
+
License-Expression: BSD-3-Clause
|
|
10
|
+
License-File: LICENSE.txt
|
|
11
|
+
Classifier: Intended Audience :: Science/Research
|
|
12
|
+
Classifier: License :: OSI Approved :: BSD License
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering
|
|
18
|
+
Classifier: Topic :: Scientific/Engineering :: Mathematics
|
|
19
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
20
|
+
Requires-Python: >=3.11
|
|
21
|
+
Requires-Dist: boltons
|
|
22
|
+
Requires-Dist: debtcollector
|
|
23
|
+
Requires-Dist: lattices>=0.5
|
|
24
|
+
Requires-Dist: loguru
|
|
25
|
+
Requires-Dist: networkx>=2.6
|
|
26
|
+
Requires-Dist: numpy>=1.22
|
|
27
|
+
Requires-Dist: prettytable>=3.12
|
|
28
|
+
Requires-Dist: scipy>=1.9
|
|
29
|
+
Requires-Dist: xarray
|
|
30
|
+
Provides-Extra: broja
|
|
31
|
+
Requires-Dist: ecos; extra == 'broja'
|
|
32
|
+
Provides-Extra: dev
|
|
33
|
+
Requires-Dist: colorama; extra == 'dev'
|
|
34
|
+
Requires-Dist: hypothesis; extra == 'dev'
|
|
35
|
+
Requires-Dist: hypothesis>=6.0; extra == 'dev'
|
|
36
|
+
Requires-Dist: hypothesis[numpy]; extra == 'dev'
|
|
37
|
+
Requires-Dist: ipython; extra == 'dev'
|
|
38
|
+
Requires-Dist: jax; extra == 'dev'
|
|
39
|
+
Requires-Dist: jaxlib; extra == 'dev'
|
|
40
|
+
Requires-Dist: matplotlib; extra == 'dev'
|
|
41
|
+
Requires-Dist: nbconvert; extra == 'dev'
|
|
42
|
+
Requires-Dist: numdifftools; extra == 'dev'
|
|
43
|
+
Requires-Dist: optimistix; extra == 'dev'
|
|
44
|
+
Requires-Dist: pint; extra == 'dev'
|
|
45
|
+
Requires-Dist: plotly>=5; extra == 'dev'
|
|
46
|
+
Requires-Dist: pltable; extra == 'dev'
|
|
47
|
+
Requires-Dist: pycddlib-standalone; extra == 'dev'
|
|
48
|
+
Requires-Dist: pypoman; extra == 'dev'
|
|
49
|
+
Requires-Dist: pytensor; extra == 'dev'
|
|
50
|
+
Requires-Dist: pytest-cov; extra == 'dev'
|
|
51
|
+
Requires-Dist: pytest-rerunfailures; extra == 'dev'
|
|
52
|
+
Requires-Dist: pytest-sugar; extra == 'dev'
|
|
53
|
+
Requires-Dist: pytest-xdist; extra == 'dev'
|
|
54
|
+
Requires-Dist: pytest>=9.0.3; extra == 'dev'
|
|
55
|
+
Requires-Dist: python-ternary; extra == 'dev'
|
|
56
|
+
Requires-Dist: ruff; extra == 'dev'
|
|
57
|
+
Requires-Dist: scikit-learn; extra == 'dev'
|
|
58
|
+
Requires-Dist: slsqp-jax; extra == 'dev'
|
|
59
|
+
Requires-Dist: sphinx; extra == 'dev'
|
|
60
|
+
Requires-Dist: sphinx-reredirects; extra == 'dev'
|
|
61
|
+
Requires-Dist: sphinx-rtd-theme; extra == 'dev'
|
|
62
|
+
Requires-Dist: sphinxcontrib-bibtex; extra == 'dev'
|
|
63
|
+
Requires-Dist: sympy; extra == 'dev'
|
|
64
|
+
Requires-Dist: torch; extra == 'dev'
|
|
65
|
+
Requires-Dist: ty; extra == 'dev'
|
|
66
|
+
Provides-Extra: docs
|
|
67
|
+
Requires-Dist: colorama; extra == 'docs'
|
|
68
|
+
Requires-Dist: hypothesis; extra == 'docs'
|
|
69
|
+
Requires-Dist: ipython; extra == 'docs'
|
|
70
|
+
Requires-Dist: matplotlib; extra == 'docs'
|
|
71
|
+
Requires-Dist: nbconvert; extra == 'docs'
|
|
72
|
+
Requires-Dist: numdifftools; extra == 'docs'
|
|
73
|
+
Requires-Dist: pint; extra == 'docs'
|
|
74
|
+
Requires-Dist: pycddlib-standalone; extra == 'docs'
|
|
75
|
+
Requires-Dist: python-ternary; extra == 'docs'
|
|
76
|
+
Requires-Dist: scikit-learn; extra == 'docs'
|
|
77
|
+
Requires-Dist: sphinx; extra == 'docs'
|
|
78
|
+
Requires-Dist: sphinx-reredirects; extra == 'docs'
|
|
79
|
+
Requires-Dist: sphinx-rtd-theme; extra == 'docs'
|
|
80
|
+
Requires-Dist: sphinxcontrib-bibtex; extra == 'docs'
|
|
81
|
+
Requires-Dist: sympy; extra == 'docs'
|
|
82
|
+
Provides-Extra: jax
|
|
83
|
+
Requires-Dist: jax; extra == 'jax'
|
|
84
|
+
Requires-Dist: jaxlib; extra == 'jax'
|
|
85
|
+
Requires-Dist: optimistix; extra == 'jax'
|
|
86
|
+
Requires-Dist: slsqp-jax; extra == 'jax'
|
|
87
|
+
Provides-Extra: music
|
|
88
|
+
Requires-Dist: music21; extra == 'music'
|
|
89
|
+
Provides-Extra: optional
|
|
90
|
+
Requires-Dist: colorama; extra == 'optional'
|
|
91
|
+
Requires-Dist: matplotlib; extra == 'optional'
|
|
92
|
+
Requires-Dist: numdifftools; extra == 'optional'
|
|
93
|
+
Requires-Dist: pint; extra == 'optional'
|
|
94
|
+
Requires-Dist: plotly>=5; extra == 'optional'
|
|
95
|
+
Requires-Dist: pltable; extra == 'optional'
|
|
96
|
+
Requires-Dist: pycddlib-standalone; extra == 'optional'
|
|
97
|
+
Requires-Dist: pypoman; extra == 'optional'
|
|
98
|
+
Requires-Dist: scikit-learn; extra == 'optional'
|
|
99
|
+
Provides-Extra: pytensor
|
|
100
|
+
Requires-Dist: pytensor; extra == 'pytensor'
|
|
101
|
+
Provides-Extra: symbolic
|
|
102
|
+
Requires-Dist: sympy; extra == 'symbolic'
|
|
103
|
+
Provides-Extra: test
|
|
104
|
+
Requires-Dist: hypothesis>=6.0; extra == 'test'
|
|
105
|
+
Requires-Dist: hypothesis[numpy]; extra == 'test'
|
|
106
|
+
Requires-Dist: pytest-cov; extra == 'test'
|
|
107
|
+
Requires-Dist: pytest-rerunfailures; extra == 'test'
|
|
108
|
+
Requires-Dist: pytest-sugar; extra == 'test'
|
|
109
|
+
Requires-Dist: pytest-xdist; extra == 'test'
|
|
110
|
+
Requires-Dist: pytest>=9.0.3; extra == 'test'
|
|
111
|
+
Provides-Extra: torch
|
|
112
|
+
Requires-Dist: torch; extra == 'torch'
|
|
113
|
+
Description-Content-Type: text/x-rst
|
|
114
|
+
|
|
115
|
+
``dit`` is a Python package for discrete information theory.
|
|
116
|
+
|
|
117
|
+
|build| |codecov| |docs| |conda|
|
|
118
|
+
|
|
119
|
+
|joss| |zenodo| |slack|
|
|
120
|
+
|
|
121
|
+
Introduction
|
|
122
|
+
------------
|
|
123
|
+
|
|
124
|
+
.. start-intro
|
|
125
|
+
|
|
126
|
+
Information theory is a powerful extension to probability and statistics, quantifying dependencies
|
|
127
|
+
among arbitrary random variables in a way that is consistent and comparable across systems and
|
|
128
|
+
scales. Information theory was originally developed to quantify how quickly and reliably information
|
|
129
|
+
could be transmitted across an arbitrary channel. The demands of modern, data-driven science have
|
|
130
|
+
been coopting and extending these quantities and methods into unknown, multivariate settings where
|
|
131
|
+
the interpretation and best practices are not known. For example, there are at least four reasonable
|
|
132
|
+
multivariate generalizations of the mutual information, none of which inherit all the
|
|
133
|
+
interpretations of the standard bivariate case. Which is best to use is context-dependent. ``dit``
|
|
134
|
+
implements a vast range of multivariate information measures in an effort to allow information
|
|
135
|
+
practitioners to study how these various measures behave and interact in a variety of contexts. We
|
|
136
|
+
hope that having all these measures and techniques implemented in one place will allow the
|
|
137
|
+
development of robust techniques for the automated quantification of dependencies within a system
|
|
138
|
+
and concrete interpretation of what those dependencies mean.
|
|
139
|
+
|
|
140
|
+
.. end-intro
|
|
141
|
+
|
|
142
|
+
Citing
|
|
143
|
+
------
|
|
144
|
+
|
|
145
|
+
.. start-citing
|
|
146
|
+
|
|
147
|
+
If you use ``dit`` in your research, please cite it as::
|
|
148
|
+
|
|
149
|
+
@article{dit,
|
|
150
|
+
Author = {James, R. G. and Ellison, C. J. and Crutchfield, J. P.},
|
|
151
|
+
Title = {{dit}: a {P}ython package for discrete information theory},
|
|
152
|
+
Journal = {The Journal of Open Source Software},
|
|
153
|
+
Volume = {3},
|
|
154
|
+
Number = {25},
|
|
155
|
+
Pages = {738},
|
|
156
|
+
Year = {2018},
|
|
157
|
+
Doi = {https://doi.org/10.21105/joss.00738}
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
.. end-citing
|
|
161
|
+
|
|
162
|
+
Basic Information
|
|
163
|
+
-----------------
|
|
164
|
+
|
|
165
|
+
.. start-basic-info
|
|
166
|
+
|
|
167
|
+
Documentation
|
|
168
|
+
https://docs.dit.io
|
|
169
|
+
|
|
170
|
+
Downloads
|
|
171
|
+
https://pypi.org/project/dit/ and https://anaconda.org/conda-forge/dit
|
|
172
|
+
|
|
173
|
+
Code and bug tracker
|
|
174
|
+
https://github.com/dit/dit
|
|
175
|
+
|
|
176
|
+
License
|
|
177
|
+
BSD 3-Clause, see ``LICENSE.txt`` for details.
|
|
178
|
+
|
|
179
|
+
Dependencies
|
|
180
|
+
* Python 3.11+
|
|
181
|
+
* `boltons <https://boltons.readthedocs.io>`_
|
|
182
|
+
* `debtcollector <https://docs.openstack.org/debtcollector/>`_
|
|
183
|
+
* `lattices <https://github.com/dit/lattices>`_
|
|
184
|
+
* `loguru <https://loguru.readthedocs.io>`_
|
|
185
|
+
* `networkx <https://networkx.org/>`_
|
|
186
|
+
* `numpy <https://numpy.org/>`_
|
|
187
|
+
* `prettytable <https://github.com/prettytable/prettytable>`_
|
|
188
|
+
* `scipy <https://scipy.org/>`_
|
|
189
|
+
* `xarray <https://docs.xarray.dev/>`_
|
|
190
|
+
|
|
191
|
+
.. end-basic-info
|
|
192
|
+
|
|
193
|
+
Install
|
|
194
|
+
-------
|
|
195
|
+
|
|
196
|
+
.. start-install
|
|
197
|
+
|
|
198
|
+
The easiest way to install is:
|
|
199
|
+
|
|
200
|
+
.. code-block:: bash
|
|
201
|
+
|
|
202
|
+
pip install dit
|
|
203
|
+
|
|
204
|
+
If you want to install ``dit`` within a conda environment, you can simply do:
|
|
205
|
+
|
|
206
|
+
.. code-block:: bash
|
|
207
|
+
|
|
208
|
+
conda install -c conda-forge dit
|
|
209
|
+
|
|
210
|
+
Optional features are grouped into extras:
|
|
211
|
+
|
|
212
|
+
=============== ===========================================================================
|
|
213
|
+
Extra Provides
|
|
214
|
+
=============== ===========================================================================
|
|
215
|
+
``optional`` matplotlib (plots), plotly (interactive plots), colorama (colored PID
|
|
216
|
+
tables), PLTable (double- instead of single-line table borders when
|
|
217
|
+
``dit.ditParams['text.font'] = 'linechar'``), numdifftools (numerical
|
|
218
|
+
gradients/Hessians), pint (units), pycddlib-standalone + pypoman
|
|
219
|
+
(polytope vertex enumeration), scikit-learn (fast nearest-neighbor
|
|
220
|
+
estimators)
|
|
221
|
+
``jax`` JAX optimization backend with autodiff (jax, jaxlib, optimistix, slsqp-jax)
|
|
222
|
+
``torch`` PyTorch optimization backend with autodiff and GPU support
|
|
223
|
+
``pytensor`` PyTensor optimization backend with autodiff
|
|
224
|
+
``symbolic`` sympy-valued (symbolic) distributions
|
|
225
|
+
``broja`` ECOS cone solver for the BROJA partial information decomposition
|
|
226
|
+
``music`` music21, for the empirical Bach / Corelli example distributions
|
|
227
|
+
``test`` pytest, hypothesis, and plugins for running the test suite
|
|
228
|
+
``docs`` Sphinx and friends for building the documentation
|
|
229
|
+
``dev`` everything above, plus ruff and ty
|
|
230
|
+
=============== ===========================================================================
|
|
231
|
+
|
|
232
|
+
For example:
|
|
233
|
+
|
|
234
|
+
.. code-block:: bash
|
|
235
|
+
|
|
236
|
+
pip install "dit[optional,jax]"
|
|
237
|
+
|
|
238
|
+
For development, we recommend `uv <https://docs.astral.sh/uv/>`_:
|
|
239
|
+
|
|
240
|
+
.. code-block:: bash
|
|
241
|
+
|
|
242
|
+
git clone https://github.com/dit/dit.git
|
|
243
|
+
cd dit
|
|
244
|
+
uv sync --extra dev
|
|
245
|
+
|
|
246
|
+
This installs ``dit`` in editable mode with all development dependencies
|
|
247
|
+
(tests, docs, linting, type checking, and optional backends).
|
|
248
|
+
|
|
249
|
+
Testing
|
|
250
|
+
*******
|
|
251
|
+
|
|
252
|
+
.. code-block:: bash
|
|
253
|
+
|
|
254
|
+
# Using uv (recommended)
|
|
255
|
+
uv run pytest
|
|
256
|
+
|
|
257
|
+
# Or with pip
|
|
258
|
+
pip install -e ".[test]"
|
|
259
|
+
pytest
|
|
260
|
+
|
|
261
|
+
By default the test suite skips tests marked ``slow`` and ``very_slow``. To run
|
|
262
|
+
them as well, override the marker selection:
|
|
263
|
+
|
|
264
|
+
.. code-block:: bash
|
|
265
|
+
|
|
266
|
+
uv run pytest -m ""
|
|
267
|
+
|
|
268
|
+
Building the documentation
|
|
269
|
+
**************************
|
|
270
|
+
|
|
271
|
+
.. code-block:: bash
|
|
272
|
+
|
|
273
|
+
uv run sphinx-build -W --keep-going -b html docs docs/_build/html
|
|
274
|
+
|
|
275
|
+
.. end-install
|
|
276
|
+
|
|
277
|
+
Implemented Measures
|
|
278
|
+
--------------------
|
|
279
|
+
|
|
280
|
+
.. start-measures
|
|
281
|
+
|
|
282
|
+
``dit`` implements the following information measures and tools. Most measures are implemented in
|
|
283
|
+
multivariate and conditional generality, where such generalizations either exist in the literature
|
|
284
|
+
or are relatively obvious --- for example, though it is not in the literature, the multivariate
|
|
285
|
+
conditional exact common information is implemented here. Each heading links to the relevant
|
|
286
|
+
section of the `documentation <https://docs.dit.io>`__.
|
|
287
|
+
|
|
288
|
+
`Entropies <https://docs.dit.io/en/latest/measures/measures.html>`__
|
|
289
|
+
Shannon entropy (joint and conditional) · Rényi entropy · Tsallis entropy · residual entropy /
|
|
290
|
+
independent information / variation of information · necessary conditional entropy ·
|
|
291
|
+
cumulative residual entropy (generalized and conditional) · extropy · perplexity · negentropy ·
|
|
292
|
+
disequilibrium and LMPR complexity · α-synergy entropy spectra (synergistic, unique, union,
|
|
293
|
+
intersection, and self-synergy entropies)
|
|
294
|
+
|
|
295
|
+
`Multivariate mutual informations <https://docs.dit.io/en/latest/measures/multivariate/multivariate.html>`__
|
|
296
|
+
mutual information · co-information · interaction information · total correlation /
|
|
297
|
+
multi-information · dual total correlation / binding information (and its generalization) ·
|
|
298
|
+
CAEKL mutual information · O-information · S-information · cohesion · Kirkwood mutual
|
|
299
|
+
information · frustration (order-k and pairwise) · transmission · DeWeese mutual informations ·
|
|
300
|
+
cross mutual informations · union information · Quax synergy · synergistic disclosure (and its
|
|
301
|
+
modified and backbone variants) · logarithmic decomposition · :math:`\Delta^k` / :math:`\Gamma^k` ·
|
|
302
|
+
TSE complexity · α-synergy information spectra
|
|
303
|
+
|
|
304
|
+
`Common informations <https://docs.dit.io/en/latest/measures/common_informations/common_informations.html>`__
|
|
305
|
+
Gács–Körner · stochastic Gács–Körner · Wyner · exact · functional · MSS · Kamath–Anantharam
|
|
306
|
+
(and its directed variant) · β common information · tension common information · channel
|
|
307
|
+
synthesis rate · Salamatian–Cohen–Médard maximum entropy function
|
|
308
|
+
|
|
309
|
+
`Other measures <https://docs.dit.io/en/latest/measures/other/other.html>`__
|
|
310
|
+
lautum information · Sibson mutual information (and its conditional variants) · maximal leakage
|
|
311
|
+
|
|
312
|
+
`Divergences <https://docs.dit.io/en/latest/measures/divergences/divergences.html>`__
|
|
313
|
+
Kullback–Leibler divergence / relative entropy · cross entropy · Jensen–Shannon divergence ·
|
|
314
|
+
variational distance · Hellinger distance and divergence · Bhattacharyya coefficient · Chernoff
|
|
315
|
+
information · Rényi, Tsallis, α-, and f-divergences · earth mover's distance · coupling metrics ·
|
|
316
|
+
copy mutual information · maximum correlation · hypercontractivity coefficient
|
|
317
|
+
|
|
318
|
+
`Secret key agreement <https://docs.dit.io/en/latest/measures/secret_keys.html>`__
|
|
319
|
+
secret key capacity (multiterminal, with omniscience rate) · no-communication, one-way, and
|
|
320
|
+
two-way secret key agreement rates · secrecy capacity · intrinsic, reduced intrinsic, minimal
|
|
321
|
+
intrinsic, two-part intrinsic, relaxed two-part, upper, lower, necessary, interactive, and
|
|
322
|
+
less-noisy intrinsic mutual informations (with total correlation, dual total correlation, and
|
|
323
|
+
CAEKL variants) · iterated discarding · secret key cost / information of formation
|
|
324
|
+
|
|
325
|
+
`Partial information decomposition <https://docs.dit.io/en/latest/decompositions/pid.html>`__
|
|
326
|
+
:math:`I_{min}` · :math:`I_{MMI}` · :math:`I_{\wedge}` · :math:`I_{proj}` · :math:`I_{BROJA}` ·
|
|
327
|
+
:math:`I_{ccs}` · :math:`I_{\pm}` · :math:`I_{sx}` · :math:`I_{dep}` · :math:`I_{RA}` ·
|
|
328
|
+
:math:`I_{RAV}` · :math:`I_{RR}` · :math:`I_{RDR}` · :math:`I_{CT}` · :math:`I_{deg}` ·
|
|
329
|
+
:math:`I_{MC}` · :math:`I_{LN}` · :math:`I_{GH}` · :math:`I_{IG}` · :math:`I_{IPID}` ·
|
|
330
|
+
:math:`I_{\delta}` · :math:`I_{\delta\Lambda}` · :math:`I_{ME}` · :math:`I_{\prec}` ·
|
|
331
|
+
:math:`I_{do}` · :math:`I_{SKAR}` (four variants) · :math:`I_{\cup}^{CI}` (union-information
|
|
332
|
+
synergy) · partial entropy decompositions (:math:`H_{cs}`, :math:`H_{MOS}`, :math:`H_{sx}`) ·
|
|
333
|
+
synergistic disclosure decomposition · integrated information decomposition (ΦID) ·
|
|
334
|
+
generalized information decomposition (GID) · representational complexity
|
|
335
|
+
|
|
336
|
+
`Profiles and visualization <https://docs.dit.io/en/latest/decompositions/profiles.html>`__
|
|
337
|
+
Shannon and extropy partitions (information diagrams) · complexity profile · marginal utility
|
|
338
|
+
of information · connected informations (Schneidman, dual, and m-flat / Amari) · marginal lift
|
|
339
|
+
profile · binding mixture / shared randomness decomposition · dependency decompositions (and
|
|
340
|
+
dual) · Shapley decompositions · entropy triangles · information UpSet plots
|
|
341
|
+
|
|
342
|
+
`Channels and coding <https://docs.dit.io/en/latest/channels/channels.html>`__
|
|
343
|
+
channel capacity (certified, accelerated Blahut–Arimoto) · capacity–cost function · Sibson
|
|
344
|
+
capacity · a catalog of example channels · channel orderings (degraded, less noisy, more
|
|
345
|
+
capable, Blackwell, Shannon inclusion) and Le Cam / KL deficiencies · source codes (Shannon,
|
|
346
|
+
Fano, Shannon–Fano–Elias, Huffman, length-limited Huffman, Golomb/Rice, Tunstall, Elias,
|
|
347
|
+
Fibonacci, unary, polar) · channel codes (repetition, parity-check, Hamming, Reed–Muller,
|
|
348
|
+
Golay, LDPC, polar, convolutional)
|
|
349
|
+
|
|
350
|
+
`Rate-distortion and Gray–Wyner <https://docs.dit.io/en/latest/channels/rate_distortion.html>`__
|
|
351
|
+
rate-distortion curves · information bottleneck (generalized, deterministic, and divergence
|
|
352
|
+
variants) · privacy funnel (and perfect privacy) · Gray–Wyner network, region, and extension
|
|
353
|
+
profile · lossy Wyner common information · Körner graph entropy · maximal and private
|
|
354
|
+
interaction informations · excess functional information
|
|
355
|
+
|
|
356
|
+
`Estimation <https://docs.dit.io/en/latest/estimation/inference.html>`__
|
|
357
|
+
distributions from data and time series · 17 plug-in and bias-corrected entropy estimators
|
|
358
|
+
(Miller–Madow, Grassberger, Chao–Shen, NSB, Zhang, shrinkage, Bayesian, jackknife, …) ·
|
|
359
|
+
alphabet-aware conditional mutual information · k-NN differential entropy and KSG total
|
|
360
|
+
correlation · permutation entropy · entropy rates (block, Lempel–Ziv, Bayesian posterior) ·
|
|
361
|
+
Markov order tests · surrogate data
|
|
362
|
+
|
|
363
|
+
`Optimization and constructions <https://docs.dit.io/en/latest/estimation/optimization.html>`__
|
|
364
|
+
maximum entropy distributions · iterative proportional fitting · m-projections · mixtures of
|
|
365
|
+
products · marginal lifts · convex maximization over polytopes · minimal sufficient statistics
|
|
366
|
+
and information trimming · lattice joins and meets · Kirkwood, Lancaster, and Fejér–Riesz
|
|
367
|
+
approximations · symbolic (sympy) distributions · JAX, PyTorch, and PyTensor backends
|
|
368
|
+
|
|
369
|
+
.. end-measures
|
|
370
|
+
|
|
371
|
+
Quickstart
|
|
372
|
+
----------
|
|
373
|
+
|
|
374
|
+
.. start-quickstart
|
|
375
|
+
|
|
376
|
+
The basic usage of ``dit`` corresponds to creating distributions, modifying them
|
|
377
|
+
if need be, and then computing properties of those distributions. First, we
|
|
378
|
+
import:
|
|
379
|
+
|
|
380
|
+
.. code:: python
|
|
381
|
+
|
|
382
|
+
>>> import dit
|
|
383
|
+
|
|
384
|
+
Suppose we have a really thick coin, one so thick that there is a reasonable
|
|
385
|
+
chance of it landing on its edge. Here is how we might represent the coin in
|
|
386
|
+
``dit``. Each outcome is a tuple with one entry per random variable; unnamed
|
|
387
|
+
variables are called ``X0``, ``X1``, ….
|
|
388
|
+
|
|
389
|
+
.. code:: python
|
|
390
|
+
|
|
391
|
+
>>> d = dit.Distribution(['H', 'T', 'E'], [.4, .4, .2])
|
|
392
|
+
>>> print(d)
|
|
393
|
+
Class: Distribution
|
|
394
|
+
Alphabet: (('E', 'H', 'T'),)
|
|
395
|
+
Base: linear
|
|
396
|
+
<BLANKLINE>
|
|
397
|
+
x p(X0)
|
|
398
|
+
('E',) 0.2
|
|
399
|
+
('H',) 0.4
|
|
400
|
+
('T',) 0.4
|
|
401
|
+
|
|
402
|
+
Calculate the probability of ``H`` and also of the combination ``H or T``.
|
|
403
|
+
|
|
404
|
+
.. code:: python
|
|
405
|
+
|
|
406
|
+
>>> d['H']
|
|
407
|
+
0.4
|
|
408
|
+
>>> d.event_probability(['H', 'T'])
|
|
409
|
+
0.8
|
|
410
|
+
|
|
411
|
+
Calculate the Shannon entropy and extropy of the joint distribution.
|
|
412
|
+
|
|
413
|
+
.. code:: python
|
|
414
|
+
|
|
415
|
+
>>> float(dit.shannon.entropy(d))
|
|
416
|
+
1.5219280948873621
|
|
417
|
+
>>> float(dit.other.extropy(d))
|
|
418
|
+
1.1419011889093373
|
|
419
|
+
|
|
420
|
+
Create a distribution where ``Z = xor(X, Y)``.
|
|
421
|
+
|
|
422
|
+
.. code:: python
|
|
423
|
+
|
|
424
|
+
>>> import dit.example_dists
|
|
425
|
+
>>> d = dit.example_dists.Xor()
|
|
426
|
+
>>> d.set_rv_names(['X', 'Y', 'Z'])
|
|
427
|
+
>>> print(d)
|
|
428
|
+
Class: Distribution
|
|
429
|
+
Alphabet: (('0', '1'), ('0', '1'), ('0', '1'))
|
|
430
|
+
Base: linear
|
|
431
|
+
<BLANKLINE>
|
|
432
|
+
x p(X,Y,Z)
|
|
433
|
+
('0', '0', '0') 0.25
|
|
434
|
+
('0', '1', '1') 0.25
|
|
435
|
+
('1', '0', '1') 0.25
|
|
436
|
+
('1', '1', '0') 0.25
|
|
437
|
+
|
|
438
|
+
Calculate the Shannon mutual informations ``I[X:Z]``, ``I[Y:Z]``, and
|
|
439
|
+
``I[X,Y:Z]``.
|
|
440
|
+
|
|
441
|
+
.. code:: python
|
|
442
|
+
|
|
443
|
+
>>> float(dit.shannon.mutual_information(d, ['X'], ['Z']))
|
|
444
|
+
0.0
|
|
445
|
+
>>> float(dit.shannon.mutual_information(d, ['Y'], ['Z']))
|
|
446
|
+
0.0
|
|
447
|
+
>>> float(dit.shannon.mutual_information(d, ['X', 'Y'], ['Z']))
|
|
448
|
+
1.0
|
|
449
|
+
|
|
450
|
+
Calculate the marginal distribution ``P(X,Z)`` and print its probabilities as
|
|
451
|
+
fractions.
|
|
452
|
+
|
|
453
|
+
.. code:: python
|
|
454
|
+
|
|
455
|
+
>>> d2 = d.marginal(['X', 'Z'])
|
|
456
|
+
>>> print(d2.to_string(exact=True))
|
|
457
|
+
Class: Distribution
|
|
458
|
+
Alphabet: (('0', '1'), ('0', '1'))
|
|
459
|
+
Base: linear
|
|
460
|
+
<BLANKLINE>
|
|
461
|
+
x p(X,Z)
|
|
462
|
+
('0', '0') 1/4
|
|
463
|
+
('0', '1') 1/4
|
|
464
|
+
('1', '0') 1/4
|
|
465
|
+
('1', '1') 1/4
|
|
466
|
+
|
|
467
|
+
Convert the distribution probabilities to log (base 3.5) probabilities, and
|
|
468
|
+
access its probability mass function.
|
|
469
|
+
|
|
470
|
+
.. code:: python
|
|
471
|
+
|
|
472
|
+
>>> d2.set_base(3.5)
|
|
473
|
+
>>> d2.pmf
|
|
474
|
+
array([-1.10658951, -1.10658951, -1.10658951, -1.10658951])
|
|
475
|
+
|
|
476
|
+
Draw 5 random samples from this distribution.
|
|
477
|
+
|
|
478
|
+
.. code:: python
|
|
479
|
+
|
|
480
|
+
>>> dit.math.prng.seed(1)
|
|
481
|
+
>>> d2.rand(5)
|
|
482
|
+
[('0', '1'), ('1', '0'), ('0', '0'), ('0', '1'), ('0', '0')]
|
|
483
|
+
|
|
484
|
+
Source and Channel Coding
|
|
485
|
+
*************************
|
|
486
|
+
|
|
487
|
+
Beyond measures, ``dit`` builds explicit codes and ships a catalog of channels.
|
|
488
|
+
|
|
489
|
+
The ``dit.coding`` module constructs lossless *source codes* (Shannon, Fano,
|
|
490
|
+
Shannon-Fano-Elias, Huffman, length-limited Huffman, Golomb/Rice, Tunstall, and
|
|
491
|
+
the universal integer codes) and reports their code-theoretic properties (rate,
|
|
492
|
+
redundancy, efficiency, the Kraft sum, and whether the code is prefix-free /
|
|
493
|
+
uniquely decodable / optimal).
|
|
494
|
+
|
|
495
|
+
.. code:: python
|
|
496
|
+
|
|
497
|
+
>>> from dit.coding import huffman
|
|
498
|
+
>>> d = dit.Distribution(['a', 'b', 'c', 'd', 'e'], [0.4, 0.2, 0.2, 0.1, 0.1])
|
|
499
|
+
>>> code = huffman(d)
|
|
500
|
+
>>> code.average_length()
|
|
501
|
+
2.2
|
|
502
|
+
>>> float(code.source_entropy())
|
|
503
|
+
2.1219280948873624
|
|
504
|
+
>>> code.is_optimal(), code.is_prefix_free()
|
|
505
|
+
(True, True)
|
|
506
|
+
|
|
507
|
+
It also builds binary (GF(2)) *channel codes* --- linear block codes
|
|
508
|
+
(repetition, parity-check, Hamming, Reed-Muller, Golay) as well as LDPC, polar,
|
|
509
|
+
and convolutional codes --- and evaluates them against a noisy channel supplied
|
|
510
|
+
as a conditional ``Distribution`` ``p(Y|X)``.
|
|
511
|
+
|
|
512
|
+
.. code:: python
|
|
513
|
+
|
|
514
|
+
>>> from dit.coding import hamming
|
|
515
|
+
>>> code = hamming(3)
|
|
516
|
+
>>> code.length, code.dimension, code.minimum_distance()
|
|
517
|
+
(7, 4, 3)
|
|
518
|
+
>>> bsc = dit.example_channels.binary_symmetric_channel(0.05)
|
|
519
|
+
>>> float(code.probability_of_error(bsc, method='exact'))
|
|
520
|
+
0.04438054218749993
|
|
521
|
+
|
|
522
|
+
The ``dit.example_channels`` module is a catalog of canonical discrete
|
|
523
|
+
memoryless channels (binary symmetric, binary erasure, Z-channel, q-ary
|
|
524
|
+
symmetric/erasure, noisy typewriter, ...). Each constructor returns a
|
|
525
|
+
conditional ``Distribution`` ``p(Y|X)`` ready for
|
|
526
|
+
``dit.algorithms.channel_capacity`` or the coding layer above.
|
|
527
|
+
|
|
528
|
+
.. code:: python
|
|
529
|
+
|
|
530
|
+
>>> from dit.algorithms import channel_capacity
|
|
531
|
+
>>> bec = dit.example_channels.binary_erasure_channel(0.25)
|
|
532
|
+
>>> round(float(channel_capacity(bec)[0]), 10)
|
|
533
|
+
0.75
|
|
534
|
+
|
|
535
|
+
.. end-quickstart
|
|
536
|
+
|
|
537
|
+
Contributions & Help
|
|
538
|
+
--------------------
|
|
539
|
+
|
|
540
|
+
If you'd like a feature added to ``dit``, please file an issue. Or, better yet, open a pull request.
|
|
541
|
+
Ideally, all code should be tested and documented, but please don't let this be a barrier to
|
|
542
|
+
contributing. We'll work with you to ensure that all pull requests are in a mergeable state.
|
|
543
|
+
|
|
544
|
+
If you'd like to get in contact about anything, you can reach us through our
|
|
545
|
+
`slack channel <https://dit-python.slack.com/>`_.
|
|
546
|
+
|
|
547
|
+
Thanks
|
|
548
|
+
------
|
|
549
|
+
|
|
550
|
+
Thank you to everyone who has contributed bug reports or pull requests to ``dit``:
|
|
551
|
+
Aaron Griffith, Abhishek Bhatia, @alimasn, André F. C. Gomes, Angus Forbes, Artemy Kolchinsky,
|
|
552
|
+
Benjamin Lee, Bochen Zhao, Casper van Elteren, Charles Kemp, @d-jeon, Daniel Feldspar,
|
|
553
|
+
David A. Ehrlich, Diego Volpatto, Elias Jaffe, Fabio Anza, Freya Behrens, Haochen Wu,
|
|
554
|
+
Harald Schilly, Himanshu Mishra, @ivan-marroquin, Jaewon Chung, James K Johnson, Jan Olszak,
|
|
555
|
+
Jeffrey Emenheiser, Juan Carlos Farah, Keenan Down, @kokokostation, Kunal Marwaha, Lee Junho,
|
|
556
|
+
Longshan Du, @LuisHeinzlmeier, Marc Harper, Nathaniel Chen, @OrdinarySK, Pattarawat Chormai, QZP,
|
|
557
|
+
Rion Brattig Correia, Robin Ince, Rodrigo Silva, Scott Sievert, Tai C. Huang, Talha Anwar,
|
|
558
|
+
Thomas Kluyver, Tobias Mages, Vigneswaran Chandrasekaran, 赵丰 (Zhao Feng), and @zuiyanzuiyan.
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
.. badges:
|
|
562
|
+
|
|
563
|
+
.. |build| image:: https://github.com/dit/dit/actions/workflows/build.yml/badge.svg
|
|
564
|
+
:target: https://github.com/dit/dit/actions/workflows/build.yml
|
|
565
|
+
:alt: Continuous Integration Status
|
|
566
|
+
|
|
567
|
+
.. |codecov| image:: https://codecov.io/gh/dit/dit/branch/main/graph/badge.svg
|
|
568
|
+
:target: https://codecov.io/gh/dit/dit
|
|
569
|
+
:alt: Test Coverage Status
|
|
570
|
+
|
|
571
|
+
.. |docs| image:: https://readthedocs.org/projects/dit/badge/?version=latest
|
|
572
|
+
:target: https://docs.dit.io/en/latest/
|
|
573
|
+
:alt: Documentation Status
|
|
574
|
+
|
|
575
|
+
.. |conda| image:: https://anaconda.org/conda-forge/dit/badges/installer/conda.svg
|
|
576
|
+
:target: https://anaconda.org/conda-forge/dit
|
|
577
|
+
:alt: Conda installation
|
|
578
|
+
|
|
579
|
+
.. |zenodo| image:: https://zenodo.org/badge/13201610.svg
|
|
580
|
+
:target: https://zenodo.org/badge/latestdoi/13201610
|
|
581
|
+
:alt: DOI
|
|
582
|
+
|
|
583
|
+
.. |slack| image:: https://img.shields.io/badge/Slack-dit--python-lightgrey.svg
|
|
584
|
+
:target: https://dit-python.slack.com/
|
|
585
|
+
:alt: dit chat
|
|
586
|
+
|
|
587
|
+
.. |joss| image:: http://joss.theoj.org/papers/10.21105/joss.00738/status.svg
|
|
588
|
+
:target: https://doi.org/10.21105/joss.00738
|
|
589
|
+
:alt: JOSS Status
|