API Reference
=============

These pages are generated from the live ``infotheory_rs`` binding that the Python package exposes.

.. automodule:: infotheory_rs
   :no-members:

Functions
---------

.. autofunction:: infotheory_rs.biased_entropy_rate_backend

.. autofunction:: infotheory_rs.biased_entropy_rate_bytes

.. autofunction:: infotheory_rs.compress_bytes_backend

.. autofunction:: infotheory_rs.compress_file

.. autofunction:: infotheory_rs.compress_size_backend

.. autofunction:: infotheory_rs.compress_size_chain_backend

.. autofunction:: infotheory_rs.conditional_entropy_bytes

.. autofunction:: infotheory_rs.conditional_entropy_paths

.. autofunction:: infotheory_rs.conditional_entropy_rate_bytes

.. autofunction:: infotheory_rs.cross_entropy_bytes

.. autofunction:: infotheory_rs.cross_entropy_paths

.. autofunction:: infotheory_rs.cross_entropy_rate_backend

.. autofunction:: infotheory_rs.cross_entropy_rate_bytes

.. autofunction:: infotheory_rs.d_kl_bytes

.. autofunction:: infotheory_rs.decode_bits

.. autofunction:: infotheory_rs.decode_reward_bits

.. autofunction:: infotheory_rs.decode_reward_offset_bits

.. autofunction:: infotheory_rs.decompress_bytes_backend

.. autofunction:: infotheory_rs.decompress_file

.. autofunction:: infotheory_rs.encode_bits

.. autofunction:: infotheory_rs.encode_reward_bits

.. autofunction:: infotheory_rs.encode_reward_offset_bits

.. autofunction:: infotheory_rs.entropy_rate_backend

.. autofunction:: infotheory_rs.entropy_rate_bytes

.. autofunction:: infotheory_rs.environment_probe

.. autofunction:: infotheory_rs.generate_bytes

.. autofunction:: infotheory_rs.generate_bytes_conditional_chain

.. autofunction:: infotheory_rs.get_bytes_from_paths

.. autofunction:: infotheory_rs.get_compressed_size

.. autofunction:: infotheory_rs.get_compressed_size_parallel

.. autofunction:: infotheory_rs.get_compressed_sizes_from_paths

.. autofunction:: infotheory_rs.get_default_ctx

.. autofunction:: infotheory_rs.get_parallel_compressed_sizes_from_parallel_paths

.. autofunction:: infotheory_rs.get_parallel_compressed_sizes_from_sequential_paths

.. autofunction:: infotheory_rs.get_sequential_compressed_sizes_from_parallel_paths

.. autofunction:: infotheory_rs.get_sequential_compressed_sizes_from_sequential_paths

.. autofunction:: infotheory_rs.intrinsic_dependence_bytes

.. autofunction:: infotheory_rs.joint_entropy_rate_backend

.. autofunction:: infotheory_rs.joint_entropy_rate_bytes

.. autofunction:: infotheory_rs.joint_marginal_entropy_bytes

.. autofunction:: infotheory_rs.js_div_bytes

.. autofunction:: infotheory_rs.js_divergence_paths

.. autofunction:: infotheory_rs.kl_divergence_paths

.. autofunction:: infotheory_rs.marginal_entropy_bytes

.. autofunction:: infotheory_rs.mutual_information_bytes

.. autofunction:: infotheory_rs.mutual_information_marg_bytes

.. autofunction:: infotheory_rs.mutual_information_paths

.. autofunction:: infotheory_rs.mutual_information_rate_backend

.. autofunction:: infotheory_rs.mutual_information_rate_bytes

.. autofunction:: infotheory_rs.ncd_bytes

.. autofunction:: infotheory_rs.ncd_bytes_default

.. autofunction:: infotheory_rs.ncd_bytes_with_backend

.. autofunction:: infotheory_rs.ncd_cons

.. autofunction:: infotheory_rs.ncd_matrix_bytes

.. autofunction:: infotheory_rs.ncd_matrix_bytes_with_backend

.. autofunction:: infotheory_rs.ncd_matrix_paths

