Code documentation

Contains classes for initializing RuleKit Java backend

class rulekit.main.RuleKit

Class used for initializing RuleKit

It starts JVM underhood and setups it with jars.

version

version of RuleKit jar used by wrapper (not equal to python package version).

Type:

str

static init(initial_heap_size: Optional[int] = None, max_heap_size: Optional[int] = None)

Initialize package.

This method must by called before using any operators in this package. It configure and starts JVM and load RuleKit jar file.

Parameters:

  • initial_heap_size (int) – JVM initial heap size in mb

  • max_heap_size (int) – JVM max heap size in mb

Raises:

Exception – If failed to load RuleKit jar file.

Table of contents: