Merge pull request #17 from metadsl/16-change-name-to-egglog

Rename to egglog and add citation

Author: saulshanabrook

.github/workflows/CI.yml

@@ -95,8 +95,8 @@ jobs:
           command: build
           args: --release --sdist -o dist --find-interpreter
           # Pin rust toolchain, so it won't install 1.65.0, otherwise get this error:
-          # Attempting to include the sdist output tarball dist/egg_smol-0.1.0.tar.gz into itself! Check 'cargo package --list' output.
-          # https://github.com/metadsl/egg-smol-python/actions/runs/3388178229/jobs/5629843303
+          # Attempting to include the sdist output tarball dist/egglog-0.1.0.tar.gz into itself! Check 'cargo package --list' output.
+          # https://github.com/metadsl/egglog-python/actions/runs/3388178229/jobs/5629843303
           rust-toolchain: "1.64.0"
       - name: Upload wheels
         uses: actions/upload-artifact@v2

.pre-commit-config.yaml

@@ -28,7 +28,7 @@ repos:
     hooks:
       - id: stubtest
         name: stubtest
-        entry: python -m mypy.stubtest egg_smol.bindings  --allowlist stubtest_allow
+        entry: python -m mypy.stubtest egglog.bindings  --allowlist stubtest_allow
         language: system
         pass_filenames: false
         require_serial: true

Cargo.lock

@@ -1,22 +1,22 @@
 [package]
-name = "egg-smol-python"
+name = "egglog-python"
 version = "0.3.1"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [lib]
-name = "egg_smol_python"
+name = "egglog_python"
 crate-type = ["cdylib"]
 
 [dependencies]
 # Use unreleased version to depend on signature improvements https://github.com/PyO3/pyo3/pull/2702
 pyo3 = { version = "0.18.1", features = ["extension-module"] }
-egg-smol = { git = "https://github.com/mwillsey/egg-smol", rev = "30feaaab88452ec4b6c5f7a199345298bac2dd0f" }
-# egg-smol = { path = "../egg-smol" }
+egg-smol = { git = "https://github.com/egraphs-good/egglog", rev = "30feaaab88452ec4b6c5f7a199345298bac2dd0f" }
+# egg-smol = { path = "../egglog" }
 pyo3-log = "0.8.1"
 log = "0.4.17"
 lalrpop-util = { version = "0.19.8", features = ["lexer"] }
 ordered-float = "3.4"
 
 [package.metadata.maturin]
-name = "egg_smol.bindings"
+name = "egglog.bindings"

Cargo.toml

@@ -1,8 +1,8 @@
-# `egg-smol` Python wrapper
+# `egglog` Python wrapper
 
