Welcome to specless’s documentation!

specless (SPECification LEarning and Strategy Synthesis) is a Python library for learningg specification from demonstrations and synthesizing strategies that satisfy the given specification. It aims to offer a simple and intuitive API. To checkout the code, please visit our repo on GitHub.

Note

This project is under active development.

Installation

from PyPI

$ pip install specless

from source

$ pip install git@github.com:watakandai/specless.git

or clone from github and install the library

$ git clone https://github.com/watakandai/specless.git
$ cd specless
$ pip install .

Development

If you want to contribute, set up your development environment as follows:

Install Poetry <https://python-poetry.org>_
Clone the repository:

$ git clone https://github.com/watakandai/specless.git && cd specless

Install the dependencies:

$ poetry shell && poetry install

Tests

To run tests: tox

To run only the code tests: tox

Docs

Locally, run make html inside the docs directory.

Once you are ready, make a pull request and the documentations are built automatically with GitHub Actions. See .github/generate-documentation.yml.

License

Apache 2.0 License

specless

specless