.. autofunction:: infotheory_rs.ncd_matrix_paths_with_backend

.. autofunction:: infotheory_rs.ncd_paths

.. autofunction:: infotheory_rs.ncd_paths_with_backend

.. autofunction:: infotheory_rs.ncd_sym_cons

.. autofunction:: infotheory_rs.ncd_sym_vitanyi

.. autofunction:: infotheory_rs.ncd_vitanyi

.. autofunction:: infotheory_rs.ned_bytes

.. autofunction:: infotheory_rs.ned_cons_bytes

.. autofunction:: infotheory_rs.ned_cons_marg_bytes

.. autofunction:: infotheory_rs.ned_cons_rate_bytes

.. autofunction:: infotheory_rs.ned_marg_bytes

.. autofunction:: infotheory_rs.ned_paths

.. autofunction:: infotheory_rs.ned_rate_backend

.. autofunction:: infotheory_rs.ned_rate_bytes

.. autofunction:: infotheory_rs.nhd_bytes

.. autofunction:: infotheory_rs.nhd_paths

.. autofunction:: infotheory_rs.nte_bytes

.. autofunction:: infotheory_rs.nte_marg_bytes

.. autofunction:: infotheory_rs.nte_paths

.. autofunction:: infotheory_rs.nte_rate_backend

.. autofunction:: infotheory_rs.nte_rate_bytes

.. autofunction:: infotheory_rs.observation_key_from_stream

.. autofunction:: infotheory_rs.observation_repr_from_stream

.. autofunction:: infotheory_rs.predictor_probe

.. autofunction:: infotheory_rs.rate_backend

.. autofunction:: infotheory_rs.resistance_to_transformation_bytes

.. autofunction:: infotheory_rs.run_agent_with_environment

.. autofunction:: infotheory_rs.run_aiqi_with_environment

.. autofunction:: infotheory_rs.search

.. autofunction:: infotheory_rs.search_with_simulator

.. autofunction:: infotheory_rs.set_default_ctx

.. autofunction:: infotheory_rs.tvd_bytes

.. autofunction:: infotheory_rs.tvd_paths

.. autofunction:: infotheory_rs.validate_zpaq_rate_method

.. autofunction:: infotheory_rs.verify_chain_rule

.. autofunction:: infotheory_rs.verify_conditioning_reduces_entropy

.. autofunction:: infotheory_rs.verify_entropy_bounds

.. autofunction:: infotheory_rs.verify_identity

.. autofunction:: infotheory_rs.verify_mi_nonnegative

.. autofunction:: infotheory_rs.verify_ncd_bounds

.. autofunction:: infotheory_rs.verify_non_negativity

.. autofunction:: infotheory_rs.verify_subadditivity

.. autofunction:: infotheory_rs.verify_symmetry

.. autofunction:: infotheory_rs.verify_triangle_inequality

.. autofunction:: infotheory_rs.vm_enabled

Classes and Enums
-----------------

.. autoclass:: infotheory_rs.Agent
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.AgentConfig
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.AgentSimulatorABC
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.AiqiAgent
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.AiqiConfig
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.BiasedRockPaperScissorEnv
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.CalibrationContextKind
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.CoinFlipEnv
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.CompressionBackend
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.CtwPredictor
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.CtwTestEnv
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.EnvironmentABC
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.ExtendedTigerEnv
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.FacCtwPredictor
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.GenerationConfig
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.GenerationStrategy
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.GenerationUpdateMode
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.InfotheoryCtx
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.KuhnPokerEnv
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.MixtureExpertSpec
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.MixtureKind
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.MixtureSpec
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.NcdVariant
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.ObservationKeyMode
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.ParticleSpec
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.PredictorABC
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.RandomGenerator
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.RateBackend
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.RateBackendSession
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.RosaPredictor
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.RwkvPredictor
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.SearchGranularity
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.SearchNode
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.SearchTree
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.Stage2PriorMode
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.TicTacToeEnv
   :members:
   :undoc-members:

.. autoclass:: infotheory_rs.ZpaqPredictor
   :members:
   :undoc-members: