shapelets / khiva-kotlin

Kotlin binding for Khiva library.

Khiva-Kotlin

Build Linux and Mac OS	Build Windows	Code Coverage

README

This is the Khiva binding for Kotlin, it allows the usage of Khiva library from Kotlin.

License

This project is licensed under MPL-v2.

Quick Summary

This Kotlin package called 'khiva' provides all the functionalities of the Khiva library for time series analytics.

Requirements

• Arrayfire
• Khiva library

Set up

It is just needed to execute the next command in the root directory of the project:

mvn install

Executing the tests:

Execute the next command in the root directory of the project:

 mvn test

Note: The tests are executed automatically when the package is installed.

Documentation

This Kotlin package follows the standard way of writing documentation of Kotlin code using dokka.

In order to generate the documentation, execute the next command in the root directory of the project:

mvn dokka:dokka

You can also generate the regular javadoc style documentation with:

mvn dokka:javadoc

Dokka does not support the writing of mathematical formulas, therefore functions containing them will show their LaTeX original text version. This will be fixed as soon as they support it.

Contributing

The rules to contribute to this project are described here