Merge pull request #291 from egraphs-good/new-backend

Switch to new backend

Author: saulshanabrook

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "egglog_python"
 version = "10.0.2"
-edition = "2021"
+edition = "2024"
 
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@@ -12,8 +12,12 @@ crate-type = ["cdylib"]
 [dependencies]
 pyo3 = { version = "0.23.0", features = ["extension-module"] }
 
-egglog = { git = "https://github.com/egraphs-good/egglog", rev = "6f494282442803201b512e9d0828007b52a0b29c" }
-egglog-experimental = { git = "https://github.com/egraphs-good/egglog-experimental", rev = "8a1b3d6ad2723a8438f51f05027161e51f37917c" }
+# include this bugfix https://github.com/egraphs-good/egglog/pull/629
+egglog = { git = "https://github.com/saulshanabrook/egg-smol.git", rev = "1e638e6" }
+# egglog = { path = "../egg-smol" }
+egglog-bridge = { git = "https://github.com/egraphs-good/egglog-backend.git", rev = "1a1f913" }
+core-relations = { git = "https://github.com/egraphs-good/egglog-backend.git", rev = "1a1f913" }
+egglog-experimental = { git = "https://github.com/egraphs-good/egglog-experimental", rev = "202078f" }
 egraph-serialize = { version = "0.2.0", features = ["serde", "graphviz"] }
 serde_json = "1.0.140"
 pyo3-log = "0.12.3"
@@ -22,13 +26,11 @@ lalrpop-util = { version = "0.22", features = ["lexer"] }
 ordered-float = "3.7.0"
 uuid = { version = "1.16.0", features = ["v4"] }
 
-# Use unreleased version of egglog in experimental
+# Use patched version of egglog in experimental
 [patch.'https://github.com/egraphs-good/egglog']
-# https://github.com/rust-lang/cargo/issues/5478#issuecomment-522719793
-egglog = { git = "https://github.com/egraphs-good//egglog.git", rev = "6f494282442803201b512e9d0828007b52a0b29c" }
-
-# [replace]
-# 'https://github.com/egraphs-good/egglog.git#[email protected]' = { git = "https://github.com/egraphs-good/egglog.git", rev = "215714e1cbb13ae9e21bed2f2e1bf95804571512" }
+# egglog = { git = "https://github.com/egraphs-good//egglog.git", rev = "d2fa5b733de0796fb187dc5a27e570d5644aa75a" }
+# egglog = { path = "../egg-smol" }
+egglog = { git = "https://github.com/saulshanabrook/egg-smol.git", rev = "1e638e6" }
 
 # enable debug symbols for easier profiling
 [profile.release]

Cargo.toml

@@ -4,6 +4,12 @@ _This project uses semantic versioning_
 
 ## UNRELEASED
 
+- Upgrade egglog which includes new backend.
+  - Fixes implementation of the Python Object sort to work with objects with dupliating hashes but the same value.
+    Also changes the representation to be an index into a list instead of the ID, making egglog programs more deterministic.
+  - Prefix constant declerations and unbound variables to not shadow let variables
+  - BREAKING: Remove `simplify` since it was removed upstream. You can manually replace it with an insert, run, then extract.
+
 ## 10.0.2 (2025-06-22)
 
 - Fix using `f64Like` when not importing star (also properly includes removal of `Callable` special case from previous release).
@@ -76,7 +82,7 @@ Extracting: (+ %x 2)
 ...     print((x + 2).eval())
 ...
 3
-````
+```
 
 There is a tradeoff here for more ease of use at the expense of some added implicit behavior using global state.
 
@@ -506,3 +512,4 @@ We also change the `PyObject` primitive to behave similarly. Instead of calling
 This release adds support for a high level API for e-graphs.
 
 There is an examples of the high level API in the [tutorials](tutorials/getting-started).
+````

docs/changelog.md

@@ -72,7 +72,12 @@ Finally, to build the docs locally and test that they work, you can run:
 make docs
 ```
 
