Installation

We recommend using environments for managing Python packages, refer to venv or Conda for more information.

Tagged versions of the rfgb library are hosted on the Python Package Index (PyPi). The associated Documentation is on readthedocs.

pip install rfgb

Development versions are on GitHub. These may contain partially-implemented features. The Latest Documentation is on readthedocs.

git clone https://github.com/starling-lab/rfgb.py.git
python setup.py develop

Quick-Start without Installation

  1. git clone https://github.com/starling-lab/rfgb.py
  2. cd rfgb.py
  3. Relational Dependency Network classification on a logistics domain:
$ python -m rfgb \
	learn rdn \
	-target unload \
	-train testDomains/Logistics/train/ \
	-test testDomains/Logistics/test/

Quick start gif.

Versioning and Development

We use SemVer (Major.Minor.Patch) for versioning.

This project is currently in early Alpha: some features available in BoostSRL are missing. The commandline interface (CLI) and application programming interface (API) are not finalized yet, and are subject to change.

Interested in contributing? Refer to the Contributing section of the documentation.

License

Copyright © 2017-2018 StARLinG Lab. This program comes with absolutely no warranty. This is free software, available under the terms of the GPL-3.0. You are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.