egglog Python

egglog is a Python package that provides bindings to the Rust library of the same name, allowing you to use e-graphs in Python for optimization, symbolic computation, and analysis.

pip install egglog

Status of this project

This package is in development and is not ready for production use. egglog itself is also subject to changes and is less stable than egg. If you are looking for a more stable e-graphs library in Python, you can try snake-egg, which wraps egg.

egglog is a rewrite of the egg library to use relational e-matching and to add datalog features. See the “Better Together: Unifying Datalog and Equality Saturation” paper for more details

We present egglog, a fixpoint reasoning system that unifies Datalog and equality saturation (EqSat). Like Datalog, it supports efficient incremental execution, cooperating analyses, and lattice-based reasoning. Like EqSat, it supports term rewriting, efficient congruence closure, and extraction of optimized terms.

How documentation is organized

We use the Diátaxis framework to organize our documentation. This helps with figuring out where different content should live and how it should be organized.

• Examples Gallery
• Tutorials
  • Getting Started - Matrix Multiplication
    • Install egglog Python
    • Creating an E-Graph
    • Defining Dimensions
      • Testing in a notebook
    • Dimension Replacements
      • Testing
    • Matrix Expressions
      • Rows/cols Replacements
      • Operation replacements
• How-to guides
  • Parsing and running program strings
  • Developing this package
• Explanation
  • Compared to Rust implementation
    • Low Level API
    • High level API
      • Mapping of low level to high level
  • How does egglog handle boolean values?
    • != operator
  • Define function vs define action.
• Reference
  • Changelog
    • Unreleased
    • 0.4.0 (2023-05-03)
    • 0.3.1 (2023-05-02)
    • 0.3.0 (2023-04-26)
    • 0.2.0 (2023-03-27)
  • egglog
  • egglog.bindings
    • ActionCommand
      • ActionCommand.action
    • AddRuleset
      • AddRuleset.name
    • BiRewriteCommand
      • BiRewriteCommand.name
      • BiRewriteCommand.rewrite
    • Calc
      • Calc.exprs
      • Calc.identifiers
    • Call
      • Call.args
      • Call.name
    • Check
      • Check.facts
    • Datatype
      • Datatype.name
      • Datatype.variants
    • Declare
      • Declare.name
      • Declare.sort
    • Define
      • Define.cost
      • Define.expr
      • Define.name
    • Delete
      • Delete.args
      • Delete.sym
    • EGraph
      • EGraph.extract_report()
      • EGraph.parse_program()
      • EGraph.run_program()
      • EGraph.run_report()
    • EggSmolError
      • EggSmolError.context
    • Eq
      • Eq.exprs
    • Expr_
      • Expr_.expr
    • Extract
      • Extract.expr
      • Extract.variants
    • ExtractReport
      • ExtractReport.cost
      • ExtractReport.expr
      • ExtractReport.variants
    • F64
      • F64.value
    • Fact
      • Fact.expr
    • Fail
      • Fail.command
    • Function
      • Function.decl
    • FunctionDecl
      • FunctionDecl.cost
      • FunctionDecl.default
      • FunctionDecl.merge
      • FunctionDecl.merge_action
      • FunctionDecl.name
      • FunctionDecl.schema
    • IdentSort
      • IdentSort.ident
      • IdentSort.sort
    • Include
      • Include.path
    • Input
      • Input.file
      • Input.name
    • Int
      • Int.value
    • Let
      • Let.lhs
      • Let.rhs
    • Lit
      • Lit.value
    • Output
      • Output.exprs
      • Output.file
    • Panic
      • Panic.msg
    • Pop
      • Pop.length
    • Print
      • Print.length
      • Print.name
    • PrintSize
      • PrintSize.name
    • Push
      • Push.length
    • Repeat
      • Repeat.length
      • Repeat.schedule
    • Rewrite
      • Rewrite.conditions
      • Rewrite.lhs
      • Rewrite.rhs
    • RewriteCommand
      • RewriteCommand.name
      • RewriteCommand.rewrite
    • Rule
      • Rule.body
      • Rule.head
    • RuleCommand
      • RuleCommand.name
      • RuleCommand.rule
      • RuleCommand.ruleset
    • Run
      • Run.config
    • RunCommand
      • RunCommand.config
    • RunConfig
      • RunConfig.limit
      • RunConfig.ruleset
      • RunConfig.until
    • RunReport
      • RunReport.apply_time
      • RunReport.rebuild_time
      • RunReport.search_time
      • RunReport.updated
    • RunScheduleCommand
      • RunScheduleCommand.schedule
    • Saturate
      • Saturate.schedule
    • Schema
      • Schema.input
      • Schema.output
    • Sequence
      • Sequence.schedules
    • Set
      • Set.args
      • Set.lhs
      • Set.rhs
    • SetOption
      • SetOption.name
      • SetOption.value
    • Simplify
      • Simplify.config
      • Simplify.expr
    • Sort
      • Sort.name
      • Sort.presort_and_args
    • String
      • String.value
    • Union
      • Union.lhs
      • Union.rhs
    • Unit
    • Var
      • Var.name
    • Variant
      • Variant.cost
      • Variant.name
      • Variant.types