satzilla 0.0.1__tar.gz

satzilla-0.0.1/MANIFEST.in

@@ -0,0 +1,16 @@
+include README.md
+include pyproject.toml
+include setup.py
+
+graft satzilla_features
+graft src
+
+# Exclude local build outputs and caches from source distributions.
+prune src/obj
+prune src/lp_solve_5.0/bin
+global-exclude __pycache__
+global-exclude *.py[cod]
+global-exclude *.o
+global-exclude *.so
+global-exclude *.a
+exclude src/features

satzilla-0.0.1/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: satzilla
+Version: 0.0.1
+Summary: Python wrapper for the Revisiting SATZilla 2024 feature extractor
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Provides-Extra: pysat
+Requires-Dist: python-sat; extra == "pysat"
+
+
+# Revisiting SATZilla in 2024
+
+  
+Code for the paper: "Revisiting SATZilla Features in 2024" by Hadar Shavit and Holger H. Hoos accepted to SAT 2024.
+
+## Abstract
+Boolean satisfiability (SAT) is an $\mathcal{NP}$-complete problem with important applications, notably in hardware and software verification.
+Characterising a SAT instance by a set of features has shown great potential for various tasks, ranging from algorithm selection to benchmark generation.
+In this work, we revisit the widely used SATZilla features and introduce a new version of the tool used to compute them.  
+In particular, we utilise a new preprocessor and SAT solvers, adjust the code to accommodate larger formulas, and determine better settings of the feature extraction time limits.
+We evaluate the extracted features on three downstream tasks: satisfiability prediction, running time prediction, and algorithm selection. 
+We observe that our new tool is able to extract features from a broader range of instances than before. 
+We show that the new version of the feature extractor produces features that achieve up to $25\%$ lower RMSE for running time prediction, up to $5\%$ higher accuracy for satisfiability prediction, and up to $80\%$ higher closed gap for algorithm selection on benchmarks from recent SAT competitions.
+
+
+## Usage
+We provide precompiled binaries for the SATZilla feature extraction tool for linux. Currently the SATZilla features extractor supports only linux.
+
+SAT-feature-computation code contains the new SATZilla feature extraction tool.
+
+Recompile by running `make`, then the executable `features` will be created.
+
+To run a package-level smoke test for the extractor, use `make test` inside `SAT-features-competition2024`.
+
+To compute features, simply run `./features [--timeout SECONDS] [--group-timeout SECONDS] [--preprocess-timeout SECONDS] [-base] [-structure] [-ncnf-graphs] [-ncnf-constraints] [-ncnf-rwh] [-dia] [-ls] [-lp] [-lobjois] INFILE OUTFILE`
+Where -lp, -dia etc are the feature groups:
+
+ - base: Base feature group, including pre, KLB, and clause graph
+ - structure: Structural features from SATfeatPy
+ - ncnf-graphs: New-CNF graph features
+ - ncnf-constraints: New-CNF constraint features
+ - ncnf-rwh: New-CNF recursive weight heuristic features
+ - dia: Diameter
+ - ls: Local search (both GSAT and Sparrow)
+ - lp: Linear programming
+ - lobjois: Lobjois
+ -  cl: Clause learning
+ - unit: Unit propagation
+ - sp: Survey propagation
+
+  To compute all features use the -all option.
+  The input INFILE is a DIMACS CNF file. NOTE: currently, only raw CNF files are supported, and not compressed one (like .cnf.xz)
+  The output is a CSV file containing the features for one instance.
+
+Timeout controls:
+- `--timeout`: total extraction timeout
+- `--group-timeout`: per-feature-group timeout override; timed-out groups emit reserved values and extraction continues with the next selected group
+- `--preprocess-timeout`: timeout override for the preprocessing step
+
+## Python Interface
+Install from PyPI:
+
+```bash
+pip install satzilla
+```
+
+An importable Python interface is available in the `satzilla_features` package. It accepts PySAT `CNF` formulas directly and
+calls the extractor through a bundled shared library using `ctypes`; it does not shell out to the CLI.
+
+PySAT documents that `pysat.formula.CNF` exposes `clauses` and `nv`, and supports DIMACS I/O:
+https://pysathq.github.io/docs/html/api/formula.html
+
+Example:
+
+```python
+from pysat.formula import CNF
+from satzilla_features import extract_features
+
+cnf = CNF(from_clauses=[[-1, 2], [-2, 3], [1, 3]])
+features = extract_features(
+    cnf,
+    groups=["base", "structure", "ncnf-graphs"],
+    group_timeout=180,
+)
+print(features["variable_alpha"])
+```
+
+You can also extract directly from a CNF file path with `extract_features_from_path(...)`.
+Both Python entry points accept `timeout=...`, `group_timeout=...`, and `preprocess_timeout=...`.
+
+When building the Python package, the C/C++ extractor is compiled into `libsatzilla_features.so` and packaged together with the
+solver binaries it needs at runtime. The direct Python interface is currently Linux-only.
+
+
+## Experiments
+rt_pred.py contains the code for running time prediction. sat_pred.py contains the code for satisfiability prediction. Both are using submitit for execution on a SLURM cluster.
+For algorithm selection, the scenarios are available in the aslib directory. The AutoFolio code is available at https://github.com/hadarshavit/AutoFolio.
+## Contact
+To contact us, please send an email to [shavit@aim.rwth-aachen.de](mailto:shavit@aim.rwth-aachen.de)

