Skip to content

Latest commit

 

History

History
32 lines (25 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

32 lines (25 loc) · 1.59 KB
Raw

Contributing

Contributions are welcome and an easy way to get started is to file an issue. Make sure to be as descriptive about your problem as possible. Try to explain what you have tried, what you expected and what the actual outcome was. Give additional information about your java and weka version, as well as platform specific details that could be relevant.

If you are going to contribute to the codebase, you should fork this repository, create a separate branch on which you commit your changes and file a pull request. A well explained how-to is described here.

Java Code Style

This package mostly follows the official Google Java Style Guide.

Build Locally

The package uses Gradle to manage dependencies and build the necessary weka package zip file, as well as the additional cuda library zip files. It is either possible to call the specific gradle tasks:

$ ./gradlew makeMain
$ ./gradlew makeCuda -Dcuda=10.0
$ ./gradlew makeCuda -Dcuda=10.1
$ ./gradlew makeCuda -Dcuda=10.2

or to use the provided build.py script. The usage is as follows:

$ ./build.py -h
usage: build.py [-h] [--cuda-version {10.0,10.1,10.2}] [--build-all] [--verbose]

Build the wekaDeeplearning4j packages.

optional arguments:
  -h, --help            show this help message and exit
  --cuda-version {10.0,10.1,10.2}, -c {10.0,10.1,10.2}
                        The cuda version.
  --build-all, -a       Flag to build all platform/cuda packages.
  --verbose, -v         Enable verbose output.