Skip to main content

Type based synthesis framework using inhabitation in FCLP

Project description

CoSy

CoSy logo
Package PyPI - Version PyPI - Python Version
License License
Package CI - Test CD - Release CoSy
Docs Docs - Release Docs - Checks
Coverage codecov codecov
Traits Hatch project Checked with mypy Checked with Ruff

CoSy enables synthesis of arbitrary artifacts from individual modular components. It efficiently handles specification and constraints of these modular components, describing how they connect and which performance criteria need to be satisfied.

APIs

CoSy can be used in two different ways.

  • Using the Synthesizer. This enables using all features but is more complicated to use.
  • Using the Maestro. This enables using less features, but is easy to use.

The Synthesizer is the recommended way for "power-users" to interact with CoSy. Publications that primarily focus on type-theoretic aspects usually use it.

The Maesto is the cute creature playing with building blocks (modular components) on the logo. This gifted architect is incredible at connecting these to satisfy any target a user may query for. The Maestro API is intended to be easy to use, but the trade-off is lower flexibility.

For most technological applications of combinatory synthesis to other fields, e.g. synthesizing physical structures, the Maestro is sufficient.

Examples

  • For a simple example for a theoretically minded computer scientist, see: Fibonacci
  • For a simple example for a practically minded engineer, see: Robot Arm (WIP)

While the examples above use Maestro, the following example uses the Synthesizer:

  • For a simple example on the usage of evolutionary algorithms for searching the synthesized solution spaces, see: Symbolic Regression

Installation

Installation is as simple as running:

pip install --pre combinatory-synthesizer

Since CoSy is still in pre-release state, PyPi distributions are likely to be outdated most of the time.

If you want to stay up to date with a nightly build:

pip install https://github.com/tudo-seal/cosy/releases/download/nightly/combinatory_synthesizer-nightly.tar.gz

CoSy itself has no dependencies at all, so it will play nice with any pre-existing projects.

Documentation

This README is intentionally left brief.
Please head over to the documentation to get started.

License

CoSy is distributed under the terms of the Apache-2.0 license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

combinatory_synthesizer-0.0.1.dev29.tar.gz (113.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

combinatory_synthesizer-0.0.1.dev29-py3-none-any.whl (68.2 kB view details)

Uploaded Python 3

File details

Details for the file combinatory_synthesizer-0.0.1.dev29.tar.gz.

File metadata

File hashes

Hashes for combinatory_synthesizer-0.0.1.dev29.tar.gz
Algorithm Hash digest
SHA256 166817da1364ee0e0a50da5bf611b94a213cdea7ada1291b392d17756c4736ba
MD5 2ebfce5b3c793629ed9540c820253041
BLAKE2b-256 b9f0d9770da7f8fd01a5de24b9813e892aeb83f1df345366cd2958228ab439ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for combinatory_synthesizer-0.0.1.dev29.tar.gz:

Publisher: pre-release.yml on tudo-seal/cosy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file combinatory_synthesizer-0.0.1.dev29-py3-none-any.whl.

File metadata

File hashes

Hashes for combinatory_synthesizer-0.0.1.dev29-py3-none-any.whl
Algorithm Hash digest
SHA256 d3a1b1367af201f3f39ca53fbb8da032f72501b8e9f5c61aa2dbbeed21ad67a2
MD5 4b40febbcb1dd54e68fea35500597187
BLAKE2b-256 e59183c9f19b91ba9d259c6d9eed52c7302c0bd544c124fbf5fad8046fdee32d

See more details on using hashes here.

Provenance

The following attestation bundles were made for combinatory_synthesizer-0.0.1.dev29-py3-none-any.whl:

Publisher: pre-release.yml on tudo-seal/cosy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page