-## Making changes
+## Debugging
+
+To debug the Rust parts of this project, follow the [PyO3 debugging guide](https://pyo3.rs/main/debugging.html#debugger-specific-setup).
+Debug symbols are turned on by default.
+
+### Making changes
 
 All changes that impact users should be documented in the `docs/changelog.md` file. Please also add tests for any new features
 or bug fixes.

docs/reference/contributing.md

@@ -29,8 +29,8 @@ i64(10) + i64(2)
 ```
 
 ```{code-cell} python
-# egg: (+ (rational 1 2)  (rational 2 1))
-Rational(i64(1), i64(2)) / Rational(i64(2), i64(1))
+# egg: (+ (bigrat (bigint 1)  (bigint 2))  (big-rat (bigint 2)  (bigint 1)))
+BigRat(1, 2) / BigRat(2, 1)
 ```
 
 These types are also all checked statically with MyPy, so for example, if you try to add a `String` and a `i64`, you will get a type error.
@@ -44,7 +44,7 @@ i64(10) + 2
 ```
 
 ```{code-cell} python
-Rational(1, 2) / Rational(2, 1)
+BigRat(1, 2) / BigRat(2, 1)
 ```
 
 ### `!=` Operator
@@ -497,15 +497,6 @@ egraph.run(10)
 egraph
 ```
 
-### Simplify
-
-The `(simplify ...)` command in egglog translates to the `egraph.simplify` method, which combines running a schedule and extracting:
-
-```{code-cell} python
-# egg: (simplify (Mul (Num 6) (Add (Num 2) (Mul (Var "x") (Num 2)))) 20)
-egraph.simplify(Math(6) * (Math(2) + Math.var("x") * Math(2)), 20)
-```
-
 ## Push/Pop
 
 The `(push)` and `(pop)` commands in egglog can be translated to the context manager on the `egraph` object:

docs/reference/egglog-translation.md

@@ -43,7 +43,6 @@ __all__ = [
     "PrintSize",
     "Push",
     "PyObjectSort",
-    "QueryExtract",
     "Relation",
     "Repeat",
     "Rewrite",
@@ -61,7 +60,6 @@ __all__ = [
     "SerializedEGraph",
     "Set",
     "SetOption",
-    "Simplify",
     "Sort",
     "SrcFile",
     "String",
@@ -74,6 +72,7 @@ __all__ = [
     "Union",
     "Unit",
     "UnstableCombinedRuleset",
+    "UserDefined",
     "Var",
     "Variant",
     "Variants",
@@ -309,14 +308,7 @@ class Expr_:  # noqa: N801
     span: _Span
     expr: _Expr
 
-@final
-class Extract:
-    def __init__(self, span: _Span, expr: _Expr, variants: _Expr) -> None: ...
-    span: _Span
-    expr: _Expr
-    variants: _Expr
-
-_Action: TypeAlias = Let | Set | Change | Union | Panic | Expr_ | Extract
+_Action: TypeAlias = Let | Set | Change | Union | Panic | Expr_
 
 ##
 # Other Structs
@@ -367,22 +359,20 @@ class IdentSort:
 @final
 class RunReport:
     updated: bool
-    search_time_per_rule: dict[str, timedelta]
-    apply_time_per_rule: dict[str, timedelta]
-    search_time_per_ruleset: dict[str, timedelta]
-    apply_time_per_ruleset: dict[str, timedelta]
-    rebuild_time_per_ruleset: dict[str, timedelta]
+    search_and_apply_time_per_rule: dict[str, timedelta]
     num_matches_per_rule: dict[str, int]
+    search_and_apply_time_per_ruleset: dict[str, timedelta]
+    merge_time_per_ruleset: dict[str, timedelta]
+    rebuild_time_per_ruleset: dict[str, timedelta]
 
     def __init__(
         self,
         updated: bool,
-        search_time_per_rule: dict[str, timedelta],
-        apply_time_per_rule: dict[str, timedelta],
-        search_time_per_ruleset: dict[str, timedelta],
-        apply_time_per_ruleset: dict[str, timedelta],
-        rebuild_time_per_ruleset: dict[str, timedelta],
+        search_and_apply_time_per_rule: dict[str, timedelta],
         num_matches_per_rule: dict[str, int],
+        search_and_apply_time_per_ruleset: dict[str, timedelta],
+        merge_time_per_ruleset: dict[str, timedelta],
+        rebuild_time_per_ruleset: dict[str, timedelta],
     ) -> None: ...
 
 @final
@@ -488,8 +478,9 @@ class Function:
 
 @final
 class AddRuleset:
+    span: _Span
     name: str
-    def __init__(self, name: str) -> None: ...
+    def __init__(self, span: _Span, name: str) -> None: ...
 
 @final
 class RuleCommand:
@@ -524,18 +515,11 @@ class RunSchedule:
     def __init__(self, schedule: _Schedule) -> None: ...
 
 @final
-class Simplify:
-    span: _Span
-    expr: _Expr
-    schedule: _Schedule
-    def __init__(self, span: _Span, expr: _Expr, schedule: _Schedule) -> None: ...
-
-@final
-class QueryExtract:
+class Extract:
     span: _Span
-    variants: int
     expr: _Expr
-    def __init__(self, span: _Span, variants: int, expr: _Expr) -> None: ...
+    variants: _Expr
+    def __init__(self, span: _Span, expr: _Expr, variants: _Expr) -> None: ...
 
 @final
 class Check:
@@ -614,11 +598,19 @@ class Constructor:
 class PrintOverallStatistics:
     def __init__(self) -> None: ...
 
+@final
+class UserDefined:
+    span: _Span
+    name: str
+    args: list[_Expr]
+    def __init__(self, span: _Span, name: str, args: list[_Expr]) -> None: ...
+
 @final
 class UnstableCombinedRuleset:
+    span: _Span
     name: str
     rulesets: list[str]
-    def __init__(self, name: str, rulesets: list[str]) -> None: ...
+    def __init__(self, span: _Span, name: str, rulesets: list[str]) -> None: ...
 
 _Command: TypeAlias = (
     SetOption
@@ -632,8 +624,7 @@ _Command: TypeAlias = (
     | BiRewriteCommand
     | ActionCommand
     | RunSchedule
-    | Simplify
-    | QueryExtract
+    | Extract
     | Check
     | PrintFunction
     | PrintSize
@@ -647,6 +638,7 @@ _Command: TypeAlias = (
     | PrintOverallStatistics
     | UnstableCombinedRuleset
     | Constructor
+    | UserDefined
 )
 
 ##

python/egglog/bindings.pyi

@@ -51,6 +51,7 @@
     "InitRef",
     "JustTypeRef",
     "LetDecl",
+    "LetRefDecl",
     "LitDecl",
     "LitType",
     "MethodRef",
@@ -73,9 +74,9 @@
     "TypeOrVarRef",
     "TypeRefWithVars",
     "TypedExprDecl",
+    "UnboundVarDecl",
     "UnionDecl",
     "UnnamedFunctionRef",
-    "VarDecl",
     "replace_typed_expr",
     "upcast_declerations",
 ]
@@ -361,7 +362,7 @@ def signature(self) -> FunctionSignature:
         arg_names = []
         for a in self.args:
             arg_types.append(a.tp.to_var())
-            assert isinstance(a.expr, VarDecl)
+            assert isinstance(a.expr, UnboundVarDecl)
             arg_names.append(a.expr.name)
         return FunctionSignature(
             arg_types=tuple(arg_types),
@@ -514,10 +515,14 @@ class ConstructorDecl:
 
 
 @dataclass(frozen=True)
-class VarDecl:
+class UnboundVarDecl:
+    name: str
+    egg_name: str | None = None
+
+
+@dataclass(frozen=True)
+class LetRefDecl:
     name: str
-    # Differentiate between let bound vars and vars created in rules so that they won't shadow in egglog, by adding a prefix
-    is_let: bool
 
 
 @dataclass(frozen=True)
@@ -628,7 +633,7 @@ class PartialCallDecl:
     call: CallDecl
 
 
-ExprDecl: TypeAlias = VarDecl | LitDecl | CallDecl | PyObjectDecl | PartialCallDecl
+ExprDecl: TypeAlias = UnboundVarDecl | LetRefDecl | LitDecl | CallDecl | PyObjectDecl | PartialCallDecl
 
 
 @dataclass(frozen=True)