DiffeRT

Usage

Warning

Until this package reaches version v0.1.0, breaking changes should be expected. Checkout the v0.1.0 and v1.0.0 milestones for future features.

If you have any suggestion regarding the development of this package, please open an issue.

The easiest way to install DiffeRT is through pip:

pip install differt

We provide pre-built binaries for most platforms. If you want (or need) to build the package from the source distribution, or want to customize the installation (e.g., with GPU support), check out the installation guide.

Reporting an issue

If you think you found a bug, an error in the documentation, or wish there was some feature that is currently missing, we would love to hear from you!

The best way to reach us is via the GitHub issues. If your problem is not covered by an already existing (closed or open) issue, then we suggest you create a new issue. You can choose from a list of templates, or open a blank issue if your issue does not fit one of the proposed topics.

The more precise you are in the description of your problem, the faster we will be able to help you!

If you rather have question than a problem, then it is probably best suited to ask it in the Q&A category of the discussions.

Contributing

All types of contributions are more than welcome!

Please follow the contributing guide for a detailed step-by-step procedure.

Citing

If you use this software, please cite it as detailed here.