Documentation

Installation

Environment

BIGtensor runs on any machine that supports hadoop.
However, the shell scripts and code packaging scripts works easily in Linux or Unix machines.
BIGtensor needs the following softwares to be installed in the system:

  • Hadoop version 1.0.4 or greater
  • Java 1.6.x or greater, preferably from Sun

Download and Install

Installation is as simple as downloading and extracting the installation file.

  1. Download the file BIGtensor-1.0.tar.gz.
  2. Extract the file by running the following command: tar xvzf BIGtensor-1.0.tar.gz. Then, the directory 'BIGtensor' will be created.
  3. cd BIGtensor

Running

BIGtensor Library

  1. Type `cd bin` in the installation directory. The BIGtensor library(.jar file) appears.
  2. You can import this file as library in a project you want.

Detailed explanations about how to use this library is on USER Guide and API Doc below.

Code example

Here is a demo code that decomposes a tensor by PARAFAC. Note that you can use PARAFAC using 13 lines of code!



import bigtensor.Decompositions.PARAFAC;
public class PARAFAC {
    public static void main (final String[] args) throws Exception {
        String testInputPath = "test.tensor";
        String testOutputPath = "parafac_out";
        long[] testdims = {5,4,3};
		int rank = 10;
        int nmachines = 2;
		int max_iteration = 10;

        PARAFAC.TF_PARAFAC(testInputPath, testOutputPath, testdims, rank, nmachines, max_iterations);
    }
}

                    

User Guide

The User Guide provides information on the general overview, installation, and supported functions of BIGtensor.


User Guide

API Doc

The API Doc provides detailed information on classes and functions in BIGtensor.


API Doc