symprog 0.1.0a1__tar.gz

symprog-0.1.0a1/.gitignore

@@ -0,0 +1,32 @@
+# Python
+__pycache__/
+*.py[cod]
+*.so
+
+# Packaging
+build/
+dist/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.venv/
+venv*/
+env*/
+
+# Tests and coverage
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+.tox/
+
+# Notebooks
+.ipynb_checkpoints/
+
+# Editors and OS files
+.vscode/
+.idea/
+*.swp
+*~
+.DS_Store

symprog-0.1.0a1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

symprog-0.1.0a1/PKG-INFO

@@ -0,0 +1,348 @@
+Metadata-Version: 2.5
+Name: symprog
+Version: 0.1.0a1
+Summary: A lightweight toolkit for prototyping discrete and probabilistic symbolic programs in Python.
+Project-URL: Homepage, https://github.com/TuLLI-AI/symprog
+Project-URL: Issues, https://github.com/TuLLI-AI/symprog/issues
+Author: Kyle Richardson
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: knowledge compilation,neuro-symbolic,probabilistic logic programming,symbolic programming,weighted model counting
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Requires-Dist: dd
+Requires-Dist: dill
+Requires-Dist: numpy
+Requires-Dist: pydantic>=2
+Requires-Dist: pysdd
+Requires-Dist: python-sat
+Requires-Dist: symengine
+Requires-Dist: sympy>=1.12
+Requires-Dist: torch>=2.1
+Requires-Dist: z3-solver
+Provides-Extra: console
+Requires-Dist: pandas; extra == 'console'
+Requires-Dist: streamlit; extra == 'console'
+Requires-Dist: streamlit-code-editor; extra == 'console'
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: ipykernel; extra == 'dev'
+Requires-Dist: nbmake; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Provides-Extra: jax
+Requires-Dist: jax; extra == 'jax'
+Provides-Extra: klay
+Requires-Dist: klaycircuits>=0.1.2; (python_version >= '3.11') and extra == 'klay'
+Provides-Extra: notebooks
+Requires-Dist: graphviz; extra == 'notebooks'
+Requires-Dist: jupyter; extra == 'notebooks'
+Description-Content-Type: text/markdown
+
+# symprog
+
+**Symbolic programming in Python: a fast prototyping toolkit for
+working with weighted Boolean formulas and discrete (probabilistic) programs.**
+
+> ⚠️ **Work in progress.** `symprog` is under active development. APIs may
+> change between releases, and some features are experimental. Feedback, bug
+> reports and contributions are very welcome. Please open an
+> [issue](https://github.com/TuLLI-AI/symprog/issues).
+
+`symprog` lets you write small symbolic programs (Boolean constraints,
+probabilistic logic programs, weighted formulas) directly inside Python. You can
+then reason about them on the fly: count models, compute exact probabilities,
+find the most likely assignment, take gradients, or look at the underlying
+symbolic equations.
+
+It is designed with two uses in mind:
+
+- **Rapid prototyping.** Sketch a new modeling idea involving weighed
+  Boolean formulas or discrete programming in a few lines of Python. Then switch the reasoning backend (SDDs, BDDs, SAT, SMT) and the
+  numerical backend (PyTorch, symbolic algebra) without rewriting your program.
+- **Teaching.** The library stays small and readable. Each piece (languages,
+  solvers, semirings, knowledge compilers) matches a concept from logic,
+  probabilistic reasoning and automated reasoning, and the
+  [notebooks](notebooks/) walk through them step by step.
+
+## Installation
+
+`symprog` requires Python 3.10 or newer.
+
+```bash
+pip install symprog
+```
+
+To get the latest development version from GitHub:
+
+```bash
+pip install "git+https://github.com/TuLLI-AI/symprog.git"
+```
+
+Optional extras:
+
+```bash
+pip install "symprog[console]"    # interactive Streamlit console
+pip install "symprog[notebooks]"  # Jupyter and graphviz for the tutorials
+pip install "symprog[jax]"        # experimental JAX backend
+pip install "symprog[klay]"       # klay tensorizaiton backend (https://github.com/ML-KULeuven/klay)
+```
+
+For development, clone the repository and install it in editable mode:
+
+```bash
+git clone https://github.com/TuLLI-AI/symprog.git
+cd symprog
+pip install -e ".[dev,notebooks,console]"
+pytest
+```
+
+## Quick tour
+
+### Languages
+
+`symprog` can embed small probabilistic programming languages *inline* in
+Python, with on-the-fly inference and differentiable computation.
+
+Below is a small program in probabilistic logic. It has a set of constraints
+over weighted variables:
+
+```python
+from symprog import Parser
+
+@Parser(language="constraint")
+def prog():
+    ## variable weights
+    a: 0.9; b: 0.7; c: 0.65
+
+    ## Boolean constraints
+    (not a) or b
+    c or b
+    (not b) or c
+
+    ## conditioning
+    condition: a
+```
+
+You can then query the exact probability that the formula is satisfied:
+
+```python
+prog.inference(mode="Prob").inference
+```
+
+The next example uses a small probabilistic logic programming language, inspired
+by [ProbLog](https://dtai.cs.kuleuven.be/problog/):
+
+```python
+from symprog import Parser
+
+@Parser(language="plp")
+def inh():
+    ## probabilistic facts
+    c1: 0.5; c2: 0.5
+
+    ## weighted clauses
+    e1[0.3] :- c1
+    e1[0.2, False] :- c2
+
+    e2[0.4] :- c2
+    e2[0.2, False] :- c1
+
+    e :- e1
+    e :- e2
+
+    ## evidence or conditions
+    evidence(c1, True)
+    evidence(c2, True)
+
+    ## queries
+    query(e)
+```
+
+The same kinds of inference work here. For more examples see
+[`notebooks/languages.ipynb`](notebooks/languages.ipynb).
+
+### Interactive console
+
+To try programs interactively, launch the console from a clone of the
+repository (it requires the `console` extra):
+
+```bash
+streamlit run console.py
+```
+
+The console comes with example programs in both languages (graph coloring,
+fault diagnosis, Monty Hall, a hidden Markov model and more). Besides running,
+sampling and exact inference, it can show:
+
+- the program's models, with a brute-force check of the solver's results;
+- the compiled circuit, with the value of each node in a chosen semiring, and
+  the files to download it;
+- each program as inline Python code, ready to copy.
+
+### Solvers
+
+Inference is driven by `Solver`s. A `Solver` gives you one simple interface to
+several reasoning tools, such as
+[pysdd](https://pysdd.readthedocs.io/en/latest/),
+[z3](https://ericpony.github.io/z3py-tutorial/guide-examples.htm)  and
+[python-sat](https://pysathq.github.io/), and to tensor libraries such as
+[PyTorch](https://pytorch.org/). With these it performs exact inference over
+(weighted) Boolean formulas.
+
+```python
+from symprog import Solver
+
+solver = Solver()
+
+## add propositional formulas and variable weights
+solver.add([
+    "Implies(a, b)",
+    "And(Or(a, b), Implies(a, c))",
+])
+solver.add_weights({"a": 0.9, "b": 0.64, "c": 0.34})
+
+## probabilistic inference (weighted model counting)
+print(solver.query())
+# => SolverOut(inference_type=Prob, inference=0.2598400115966797)
+```
+
+Solvers support many kinds of inference through an extensible *algebraic*
+(semiring) interface. See
+[`notebooks/solver_tutorial.ipynb`](notebooks/solver_tutorial.ipynb) for details:
+
+```python
+## Viterbi-style inference (most likely assignment of variables)
+solver.query(mode="Viterbi").inference
+solver.query(mode="ViterbiAssignment").variables
+# => {'c': True, 'b': True, 'a': True}
+solver.query(mode="LogViterbi").inference
+
+## semantic entropy (entropy of interpretations given the formulas)
+solver.query(mode="Entropy").inference
+
+## probability and log probability (more numerically stable)
+solver.query(mode="Prob").inference
+solver.query(mode="LogProb").inference
+
+## fuzzy inference
+solver.query(mode="Fuzzy").inference
+
+## satisfiability testing (SAT)
+solver.query(mode="SAT").inference
+```
+
+Conditioning on evidence:
+
+```python
+solver.query(mode="ViterbiAssignment", evidence="~a").variables
+# => {'c': False, 'a': False, 'b': True}
+```
+
+Gradients with respect to the weights:
+
+```python
+solver.gradient(mode="Viterbi", key="weights")
+# => tensor([0.2176, 0.3060, 0.5760])
+```
+
+Model enumeration:
+
+```python
+for model in solver.models():
+    print(model)
+# {'a': True, 'c': True, 'b': True}
+# {'a': False, 'c': False, 'b': True}
+# {'a': False, 'c': True, 'b': True}
+```
+
+### Backend support
+
+Not every backend supports every feature yet:
+
+| Backend | SAT / model counting / model enumeration | Weighted inference (`Prob`, `Viterbi`, …) | Gradients |
+| --- | --- | --- | --- |
+| `sdd` solver (default) | ✅ | ✅ | ✅ |
+| `bdd`, `z3`, `sympy`, `pysat` solvers | ✅ | ❌ not yet implemented | n/a |
+| `pytorch` weights (default) | | ✅ | ✅ |
+| `python` weights | | ✅ | ❌ |
+| `sympy` / `symengine` symbolic weights | | ✅ | ✅ (symbolic) |
+| `jax` weights (**experimental**, `pip install "symprog[jax]"`) | | ✅ | ✅ |
+
+With the JAX backend, `Solver.as_function` returns inference as a pure function
+of the weight vector (ordered as in `solver.weight_names`). You can then
+transform it with `jax.grad`, `jax.jit` and `jax.vmap`, for example to compute
+batched gradients for many weight settings at once:
+
+```python
+import jax, jax.numpy as jnp
+
+solver.add_weights({"a": 0.9, "b": 0.64, "c": 0.34}, container_type="jax")
+f = solver.as_function(mode="LogProb", evidence="c")
+batched_grads = jax.jit(jax.vmap(jax.grad(f)))(jnp.array([[0.9, 0.64, 0.34],
+                                                          [0.2, 0.50, 0.70]]))
+```
+
+The `Product` inference mode (product t-norm with probabilistic sum) is also
+**experimental**. It is not a true semiring, so its results depend on the
+structure of the compiled circuit.
+
+**Tensorization** (`solver.tensorize`), which compiles an inference into a
+PyTorch module for fast batched evaluation, is **experimental** as well. It has
+two backends: `fx` (default), which supports all inference modes, evidence,
+queries and conditionals, and `klay`, which uses
+[KLay](https://github.com/ML-KULeuven/klay) to evaluate circuits layer by layer
+and supports `Prob`, `LogProb`, `Viterbi`, `LogViterbi` and `Fuzzy`, without
+evidence or conditioning (`pip install "symprog[klay]"`, Python ≥ 3.11).
+
+Experimental features emit a `symprog.ExperimentalWarning`, which can be
+silenced with:
+
+```python
+import warnings, symprog
+warnings.filterwarnings("ignore", category=symprog.ExperimentalWarning)
+```
+
+### Symbolic equations
+
+Solvers also connect to computer algebra systems
+([SymPy](https://www.sympy.org/),
+[SymEngine](https://github.com/symengine/symengine.py)). You can produce and
+manipulate the exact symbolic equations behind any of the inferences above:
+
+```python
+## the symbolic polynomial behind the entropy computation
+solver.query(mode="Entropy", symbolic=True).inference
+# => log(a*b*c + b*(1 - a)) - (a*b*c*log(a) + a*(b*c*log(b) + b*c*log(c)) + ...
+
+## its symbolic gradient vector
+solver.gradient(mode="Entropy", symbolic=True, key="weights")
+```
+
+## Tutorials
+
+The [`notebooks/`](notebooks/) directory contains step-by-step tutorials, in
+suggested reading order:
+
+| Notebook | Topic |
+| --- | --- |
+| [`solver_tutorial.ipynb`](notebooks/solver_tutorial.ipynb) | **Start here:** formulas, weighted model counting, conditioning, and the algebraic (semiring) view of inference |
+| [`languages.ipynb`](notebooks/languages.ipynb) | Writing inline constraint programs and probabilistic logic programs (ProbLog-style) |
+| [`symbolic_and_gradients.ipynb`](notebooks/symbolic_and_gradients.ipynb) | Symbolic expressions, numerical/symbolic/Boolean gradients, and learning weights |
+| [`tensorization_and_jax.ipynb`](notebooks/tensorization_and_jax.ipynb) | Fast batched inference: compiling to PyTorch modules, and JAX (`jit`, `vmap`, `grad`) |
+| [`solver_interfaces.ipynb`](notebooks/solver_interfaces.ipynb) | The solver backends (SDD, BDD, z3, sympy, PySAT) |
+| [`weight_interface.ipynb`](notebooks/weight_interface.ipynb) | The weight backends (PyTorch, Python, symbolic, JAX) |
+
+## Contributing
+
+`symprog` is meant to grow with its users. Bug reports, examples, new languages
+and new solver backends are all welcome. Please open an issue to discuss larger
+changes before submitting a pull request.
+
+## License
+
+`symprog` is released under the [Apache License 2.0](LICENSE).