egglog 11.3.0__tar.gz → 11.4.0__tar.gz

{egglog-11.3.0 → egglog-11.4.0}/.github/workflows/CI.yml

@@ -68,11 +68,12 @@ jobs:
       - run: |
           export UV_PROJECT_ENVIRONMENT="${pythonLocation}"
           uv sync --extra test --locked
-      - uses: CodSpeedHQ/action@v3.8.1
+      - uses: CodSpeedHQ/action@v4.0.1
         with:
           token: ${{ secrets.CODSPEED_TOKEN }}
           # allow updating snapshots due to indeterministic benchmarks
           run: pytest -vvv --snapshot-update --durations=10
+          mode: "instrumentation"
 
   docs:
     runs-on: ubuntu-latest

{egglog-11.3.0 → egglog-11.4.0}/Cargo.lock

@@ -19,9 +19,9 @@ checksum = "683d7910e743518b0e34f1186f92494becacb047c7b6bf616c96772180fef923"
 
 [[package]]
 name = "anyhow"
-version = "1.0.99"
+version = "1.0.100"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b0674a1ddeecb70197781e945de4b3b8ffb61fa939a5597bcf48503737663100"
+checksum = "a23eb6b1614318a8071c9b2521f36b424b2c83db5eb3a0fead4a6c0809af6e61"
 
 [[package]]
 name = "arc-swap"
@@ -215,14 +215,14 @@ checksum = "d0881ea181b1df73ff77ffaaf9c7544ecc11e82fba9b5f27b262a3c73a332555"
 [[package]]
 name = "egglog"
 version = "1.0.0"
