tiny-weka

Stripped down version of WEKA 3.9.x branch (HEAD) that just contains the bare minimum API without any package manager, PMML, XML or user interface related code.

In contrast to the regular Weka source code, which is released under GPLv3, this code is released under the MIT license. It is aimed at commercial applications that require licensing only a small subset of WEKA's algorithms.

For more information on obtaining a commercial license for WEKA algorithms see the following wiki FAQ:

https://waikato.github.io/weka-wiki/faqs/commercial_applications/

Maven template

The following repo contains a Maven template using tiny-weka:

https://github.com/Waikato/tiny-weka-maven-template

Code base

The code base of tiny-weka is synced (manually) with Weka's git repository, trunk branch up to the following revision:

r3cbb52f21   # git commit hash

Maven

Releases use the following versioning system:

X.Y.Z

• X.Y - the Weka major/minor release version
• Z - the Weka subversion repository revision or git commit hash that the code base was synced to

Releases

Add the following dependency to your pom.xml to use the latest release of tiny-weka:

<dependency>
  <groupId>nz.ac.waikato.cms.weka</groupId>
  <artifactId>tiny-weka</artifactId>
  <version>3.9.3cbb52f21-2</version>
</dependency>

Notes:

• 3.9.3cbb52f21-2 - post 3.9.6 release, as of 2024-10-04
• 3.9.3cbb52f21 - post 3.9.6 release, as of 2024-10-04
• 3.9.15955 - equivalent to 3.9.6 release
• 3.9.15754 - equivalent to 3.9.5 release

Updating

Update files

The code base can be synced with Weka's git repository using the update.py Python script.

usage: update.py [-h] -w, --weka DIR -c, --commit HASH [-g, --git EXECUTABLE]
                 [-n, --dry_run] [-v, --verbose]

Analyzes the git log from the specified commit hash on and then updates the
code accordingly. It stores the start/end git commit hash in 'update.rev'
after execution.

optional arguments:
  -h, --help            show this help message and exit
  -w, --weka DIR        the directory with the Weka git clone (HEAD)
  -c, --commit HASH     the git commit hash to start from
  -g, --git EXECUTABLE  the git executable to use if not on the path
  -n, --dry_run         whether to perform a dry run, i.e., only simulating
                        the update
  -v, --verbose         whether to be verbose with the output

Example:

python3 update.py \
  -w /some/where/weka-HEAD/ \
  -c 87a3264c \ 
  -v

Post-process files

• Files that should not end up in the code base need to be added to the BLACKLISTED_FILES list
• Directories that should not end up in the code base need to be added to the BLACKLISTED_PATHS
• Files that were manually modified (e.g., removing package manager code) need to be added to the MODIFIED_FILES list. If such a file has been updated in the git repository, a warning is being output.

Remove GPL

The remove_gpl.py script can be used to remove the GPL preamble from any Java file that still contains it, e.g., when manually copying over files.

usage: remove_gpl.py [-h] -d, --dir DIR [-r, --recursive] [-n, --dry_run]
                     [-v, --verbose]

Removes the GPL preamble from Java source code files.

optional arguments:
  -h, --help       show this help message and exit
  -d, --dir DIR    the directory with source code files to process
  -r, --recursive  whether to search for source code files recursively
  -n, --dry_run    whether to perform a dry run, i.e., only simulating the
                   removal
  -v, --verbose    whether to be verbose with the output

Commit

• Once compilation and unit tests work, commit all changes