-[![Documentation Status](https://readthedocs.org/projects/egg-smol-python/badge/?version=latest)](https://egg-smol-python.readthedocs.io/en/latest/?badge=latest) [![Test](https://github.com/metadsl/egg-smol-python/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/metadsl/egg-smol-python/actions/workflows/CI.yml) [![PyPi Package](https://img.shields.io/pypi/v/egg-smol.svg)](https://pypi.org/project/egg-smol/) [![License](https://img.shields.io/pypi/l/egg-smol.svg)](https://pypi.org/project/egg-smol/) [![Python Versions](https://img.shields.io/pypi/pyversions/egg-smol.svg)](https://pypi.org/project/egg-smol/) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+[![Documentation Status](https://readthedocs.org/projects/egg-smol-python/badge/?version=latest)](https://egg-smol-python.readthedocs.io/en/latest/?badge=latest) [![Test](https://github.com/metadsl/egglog-python/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/metadsl/egglog-python/actions/workflows/CI.yml) [![PyPi Package](https://img.shields.io/pypi/v/egglog.svg)](https://pypi.org/project/egglog/) [![License](https://img.shields.io/pypi/l/egglog.svg)](https://pypi.org/project/egglog/) [![Python Versions](https://img.shields.io/pypi/pyversions/egglog.svg)](https://pypi.org/project/egglog/) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 
-`egg-smol` is a Python package that provides bindings to the Rust library [`egg-smol`](https://github.com/mwillsey/egg-smol/),
+`egglog` is a Python package that provides bindings to the Rust library [`egglog`](https://github.com/egraphs-good/egglog/),
 allowing you to use e-graphs in Python for optimization, symbolic computation, and analysis.
 
-Please see the [documentation](https://egg-smol-python.readthedocs.io/en/latest/) for more information.
+Please see the [documentation](https://egglog-python.readthedocs.io/en/latest/) for more information.

README.md

@@ -2,18 +2,20 @@
 
 ## Unreleased
 
+- Change name to `egglog` from `egg-smol`, to mirror [upstream change](https://github.com/egraphs-good/egglog/commit/9484242f025f6c2adb6f29d75a45dd77b0eaad57). Note that all previous versions are published under the `egg-smol` PyPi package while this and later are under `egglog`.
+
 ## 0.3.1 (2023-05-02)
 
 - Fix bug calling methods on paramterized types (e.g. `Map[i64, i64].empty().insert(i64(0), i64(1))`)
 - Fix bug for Unit type (egg name is `Unit` not `unit`)
 - Use `@class_` decorator to force subclassing `BaseExpr`
-- Workaround extracting definitions until [upstream is fixed](https://github.com/mwillsey/egg-smol/pull/140)
+- Workaround extracting definitions until [upstream is fixed](https://github.com/egraphs-good/egglog/pull/140)
 - Rename `Map.map_remove` to `Map.remove`.
 - Add lambda calculus example
 
 ## 0.3.0 (2023-04-26)
 
-- [Upgrade `egg-smol` from `08a6e8fecdb77e6ba72a1b1d9ff4aff33229912c` to `6f2633a5fa379487fb389b80fc1225866f8b8c1a`.](https://github.com/metadsl/egg-smol-python/pull/14)
+- [Upgrade `egglog` from `08a6e8fecdb77e6ba72a1b1d9ff4aff33229912c` to `6f2633a5fa379487fb389b80fc1225866f8b8c1a`.](https://github.com/metadsl/egglog-python/pull/14)
 
 ## 0.2.0 (2023-03-27)
 

docs/changelog.md

@@ -18,7 +18,7 @@
 sphinx_gallery_conf = {
     # Run all scripts
     "filename_pattern": r".*",
-    "examples_dirs": "../python/egg_smol/examples",
+    "examples_dirs": "../python/egglog/examples",
     "gallery_dirs": "auto_examples",
     "abort_on_example_error": True,
     "run_stale_examples": True,
@@ -34,7 +34,7 @@
 
 # specify project details
 master_doc = "index"
-project = "egg-smol Python"
+project = "egglog Python"
 
 
 # basic build settings
@@ -55,7 +55,7 @@
     "icon_links": [
         {
             "name": "GitHub",
-            "url": "https://github.com/metadsl/egg-smol-python",
+            "url": "https://github.com/metadsl/egglog-python",
             "icon": "fa-brands fa-square-github",
             "type": "fontawesome",
         },

docs/conf.py

@@ -5,19 +5,3 @@ explanation/compared_to_rust
 explanation/optional_values
 explanation/define_and_define
 ```
-
-## Status of this project
-
-This package is in development and is not ready for production use. `egg-smol` itself
-is also subject to changes and is less stable than [`egg`](https://github.com/egraphs-good/egg).
-If you are looking for a more stable e-graphs library in Python, you can try [`snake-egg`](https://github.com/egraphs-good/snake-egg), which wraps `egg`.
-
-`egg-smol` is a rewrite of the egg library to use [relational e-matching](https://arxiv.org/abs/2108.02290):
-
-> We have determined the relational e-matching is somewhat of a poor match for egg as it's currently structured for a couple reasons. (1) Most workloads that egg users encounter focus on small, simple patterns, so relational e-matching is no better and sometimes slower because you have to build the database "from scratch" every iteration. (2) egg gives the user a little too much flexibility in manipulating e-nodes (in particular, you the e-node list in each e-class is exposed); this makes it hard to incrementally maintain the datastructures you'd need for relational e-matching. egg-smol (name temporary) is a clean slate approach to this and some other shortcomings of egg. No promises on its stabilization or merging into egg yet.
->
-> - [Max Willsey](https://egraphs.zulipchat.com/#narrow/stream/328972-general/topic/roadmap/near/297442354)
-
-## How documentation is organized
-
-We use the [Diátaxis framework](https://diataxis.fr/) to organize our documentation. This helps with figuring out where different content should live and how it should be organized.

docs/explanation.md

@@ -47,10 +47,10 @@ egg text version of this from the tests is:
 ## Low Level API
 
 One way to run this in Python is to parse the text and run it similar to how the
-egg-smol CLI works:
+egglog CLI works:
 
 ```{code-cell} python
-from egg_smol.bindings import *
+from egglog.bindings import *
 
 eqsat_basic = """(datatype Math
   (Num i64)
@@ -81,7 +81,7 @@ commands = egraph.parse_program(eqsat_basic)
 egraph.run_program(*commands)
 ```
 
-The commands are a representation which is close the AST of the egg-smol text language. We
+The commands are a representation which is close the AST of the egglog text language. We
 can see this by printing the commands:
 
 ```{code-cell} python
@@ -102,7 +102,7 @@ Here is the same example using the high level API:
 ```{code-cell} python
 from __future__ import annotations
 
-from egg_smol import *
+from egglog import *
 
 egraph = EGraph()
 
@@ -148,7 +148,7 @@ Here are a number of the low level commands, with how they map to the high levle
 
 - `(datatype Math ...)` -> `@egraph.class_` on a Python class. Internally, each method and classmethod are registered as functions, not as `Variant`s of the datatype, but the end result is the same.
 - `(set-option enable_proofs 1)` -> Not supported
-- `(declare True Bool)` -> As a class variable `True: Bool` or as a constant `True_ = egraph.constant("True", Bool)`. Internally, we don't actually use the `Constant` command but instead map constants to nullary functions which are immediately evaluated. This is how the `Constant` command is desugared in egg-smol anyways.
+- `(declare True Bool)` -> As a class variable `True: Bool` or as a constant `True_ = egraph.constant("True", Bool)`. Internally, we don't actually use the `Constant` command but instead map constants to nullary functions which are immediately evaluated. This is how the `Constant` command is desugared in egglog anyways.
 - `(define expr1 ...)` -> `expr1 = egraph.define("expr1", ...)` or just `expr1 = ...` if it doesn't need to be added to the e-graph.
 - `(sort MyMap (Map i64 String))` -> `MyMap = Map[i64, String]`. We can use the normal Python generic typing syntax. Internally, when this is used in a type definition, we would create a new sort with the name `Map__i64__String`.
 - `(function f ...)` -> `@egraph.function` on a Python function with no body.

docs/explanation/compared_to_rust.md

@@ -1,4 +1,4 @@
-# How does egg-smol handle boolean values?
+# How does egglog handle boolean values?
 
 Some functions, like `<<` return an optional int.
 Others, like `<` return an optional unit.
@@ -9,7 +9,7 @@ Are optional values automatically unwrapped?
 
 It looks like we can use them as conditionals as well, like this `(check (< 1 2))`.
 
-Let's look at how check will be implemented in egg-smol:
+Let's look at how check will be implemented in egglog:
 
 1. The rule for parsing `check` in `parse.lalrpop` is:
 
@@ -23,7 +23,7 @@ Let's look at how check will be implemented in egg-smol:
 Let's see what happens if we call check on something that is not true:
 
 ```python
-from egg_smol.bindings import *
+from egglog.bindings import *
 egraph = EGraph()
 egraph.check_fact(Fact(
     Call(
@@ -43,7 +43,7 @@ PanicException: prim was partial... do we allow this?
 And what if we call check with a non-unit value?
 
 ```python
-from egg_smol.bindings import *
+from egglog.bindings import *
 egraph = EGraph()
 egraph.check_fact(Fact(
     Call(