satzilla-0.0.1/README.md

@@ -0,0 +1,90 @@
+
+# Revisiting SATZilla in 2024
+
+  
+Code for the paper: "Revisiting SATZilla Features in 2024" by Hadar Shavit and Holger H. Hoos accepted to SAT 2024.
+
+## Abstract
+Boolean satisfiability (SAT) is an $\mathcal{NP}$-complete problem with important applications, notably in hardware and software verification.
+Characterising a SAT instance by a set of features has shown great potential for various tasks, ranging from algorithm selection to benchmark generation.
+In this work, we revisit the widely used SATZilla features and introduce a new version of the tool used to compute them.  
+In particular, we utilise a new preprocessor and SAT solvers, adjust the code to accommodate larger formulas, and determine better settings of the feature extraction time limits.
+We evaluate the extracted features on three downstream tasks: satisfiability prediction, running time prediction, and algorithm selection. 
+We observe that our new tool is able to extract features from a broader range of instances than before. 
+We show that the new version of the feature extractor produces features that achieve up to $25\%$ lower RMSE for running time prediction, up to $5\%$ higher accuracy for satisfiability prediction, and up to $80\%$ higher closed gap for algorithm selection on benchmarks from recent SAT competitions.
+
+
+## Usage
+We provide precompiled binaries for the SATZilla feature extraction tool for linux. Currently the SATZilla features extractor supports only linux.
+
+SAT-feature-computation code contains the new SATZilla feature extraction tool.
+
+Recompile by running `make`, then the executable `features` will be created.
+
+To run a package-level smoke test for the extractor, use `make test` inside `SAT-features-competition2024`.
+
+To compute features, simply run `./features [--timeout SECONDS] [--group-timeout SECONDS] [--preprocess-timeout SECONDS] [-base] [-structure] [-ncnf-graphs] [-ncnf-constraints] [-ncnf-rwh] [-dia] [-ls] [-lp] [-lobjois] INFILE OUTFILE`
+Where -lp, -dia etc are the feature groups:
+
+ - base: Base feature group, including pre, KLB, and clause graph
+ - structure: Structural features from SATfeatPy
+ - ncnf-graphs: New-CNF graph features
+ - ncnf-constraints: New-CNF constraint features
+ - ncnf-rwh: New-CNF recursive weight heuristic features
+ - dia: Diameter
+ - ls: Local search (both GSAT and Sparrow)
+ - lp: Linear programming
+ - lobjois: Lobjois
+ -  cl: Clause learning
+ - unit: Unit propagation
+ - sp: Survey propagation
+
+  To compute all features use the -all option.
+  The input INFILE is a DIMACS CNF file. NOTE: currently, only raw CNF files are supported, and not compressed one (like .cnf.xz)
+  The output is a CSV file containing the features for one instance.
+
+Timeout controls:
+- `--timeout`: total extraction timeout
+- `--group-timeout`: per-feature-group timeout override; timed-out groups emit reserved values and extraction continues with the next selected group
+- `--preprocess-timeout`: timeout override for the preprocessing step
+
+## Python Interface
+Install from PyPI:
+
+```bash
+pip install satzilla
+```
+
+An importable Python interface is available in the `satzilla_features` package. It accepts PySAT `CNF` formulas directly and
+calls the extractor through a bundled shared library using `ctypes`; it does not shell out to the CLI.
+
+PySAT documents that `pysat.formula.CNF` exposes `clauses` and `nv`, and supports DIMACS I/O:
+https://pysathq.github.io/docs/html/api/formula.html
+
+Example:
+
+```python
+from pysat.formula import CNF
+from satzilla_features import extract_features
+
+cnf = CNF(from_clauses=[[-1, 2], [-2, 3], [1, 3]])
+features = extract_features(
+    cnf,
+    groups=["base", "structure", "ncnf-graphs"],
+    group_timeout=180,
+)
+print(features["variable_alpha"])
+```
+
+You can also extract directly from a CNF file path with `extract_features_from_path(...)`.
+Both Python entry points accept `timeout=...`, `group_timeout=...`, and `preprocess_timeout=...`.
+
+When building the Python package, the C/C++ extractor is compiled into `libsatzilla_features.so` and packaged together with the
+solver binaries it needs at runtime. The direct Python interface is currently Linux-only.
+
+
+## Experiments
+rt_pred.py contains the code for running time prediction. sat_pred.py contains the code for satisfiability prediction. Both are using submitit for execution on a SLURM cluster.
+For algorithm selection, the scenarios are available in the aslib directory. The AutoFolio code is available at https://github.com/hadarshavit/AutoFolio.
+## Contact
+To contact us, please send an email to [shavit@aim.rwth-aachen.de](mailto:shavit@aim.rwth-aachen.de)