-source = "git+https://github.com/egraphs-good//egglog.git?branch=main#1f0b6ecfc2eda306945a6869ddea838e9c309ec6"
+source = "git+https://github.com/saulshanabrook/egg-smol.git?branch=clone-cost#2b6de8034d8fd7af0dc8143f0a8ade5734c34f8c"
 dependencies = [
  "csv",
  "dyn-clone",
  "egglog-add-primitive",
- "egglog-bridge 1.0.0 (git+https://github.com/egraphs-good//egglog.git?branch=main)",
- "egglog-core-relations 1.0.0 (git+https://github.com/egraphs-good//egglog.git?branch=main)",
- "egglog-numeric-id 1.0.0 (git+https://github.com/egraphs-good//egglog.git?branch=main)",
+ "egglog-bridge",
+ "egglog-core-relations",
+ "egglog-numeric-id",
  "egraph-serialize",
  "hashbrown 0.15.5",
  "im-rc",
@@ -240,7 +240,7 @@ dependencies = [
 [[package]]
 name = "egglog-add-primitive"
 version = "1.0.0"
-source = "git+https://github.com/egraphs-good//egglog.git?branch=main#1f0b6ecfc2eda306945a6869ddea838e9c309ec6"
+source = "git+https://github.com/saulshanabrook/egg-smol.git?branch=clone-cost#2b6de8034d8fd7af0dc8143f0a8ade5734c34f8c"
 dependencies = [
  "quote",
  "syn 2.0.106",
@@ -249,35 +249,13 @@ dependencies = [
 [[package]]
 name = "egglog-bridge"
 version = "1.0.0"
-source = "git+https://github.com/egraphs-good//egglog.git?branch=main#1f0b6ecfc2eda306945a6869ddea838e9c309ec6"
+source = "git+https://github.com/saulshanabrook/egg-smol.git?branch=clone-cost#2b6de8034d8fd7af0dc8143f0a8ade5734c34f8c"
 dependencies = [
  "anyhow",
  "dyn-clone",
- "egglog-core-relations 1.0.0 (git+https://github.com/egraphs-good//egglog.git?branch=main)",
- "egglog-numeric-id 1.0.0 (git+https://github.com/egraphs-good//egglog.git?branch=main)",
- "egglog-union-find 1.0.0 (git+https://github.com/egraphs-good//egglog.git?branch=main)",
- "hashbrown 0.15.5",
- "indexmap",
- "log",
- "num-rational",
- "once_cell",
- "petgraph",
- "rayon",
- "smallvec",
- "thiserror",
- "web-time",
-]
-
-[[package]]
-name = "egglog-bridge"
-version = "1.0.0"
-source = "git+https://github.com/egraphs-good/egglog.git?branch=main#1f0b6ecfc2eda306945a6869ddea838e9c309ec6"
-dependencies = [
- "anyhow",
- "dyn-clone",
- "egglog-core-relations 1.0.0 (git+https://github.com/egraphs-good/egglog.git?branch=main)",
- "egglog-numeric-id 1.0.0 (git+https://github.com/egraphs-good/egglog.git?branch=main)",
- "egglog-union-find 1.0.0 (git+https://github.com/egraphs-good/egglog.git?branch=main)",
+ "egglog-core-relations",
+ "egglog-numeric-id",
+ "egglog-union-find",
  "hashbrown 0.15.5",
  "indexmap",
  "log",
@@ -293,63 +271,25 @@ dependencies = [
 [[package]]
 name = "egglog-concurrency"
 version = "1.0.0"
-source = "git+https://github.com/egraphs-good//egglog.git?branch=main#1f0b6ecfc2eda306945a6869ddea838e9c309ec6"
+source = "git+https://github.com/saulshanabrook/egg-smol.git?branch=clone-cost#2b6de8034d8fd7af0dc8143f0a8ade5734c34f8c"
 dependencies = [
  "arc-swap",
  "rayon",
 ]
 
-[[package]]
-name = "egglog-concurrency"
-version = "1.0.0"
-source = "git+https://github.com/egraphs-good/egglog.git?branch=main#1f0b6ecfc2eda306945a6869ddea838e9c309ec6"
-dependencies = [
- "arc-swap",
- "rayon",
-]
-
-[[package]]
-name = "egglog-core-relations"
-version = "1.0.0"
-source = "git+https://github.com/egraphs-good//egglog.git?branch=main#1f0b6ecfc2eda306945a6869ddea838e9c309ec6"
-dependencies = [
- "anyhow",
- "bumpalo",
- "crossbeam-queue",
- "dashmap",
- "dyn-clone",
- "egglog-concurrency 1.0.0 (git+https://github.com/egraphs-good//egglog.git?branch=main)",
- "egglog-numeric-id 1.0.0 (git+https://github.com/egraphs-good//egglog.git?branch=main)",
- "egglog-union-find 1.0.0 (git+https://github.com/egraphs-good//egglog.git?branch=main)",
- "fixedbitset 0.5.7",
- "hashbrown 0.15.5",
- "indexmap",
- "lazy_static",
- "log",
- "num",
- "once_cell",
- "petgraph",
- "rand 0.9.2",
- "rayon",
- "rustc-hash",
- "smallvec",
- "thiserror",
- "web-time",
-]
-
 [[package]]
 name = "egglog-core-relations"
 version = "1.0.0"
-source = "git+https://github.com/egraphs-good/egglog.git?branch=main#1f0b6ecfc2eda306945a6869ddea838e9c309ec6"
+source = "git+https://github.com/saulshanabrook/egg-smol.git?branch=clone-cost#2b6de8034d8fd7af0dc8143f0a8ade5734c34f8c"
 dependencies = [
  "anyhow",
  "bumpalo",
  "crossbeam-queue",
  "dashmap",
  "dyn-clone",
- "egglog-concurrency 1.0.0 (git+https://github.com/egraphs-good/egglog.git?branch=main)",
- "egglog-numeric-id 1.0.0 (git+https://github.com/egraphs-good/egglog.git?branch=main)",
- "egglog-union-find 1.0.0 (git+https://github.com/egraphs-good/egglog.git?branch=main)",
+ "egglog-concurrency",
+ "egglog-numeric-id",
+ "egglog-union-find",
  "fixedbitset 0.5.7",
  "hashbrown 0.15.5",
  "indexmap",
@@ -380,16 +320,7 @@ dependencies = [
 [[package]]
 name = "egglog-numeric-id"
 version = "1.0.0"
-source = "git+https://github.com/egraphs-good//egglog.git?branch=main#1f0b6ecfc2eda306945a6869ddea838e9c309ec6"
-dependencies = [
- "lazy_static",
- "rayon",
-]
-
-[[package]]
-name = "egglog-numeric-id"
-version = "1.0.0"
-source = "git+https://github.com/egraphs-good/egglog.git?branch=main#1f0b6ecfc2eda306945a6869ddea838e9c309ec6"
+source = "git+https://github.com/saulshanabrook/egg-smol.git?branch=clone-cost#2b6de8034d8fd7af0dc8143f0a8ade5734c34f8c"
 dependencies = [
  "lazy_static",
  "rayon",
@@ -398,34 +329,26 @@ dependencies = [
 [[package]]
 name = "egglog-union-find"
 version = "1.0.0"
-source = "git+https://github.com/egraphs-good//egglog.git?branch=main#1f0b6ecfc2eda306945a6869ddea838e9c309ec6"
+source = "git+https://github.com/saulshanabrook/egg-smol.git?branch=clone-cost#2b6de8034d8fd7af0dc8143f0a8ade5734c34f8c"
 dependencies = [
  "crossbeam",
- "egglog-concurrency 1.0.0 (git+https://github.com/egraphs-good//egglog.git?branch=main)",
- "egglog-numeric-id 1.0.0 (git+https://github.com/egraphs-good//egglog.git?branch=main)",
-]
-
-[[package]]
-name = "egglog-union-find"
-version = "1.0.0"
-source = "git+https://github.com/egraphs-good/egglog.git?branch=main#1f0b6ecfc2eda306945a6869ddea838e9c309ec6"
-dependencies = [
- "crossbeam",
- "egglog-concurrency 1.0.0 (git+https://github.com/egraphs-good/egglog.git?branch=main)",
- "egglog-numeric-id 1.0.0 (git+https://github.com/egraphs-good/egglog.git?branch=main)",
+ "egglog-concurrency",
+ "egglog-numeric-id",
 ]
 
 [[package]]
 name = "egglog_python"
-version = "11.3.0"
+version = "11.4.0"
 dependencies = [
  "egglog",
- "egglog-bridge 1.0.0 (git+https://github.com/egraphs-good/egglog.git?branch=main)",
- "egglog-core-relations 1.0.0 (git+https://github.com/egraphs-good/egglog.git?branch=main)",
+ "egglog-bridge",
+ "egglog-core-relations",
  "egglog-experimental",
  "egraph-serialize",
  "lalrpop-util",
  "log",
+ "num-bigint",
+ "num-rational",
  "ordered-float",
  "pyo3",
  "pyo3-log",
@@ -524,7 +447,7 @@ dependencies = [
  "cfg-if",
  "libc",
  "r-efi",
- "wasi 0.14.5+wasi-0.2.4",
+ "wasi 0.14.7+wasi-0.2.4",
 ]
 
 [[package]]
@@ -560,6 +483,12 @@ dependencies = [
  "foldhash",
 ]
 
+[[package]]
+name = "hashbrown"
+version = "0.16.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5419bdc4f6a9207fbeba6d11b604d481addf78ecd10c11ad51e76c2f6482748d"
+
 [[package]]
 name = "heck"
 version = "0.5.0"
@@ -582,13 +511,14 @@ dependencies = [
 
 [[package]]
 name = "indexmap"
-version = "2.11.1"
+version = "2.11.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "206a8042aec68fa4a62e8d3f7aa4ceb508177d9324faf261e1959e495b7a1921"
+checksum = "4b0f83760fb341a774ed326568e19f5a863af4a952def8c39f9ab92fd95b88e5"
 dependencies = [
  "equivalent",
- "hashbrown 0.15.5",
+ "hashbrown 0.16.0",
  "serde",
+ "serde_core",
 ]
 
 [[package]]
@@ -627,9 +557,9 @@ checksum = "4a5f13b858c8d314ee3e8f639011f7ccefe71f97f96e50151fb991f267928e2c"
 
 [[package]]
 name = "js-sys"
-version = "0.3.78"
+version = "0.3.80"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0c0b063578492ceec17683ef2f8c5e89121fbd0b172cbc280635ab7567db2738"
+checksum = "852f13bec5eba4ba9afbeb93fd7c13fe56147f055939ae21c43a29a0ecb2702e"
 dependencies = [
  "once_cell",
  "wasm-bindgen",
@@ -884,6 +814,8 @@ dependencies = [
  "indoc",
  "libc",
  "memoffset",
+ "num-bigint",
+ "num-rational",
  "once_cell",
  "portable-atomic",
  "pyo3-build-config",
@@ -913,8 +845,9 @@ dependencies = [
 
 [[package]]
 name = "pyo3-log"
-version = "0.12.4"
-source = "git+https://github.com/alex/pyo3-log.git?branch=pyo3-bump#3193bba54809be49338815beb363a43252ff7843"
+version = "0.13.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "833e6fdc21553e9938d9443050ed3c7787ac3c1a1aefccbd03dfae0c7a4be529"
 dependencies = [
  "arc-swap",
  "log",
@@ -1116,18 +1049,28 @@ checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49"
 
 [[package]]
 name = "serde"
-version = "1.0.219"
+version = "1.0.225"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fd6c24dee235d0da097043389623fb913daddf92c76e9f5a1db88607a0bcbd1d"
+dependencies = [
+ "serde_core",
+ "serde_derive",
+]
+
+[[package]]
+name = "serde_core"
+version = "1.0.225"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5f0e2c6ed6606019b4e29e69dbaba95b11854410e5347d525002456dbbb786b6"
+checksum = "659356f9a0cb1e529b24c01e43ad2bdf520ec4ceaf83047b83ddcc2251f96383"
 dependencies = [
  "serde_derive",
 ]
 
 [[package]]
 name = "serde_derive"
-version = "1.0.219"
+version = "1.0.225"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5b0276cf7f2c73365f7157c8123c21cd9a50fbbd844757af28ca1f5925fc2a00"
+checksum = "0ea936adf78b1f766949a4977b91d2f5595825bd6ec079aa9543ad2685fc4516"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -1136,15 +1079,16 @@ dependencies = [
 
 [[package]]
 name = "serde_json"
-version = "1.0.143"
+version = "1.0.145"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d401abef1d108fbd9cbaebc3e46611f4b1021f714a0597a71f41ee463f5f4a5a"
+checksum = "402a6f66d8c709116cf22f558eab210f5a50187f702eb4d7e5ef38d9a7f1c79c"
 dependencies = [
  "indexmap",
  "itoa",
  "memchr",
  "ryu",
  "serde",
+ "serde_core",
 ]
 
 [[package]]
@@ -1284,27 +1228,27 @@ checksum = "ccf3ec651a847eb01de73ccad15eb7d99f80485de043efb2f370cd654f4ea44b"
 
 [[package]]
 name = "wasi"
-version = "0.14.5+wasi-0.2.4"
+version = "0.14.7+wasi-0.2.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a4494f6290a82f5fe584817a676a34b9d6763e8d9d18204009fb31dceca98fd4"
+checksum = "883478de20367e224c0090af9cf5f9fa85bed63a95c1abf3afc5c083ebc06e8c"
 dependencies = [
  "wasip2",
 ]
 
 [[package]]
 name = "wasip2"
-version = "1.0.0+wasi-0.2.4"
+version = "1.0.1+wasi-0.2.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "03fa2761397e5bd52002cd7e73110c71af2109aca4e521a9f40473fe685b0a24"
+checksum = "0562428422c63773dad2c345a1882263bbf4d65cf3f42e90921f787ef5ad58e7"
 dependencies = [
  "wit-bindgen",
 ]
 
 [[package]]
 name = "wasm-bindgen"
-version = "0.2.101"
+version = "0.2.103"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7e14915cadd45b529bb8d1f343c4ed0ac1de926144b746e2710f9cd05df6603b"
+checksum = "ab10a69fbd0a177f5f649ad4d8d3305499c42bab9aef2f7ff592d0ec8f833819"
 dependencies = [
  "cfg-if",
  "once_cell",
@@ -1315,9 +1259,9 @@ dependencies = [
 
 [[package]]
 name = "wasm-bindgen-backend"
-version = "0.2.101"
+version = "0.2.103"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e28d1ba982ca7923fd01448d5c30c6864d0a14109560296a162f80f305fb93bb"
+checksum = "0bb702423545a6007bbc368fde243ba47ca275e549c8a28617f56f6ba53b1d1c"
 dependencies = [
  "bumpalo",
  "log",
@@ -1329,9 +1273,9 @@ dependencies = [
 
 [[package]]
 name = "wasm-bindgen-macro"
-version = "0.2.101"
+version = "0.2.103"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7c3d463ae3eff775b0c45df9da45d68837702ac35af998361e2c84e7c5ec1b0d"
+checksum = "fc65f4f411d91494355917b605e1480033152658d71f722a90647f56a70c88a0"
 dependencies = [
  "quote",
  "wasm-bindgen-macro-support",
@@ -1339,9 +1283,9 @@ dependencies = [
 
 [[package]]
 name = "wasm-bindgen-macro-support"
-version = "0.2.101"
+version = "0.2.103"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7bb4ce89b08211f923caf51d527662b75bdc9c9c7aab40f86dcb9fb85ac552aa"
+checksum = "ffc003a991398a8ee604a401e194b6b3a39677b3173d6e74495eb51b82e99a32"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -1352,9 +1296,9 @@ dependencies = [
 
 [[package]]
 name = "wasm-bindgen-shared"
-version = "0.2.101"
+version = "0.2.103"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f143854a3b13752c6950862c906306adb27c7e839f7414cec8fea35beab624c1"
+checksum = "293c37f4efa430ca14db3721dfbe48d8c33308096bd44d80ebaa775ab71ba1cf"
 dependencies = [
  "unicode-ident",
 ]
@@ -1450,9 +1394,9 @@ checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
 
 [[package]]
 name = "wit-bindgen"
-version = "0.45.1"
+version = "0.46.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5c573471f125075647d03df72e026074b7203790d41351cd6edc96f46bcccd36"
+checksum = "f17a85883d4e6d00e8a97c586de764dabcc06133f7f1d55dce5cdc070ad7fe59"
 
 [[package]]
 name = "zerocopy"

egglog-11.4.0/Cargo.toml

@@ -0,0 +1,44 @@
+[package]
+name = "egglog_python"
+version = "11.4.0"
+edition = "2024"
+readme = "README.md"
+
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[lib]
+name = "egglog"
+crate-type = ["cdylib"]
+
+[dependencies]
+pyo3 = { version = "0.26", features = ["extension-module", "num-bigint", "num-rational"] }
+num-bigint = "*"
+num-rational = "*"
+# egglog = { git = "https://github.com/egraphs-good/egglog.git", branch = "main", default-features = false }
+# egglog-bridge = { git = "https://github.com/egraphs-good/egglog.git", branch = "main" }
+# egglog-core-relations = { git = "https://github.com/egraphs-good/egglog.git", branch = "main" }
+egglog = { git = "https://github.com/saulshanabrook/egg-smol.git", branch = "clone-cost", default-features = false }
+egglog-bridge = { git = "https://github.com/saulshanabrook/egg-smol.git", branch = "clone-cost" }
+egglog-core-relations = { git = "https://github.com/saulshanabrook/egg-smol.git", branch = "clone-cost" }
+egglog-experimental = { git = "https://github.com/egraphs-good/egglog-experimental", branch = "cli", default-features = false }
+egraph-serialize = { version = "0.2", features = ["serde", "graphviz"] }
+serde_json = "1"
+pyo3-log = "0.13"
+log = "0.4"
+lalrpop-util = { version = "0.22", features = ["lexer"] }
+ordered-float = "3.7"
+uuid = { version = "1.18", features = ["v4"] }
+rayon = "1.11"
+
+# Use patched version of egglog in experimental
+[patch.'https://github.com/egraphs-good/egglog']
+# egglog = { git = "https://github.com/egraphs-good//egglog.git", branch = "main" }
+egglog = { git = "https://github.com/saulshanabrook/egg-smol.git", branch = "clone-cost" }
+egglog-bridge = { git = "https://github.com/saulshanabrook/egg-smol.git", branch = "clone-cost" }
+egglog-core-relations = { git = "https://github.com/saulshanabrook/egg-smol.git", branch = "clone-cost" }
+# egglog = { path = "../egg-smol" }
+# egglog = { git = "https://github.com/egraphs-good//egglog.git", rev = "5542549" }
+
+# enable debug symbols for easier profiling
+[profile.release]
+debug = true

{egglog-11.3.0 → egglog-11.4.0}/Makefile

@@ -31,7 +31,7 @@ from-local:
 # remove once https://github.com/astral-sh/uv/issues/5903
 
 mypy:
-	uv run dmypy run -- python/
+	uv run dmypy run -- python/ docs/
 
 stubtest:
 	uv run python -m mypy.stubtest egglog.bindings --allowlist stubtest_allow

{egglog-11.3.0 → egglog-11.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: egglog
-Version: 11.3.0
+Version: 11.4.0
 Classifier: Environment :: MacOS X
 Classifier: Environment :: Win32 (MS Windows)
 Classifier: Intended Audience :: Developers

{egglog-11.3.0 → egglog-11.4.0}/docs/changelog.md

@@ -4,6 +4,9 @@ _This project uses semantic versioning_
 
 ## UNRELEASED
 
+## 11.4.0 (2025-10-02)
+
+- Add ability to create custom model and pass them in to extract [#357](https://github.com/egraphs-good/egglog-python/pull/357)
 ## 11.3.0 (2025-09-12)
 
 - Add egglog tutorials, change display to not inline by default, and fix bug looking up binary methods [#352](https://github.com/egraphs-good/egglog-python/pull/352)

{egglog-11.3.0 → egglog-11.4.0}/docs/reference/contributing.md

@@ -83,7 +83,7 @@ Debug symbols are turned on by default.
 If there is a performance sensitive piece of code, you could isolate it in a file and profile it locally with:
 
 ```bash
-uv run py-spy record  --format speedscope  --  python tmp.py
+uv run py-spy record  --format speedscope  --  python -O tmp.py
 ```
 
 ### Making changes

{egglog-11.3.0 → egglog-11.4.0}/docs/reference/egglog-translation.md

@@ -285,6 +285,8 @@ It does this by creating a new table for each function you set the cost for that
 _Note: Unlike in egglog, where you have to declare which functions support custom costs, in Python all functions
 are automatically registered to create a custom cost table when they are constructed_
 
+You can also get the cost of a function with `get_cost`, which will return an `i64` if one has already been set.
+
 ## Defining Rules
 
 To define rules in Python, we create a rule with the `rule(*facts).then(*actions) (rule ...)` command in egglog.

{egglog-11.3.0 → egglog-11.4.0}/docs/reference/python-integration.md

@@ -635,3 +635,33 @@ r = ruleset(
 )
 egraph.saturate(r)
 ```
+
+## Custom Cost Models
+
+By default, when extracting from the e-graph, we use a simple cost model, that looks at the costs assigned to each
+function and any custom costs set with `set_cost`, and finds the lowest cost expression looking at the total tree size.
+
+Custom cost models are also supported, which can be passed into `extract` as the `cost_model` keyword argument. They
+are defined as functions followed the `CostModel` protocol, that take in an e-graph, an expression, and the costs of the children, and return the total cost of that expression. Costs don't have to be integers, they can be any type that supports comparison.
+
+There are a few builtin cost models:
+
+- `default_cost_model`: The default cost model, which uses integer costs and sums them up.
+- `greedy_dag_cost_model(inner_cost_model=default_cost_model)`: A cost model which uses a greedy DAG algorithm to find the lowest cost expression, allowing for shared sub-expressions. It takes in another cost model to use for the base costs of each expression.
+
+Note that when passed into your cost model, the expression won't be a full tree. Instead, only the top level call be present, and all of it's arguments will be opaque "value" expressions, representing e-classes in the e-graph. You can't do much with them except use them to construct other expression to pass into `egraph.lookup_function_value` to get the resulting value of a call with those arguments. The only exception is all builtin types, like ints, vecs, strings, etc. will be fully evaluated recursively, so they can be matched against.
+
+For example, here is a cost model that has a boolean cost if the value is even or not:
+
+```{code-cell} python
+def is_even_cost_model(egraph: EGraph, expr: Expr, children_costs: list[bool]) -> bool:
+    from egglog import i64  # noqa: PLC0415
+
+    match expr:
+        case i64(i):
+            return i % 2 == 0
+    return False
+assert EGraph().extract(i64(10), include_cost=True, cost_model=is_even_cost_model) == (i64(10), True)
+
+assert EGraph().extract(i64(5), include_cost=True, cost_model=is_even_cost_model) == (i64(5), False)
+```

{egglog-11.3.0 → egglog-11.4.0}/pyproject.toml

@@ -54,7 +54,7 @@ test = [
     "egglog[array]",
     "pytest-codspeed",
     "pytest-benchmark",
-    "pytest-xdist",
+    "pytest-xdist"
 ]
 
 docs = [