Skip to main content

Epsilon Machine Inference & Characterization - A framework for computational mechanics

Project description

emic

CI Docs Coverage License: MIT Python 3.11+

Epsilon Machine Inference & Characterization

A Python framework for constructing and analyzing epsilon-machines based on computational mechanics.

📚 Documentation | 🚀 Getting Started

What is an Epsilon-Machine?

An epsilon-machine (ε-machine) is the minimal, optimal predictor of a stochastic process. Introduced by James Crutchfield and collaborators, ε-machines capture the intrinsic computational structure hidden in sequential data.

Key concepts:

  • Causal states: Equivalence classes of histories that yield identical predictions
  • Statistical complexity (Cμ): The entropy of the causal state distribution — a measure of structural complexity
  • Entropy rate (hμ): The irreducible randomness in the process

ε-machines reveal the emic structure of a process — the computational organization that exists within the system itself, not imposed from outside.

Features

  • 🔮 Inference: Reconstruct ε-machines using multiple algorithms (CSSR, CSM, BSI, Spectral, NSD)
  • 📊 Analysis: Compute complexity measures (Cμ, hμ, excess entropy, crypticity)
  • 🎲 Sources: Built-in stochastic process generators (Golden Mean, Even Process, Biased Coin, Periodic)
  • 🔗 Pipeline: Composable >> operator for source → inference → analysis workflows
  • 📈 Visualization: State diagram rendering with Graphviz
  • 📝 Export: LaTeX tables, TikZ diagrams, DOT, Mermaid, and JSON formats
  • 🧩 Extensible: Protocol-based architecture for custom algorithms and sources

Installation

pip install emic

Or install from source with uv:

git clone https://github.com/johnazariah/emic.git
cd emic
uv sync --dev

Quick Start

from emic.sources import GoldenMeanSource, TakeN
from emic.inference import CSSR, CSSRConfig
from emic.analysis import analyze

# Generate data from the Golden Mean process (no consecutive 1s)
source = GoldenMeanSource(p=0.5, _seed=42)
data = TakeN(10_000)(source)

# Infer the epsilon-machine using CSSR
config = CSSRConfig(max_history=5, significance=0.001)
result = CSSR(config).infer(data)

# Analyze the inferred machine
summary = analyze(result.machine)
print(f"States: {len(result.machine.states)}")
print(f"Statistical Complexity: Cμ = {summary.statistical_complexity:.4f}")
print(f"Entropy Rate: hμ = {summary.entropy_rate:.4f}")

Pipeline Composition

Chain operations using the >> operator:

from emic.sources import GoldenMeanSource, TakeN
from emic.inference import CSSR, CSSRConfig
from emic.analysis import analyze

# Compose source and transforms
source = GoldenMeanSource(p=0.5, _seed=42)
data = source >> TakeN(10_000)

# Infer and analyze
config = CSSRConfig(max_history=5, significance=0.001)
result = CSSR(config).infer(data)
summary = analyze(result.machine)

print(summary)

Built-in Sources

Process Description True States
Golden Mean No consecutive 1s allowed 2
Even Process Even number of 1s between 0s 2
Biased Coin i.i.d. Bernoulli process 1
Periodic Deterministic repeating pattern n (period length)

Project Status

Core implementation complete — The framework is functional with:

  • Multiple inference algorithms: CSSR, CSM, BSI, Spectral, NSD
  • Full analysis suite (Cμ, hμ, excess entropy, crypticity)
  • Synthetic and empirical data sources
  • Pipeline composition
  • 194 tests with 90% coverage

📚 Full documentation available

Etymology

The name emic works on multiple levels:

  1. Acronym: Epsilon Machine Inference & Characterization
  2. Linguistic: In linguistics/anthropology, emic refers to analysis from within the system — understanding structure on its own terms. This resonates with computational mechanics: ε-machines reveal the intrinsic structure of a process.
  3. Phonetic: Pronounced "EE-mik" or "EH-mic" — a nod to "ε-machine"

References

Contributing

Contributions are welcome! See the Contributing Guide for details.

License

MIT License — see LICENSE for details.

Author

John Azariah (@johnazariah)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

emic-0.3.1.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

emic-0.3.1-py3-none-any.whl (80.0 kB view details)

Uploaded Python 3

File details

Details for the file emic-0.3.1.tar.gz.

File metadata

  • Download URL: emic-0.3.1.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for emic-0.3.1.tar.gz
Algorithm Hash digest
SHA256 924c756d0fa7a7ac22ae824ae882df43fb8e646ea5e64351e3725f3a54f51222
MD5 5f038550e5078bb07545cdefaad3eb9d
BLAKE2b-256 5acb5ed81e5265f0a13a052dc7bc6a667d84186e203d6af96d74d0291fbf1b7a

See more details on using hashes here.

Provenance

The following attestation bundles were made for emic-0.3.1.tar.gz:

Publisher: release.yml on johnazariah/emic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file emic-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: emic-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 80.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for emic-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 69b1853919d7a8e7259fda368978399e37664eee6c382f5df7df841783607ce0
MD5 765664a4a987f729c98c8ab782d71090
BLAKE2b-256 b505212db7606046cfd3eeadb603eeac98f7a1f30a00982f788adb876ddb68d3

See more details on using hashes here.

Provenance

The following attestation bundles were made for emic-0.3.1-py3-none-any.whl:

Publisher: release.yml on johnazariah/emic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page