satzilla-0.0.1/pyproject.toml

@@ -0,0 +1,16 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "satzilla"
+version = "0.0.1"
+description = "Python wrapper for the Revisiting SATZilla 2024 feature extractor"
+readme = "README.md"
+requires-python = ">=3.9"
+
+[project.optional-dependencies]
+pysat = ["python-sat"]
+
+[tool.setuptools]
+packages = ["satzilla_features"]

satzilla-0.0.1/satzilla.egg-info/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: satzilla
+Version: 0.0.1
+Summary: Python wrapper for the Revisiting SATZilla 2024 feature extractor
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Provides-Extra: pysat
+Requires-Dist: python-sat; extra == "pysat"
+
+
+# Revisiting SATZilla in 2024
+
+  
+Code for the paper: "Revisiting SATZilla Features in 2024" by Hadar Shavit and Holger H. Hoos accepted to SAT 2024.
+
+## Abstract
+Boolean satisfiability (SAT) is an $\mathcal{NP}$-complete problem with important applications, notably in hardware and software verification.
+Characterising a SAT instance by a set of features has shown great potential for various tasks, ranging from algorithm selection to benchmark generation.
+In this work, we revisit the widely used SATZilla features and introduce a new version of the tool used to compute them.  
+In particular, we utilise a new preprocessor and SAT solvers, adjust the code to accommodate larger formulas, and determine better settings of the feature extraction time limits.
+We evaluate the extracted features on three downstream tasks: satisfiability prediction, running time prediction, and algorithm selection. 
+We observe that our new tool is able to extract features from a broader range of instances than before. 
+We show that the new version of the feature extractor produces features that achieve up to $25\%$ lower RMSE for running time prediction, up to $5\%$ higher accuracy for satisfiability prediction, and up to $80\%$ higher closed gap for algorithm selection on benchmarks from recent SAT competitions.
+
+
+## Usage
+We provide precompiled binaries for the SATZilla feature extraction tool for linux. Currently the SATZilla features extractor supports only linux.
+
+SAT-feature-computation code contains the new SATZilla feature extraction tool.
+
+Recompile by running `make`, then the executable `features` will be created.
+
+To run a package-level smoke test for the extractor, use `make test` inside `SAT-features-competition2024`.
+
+To compute features, simply run `./features [--timeout SECONDS] [--group-timeout SECONDS] [--preprocess-timeout SECONDS] [-base] [-structure] [-ncnf-graphs] [-ncnf-constraints] [-ncnf-rwh] [-dia] [-ls] [-lp] [-lobjois] INFILE OUTFILE`
+Where -lp, -dia etc are the feature groups:
+
+ - base: Base feature group, including pre, KLB, and clause graph
+ - structure: Structural features from SATfeatPy
+ - ncnf-graphs: New-CNF graph features
+ - ncnf-constraints: New-CNF constraint features
+ - ncnf-rwh: New-CNF recursive weight heuristic features
+ - dia: Diameter
+ - ls: Local search (both GSAT and Sparrow)
+ - lp: Linear programming
+ - lobjois: Lobjois
+ -  cl: Clause learning
+ - unit: Unit propagation
+ - sp: Survey propagation
+
+  To compute all features use the -all option.
+  The input INFILE is a DIMACS CNF file. NOTE: currently, only raw CNF files are supported, and not compressed one (like .cnf.xz)
+  The output is a CSV file containing the features for one instance.
+
+Timeout controls:
+- `--timeout`: total extraction timeout
+- `--group-timeout`: per-feature-group timeout override; timed-out groups emit reserved values and extraction continues with the next selected group
+- `--preprocess-timeout`: timeout override for the preprocessing step
+
+## Python Interface
+Install from PyPI:
+
+```bash
+pip install satzilla
+```
+
+An importable Python interface is available in the `satzilla_features` package. It accepts PySAT `CNF` formulas directly and
+calls the extractor through a bundled shared library using `ctypes`; it does not shell out to the CLI.
+
+PySAT documents that `pysat.formula.CNF` exposes `clauses` and `nv`, and supports DIMACS I/O:
+https://pysathq.github.io/docs/html/api/formula.html
+
+Example:
+
+```python
+from pysat.formula import CNF
+from satzilla_features import extract_features
+
+cnf = CNF(from_clauses=[[-1, 2], [-2, 3], [1, 3]])
+features = extract_features(
+    cnf,
+    groups=["base", "structure", "ncnf-graphs"],
+    group_timeout=180,
+)
+print(features["variable_alpha"])
+```
+
+You can also extract directly from a CNF file path with `extract_features_from_path(...)`.
+Both Python entry points accept `timeout=...`, `group_timeout=...`, and `preprocess_timeout=...`.
+
+When building the Python package, the C/C++ extractor is compiled into `libsatzilla_features.so` and packaged together with the
+solver binaries it needs at runtime. The direct Python interface is currently Linux-only.
+
+
+## Experiments
+rt_pred.py contains the code for running time prediction. sat_pred.py contains the code for satisfiability prediction. Both are using submitit for execution on a SLURM cluster.
+For algorithm selection, the scenarios are available in the aslib directory. The AutoFolio code is available at https://github.com/hadarshavit/AutoFolio.
+## Contact
+To contact us, please send an email to [shavit@aim.rwth-aachen.de](mailto:shavit@aim.rwth-aachen.de)