Skip to content

Latest commit

 

History

History
86 lines (60 loc) · 2.78 KB

README.md

File metadata and controls

86 lines (60 loc) · 2.78 KB
Raw

BigML.io Java bindings

BigML <https://bigml.com>_ makes machine learning easy by taking care of the details required to add data-driven decisions and predictive power to your company. Unlike other machine learning services, BigML creates beautiful predictive models <https://bigml.com/gallery/models>_ that can be easily understood and interacted with.

These BigML Java bindings allow you to interact with BigML.io <https://bigml.io/>, the API for BigML. You can use it to easily create, retrieve, list, update, and delete BigML resources (i.e., sources, datasets, models and, predictions). For additional information, see the full documentation for the Java bindings on Read the Docs <http://bigml-java.readthedocs.org>.

This module is licensed under the Apache License, Version 2.0.

See all the changes history here.

Support

Please, report problems and bugs to BigML.io-Java issue tracker

You can send us an email at BigML email support

You can join us in Campfire chatroom

Integrating Maven

Add the following dependency to your project's pom.xml file:

<dependency>
    <groupId>org.bigml</groupId>
    <artifactId>bigml-binding</artifactId>
    <version>2.0.0</version>
</dependency>

Add the following lines to your project's pom.xml file if you want to use the SNAPSHOT versions of the library:

<repositories>
    <repository>
        <id>osshr-snapshots</id>
        <url>https://oss.sonatype.org/content/repositories/snapshots</url>
        <snapshots><enabled>true</enabled></snapshots>
        <releases><enabled>false</enabled></releases>
    </repository>
</repositories>

Requirements

You will find in the binding.properties file where to setup your BigML credentialscBIGML_USERNAME and BIGML_API_KEY. They can be overwritten passing the values as JVM variables with -D.

The project uses Maven as project manager.

Running the Tests

There is a test suite using Cucumber available, you may want to run it by execute:

$ mvn test

or this way, if you want to debug the tests

$ mvn -Dmaven.surefire.debug="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 -Xnoagent -Djava.compiler=NONE" test

Examples

The samples directory contains a maven project named BigML-Sample-Client that can be imported. It shows some basic examples about how to use the bindings to create resources in BigML. See the corresponding readme for details.

Generated JAR file of the bindings

Since version 1.1 the name of the JAR file is bigml-binding.