org.deeplearning4j.plot

Class BarnesHutTsne

java.lang.Object

org.deeplearning4j.plot.BarnesHutTsne

All Implemented Interfaces:

Model

public class BarnesHutTsne
extends Object
implements Model

Barnes hut algorithm for TSNE, uses a dual tree approximation approach. Work based on: http://lvdmaaten.github.io/tsne/ For hight dimensions, it's recommended to reduce the dimension up to 50 using another method (PCA or other)

Author:

Adam Gibson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BarnesHutTsne.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected AdaGrad	adaGrad
protected double	finalMomentum
protected double	initialMomentum
protected double	learningRate
protected int	maxIter
protected double	minGain
protected double	momentum
protected boolean	normalize
protected double	perplexity
protected double	realMin
protected int	stopLyingIteration
protected int	switchMomentumIteration
protected double	tolerance
protected TrainingListener	trainingListener
protected boolean	useAdaGrad
protected boolean	usePca
static String	workspaceCache
static org.nd4j.linalg.api.memory.conf.WorkspaceConfiguration	workspaceConfigurationCache
protected static org.nd4j.linalg.api.memory.conf.WorkspaceConfiguration	workspaceConfigurationExternal
protected org.nd4j.linalg.api.memory.conf.WorkspaceConfiguration	workspaceConfigurationFeedForward
static String	workspaceExternal
protected WorkspaceMode	workspaceMode
protected INDArray	Y
static String	Y_GRAD

Constructor Summary

Constructors

Constructor and Description
BarnesHutTsne(int numDimensions, String simiarlityFunction, double theta, boolean invert, int maxIter, double realMin, double initialMomentum, double finalMomentum, double momentum, int switchMomentumIteration, boolean normalize, int stopLyingIteration, double tolerance, double learningRate, boolean useAdaGrad, double perplexity, TrainingListener TrainingListener, double minGain, int vpTreeWorkers)
BarnesHutTsne(int numDimensions, String simiarlityFunction, double theta, boolean invert, int maxIter, double realMin, double initialMomentum, double finalMomentum, double momentum, int switchMomentumIteration, boolean normalize, int stopLyingIteration, double tolerance, double learningRate, boolean useAdaGrad, double perplexity, TrainingListener TrainingListener, double minGain, int vpTreeWorkers, WorkspaceMode workspaceMode)

Method Summary

Modifier and Type	Method and Description
void	addListeners(TrainingListener... listener)
void	applyConstraints(int iteration, int epoch)
int	batchSize()
void	clear()
org.nd4j.linalg.primitives.Pair<INDArray,Double>	computeGaussianKernel(INDArray distances, double beta, int k) Computes a gaussian kernel given a vector of squared distance distances
INDArray	computeGaussianPerplexity(INDArray d, double u) Convert data to probability co-occurrences (aka calculating the kernel)
void	computeGradientAndScore(LayerWorkspaceMgr workspaceMgr)
NeuralNetConfiguration	conf()
void	fit()
void	fit(INDArray data)
void	fit(INDArray data, int nDims) Deprecated. Use fit(INDArray)
void	fit(INDArray data, LayerWorkspaceMgr workspaceMgr)
INDArray	getData() Return the matrix reduce to the NDim.
INDArray	getGradientsViewArray()
int	getNumDimensions()
ConvexOptimizer	getOptimizer()
INDArray	getParam(String param)
double	getPerplexity()
String	getSimiarlityFunction()
double	getTheta()
Gradient	gradient()
protected org.nd4j.linalg.primitives.Pair<Double,INDArray>	gradient(INDArray p)
org.nd4j.linalg.primitives.Pair<Gradient,Double>	gradientAndScore()
void	init() Init the model
INDArray	input()
boolean	isInvert()
long	numParams()
long	numParams(boolean backwards)
INDArray	params()
Map<String,INDArray>	paramTable()
Map<String,INDArray>	paramTable(boolean backprapParamsOnly)
void	plot(INDArray matrix, int nDims, List<String> labels, String path) Deprecated. use fit(INDArray) and saveAsFile(List, String) instead.
void	saveAsFile(List<String> labels, String path) Save the model as a file with a csv format, adding the label as the last column.
double	score()
void	setBackpropGradientsViewArray(INDArray gradients)
void	setConf(NeuralNetConfiguration conf)
void	setData(INDArray data)
void	setInvert(boolean invert)
void	setListeners(Collection<TrainingListener> listeners) Set the trainingListeners for the ComputationGraph (and all layers in the network)
void	setListeners(TrainingListener... listeners) Set the trainingListeners for the ComputationGraph (and all layers in the network)
void	setNumDimensions(int numDimensions)
void	setParam(String key, INDArray val)
void	setParams(INDArray params)
void	setParamsViewArray(INDArray params)
void	setParamTable(Map<String,INDArray> paramTable)
void	setSimiarlityFunction(String simiarlityFunction)
void	step(INDArray p, int i) An individual iteration
INDArray	symmetrized(INDArray rowP, INDArray colP, INDArray valP) Symmetrize the value matrix
void	update(Gradient gradient)
void	update(INDArray gradient, String paramType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

workspaceCache

public static final String workspaceCache

See Also:

Constant Field Values

workspaceExternal

public static final String workspaceExternal

See Also:

Constant Field Values

maxIter

protected int maxIter

realMin

protected double realMin

initialMomentum

protected double initialMomentum

finalMomentum

protected double finalMomentum

minGain

protected double minGain

momentum

protected double momentum

switchMomentumIteration

protected int switchMomentumIteration

normalize

protected boolean normalize

usePca

protected boolean usePca

stopLyingIteration

protected int stopLyingIteration

tolerance

protected double tolerance

learningRate

protected double learningRate

adaGrad

protected AdaGrad adaGrad

useAdaGrad

protected boolean useAdaGrad

perplexity

protected double perplexity

Y

protected INDArray Y

Y_GRAD

public static final String Y_GRAD

See Also:

Constant Field Values

trainingListener

protected transient TrainingListener trainingListener

workspaceMode

protected WorkspaceMode workspaceMode

workspaceConfigurationExternal

protected static final org.nd4j.linalg.api.memory.conf.WorkspaceConfiguration workspaceConfigurationExternal

workspaceConfigurationFeedForward

protected org.nd4j.linalg.api.memory.conf.WorkspaceConfiguration workspaceConfigurationFeedForward

workspaceConfigurationCache

public static final org.nd4j.linalg.api.memory.conf.WorkspaceConfiguration workspaceConfigurationCache

Constructor Detail

BarnesHutTsne

public BarnesHutTsne(int numDimensions,
                     String simiarlityFunction,
                     double theta,
                     boolean invert,
                     int maxIter,
                     double realMin,
                     double initialMomentum,
                     double finalMomentum,
                     double momentum,
                     int switchMomentumIteration,
                     boolean normalize,
                     int stopLyingIteration,
                     double tolerance,
                     double learningRate,
                     boolean useAdaGrad,
                     double perplexity,
                     TrainingListener TrainingListener,
                     double minGain,
                     int vpTreeWorkers)

BarnesHutTsne

public BarnesHutTsne(int numDimensions,
                     String simiarlityFunction,
                     double theta,
                     boolean invert,
                     int maxIter,
                     double realMin,
                     double initialMomentum,
                     double finalMomentum,
                     double momentum,
                     int switchMomentumIteration,
                     boolean normalize,
                     int stopLyingIteration,
                     double tolerance,
                     double learningRate,
                     boolean useAdaGrad,
                     double perplexity,
                     TrainingListener TrainingListener,
                     double minGain,
                     int vpTreeWorkers,
                     WorkspaceMode workspaceMode)

Method Detail

getSimiarlityFunction

public String getSimiarlityFunction()

setSimiarlityFunction

public void setSimiarlityFunction(String simiarlityFunction)

isInvert

public boolean isInvert()

setInvert

public void setInvert(boolean invert)

getTheta

public double getTheta()

getPerplexity

public double getPerplexity()

getNumDimensions

public int getNumDimensions()

setNumDimensions

public void setNumDimensions(int numDimensions)

computeGaussianPerplexity

public INDArray computeGaussianPerplexity(INDArray d,
                                          double u)

Convert data to probability co-occurrences (aka calculating the kernel)

Parameters:

d - the data to convert

u - the perplexity of the model

Returns:

the probabilities of co-occurrence

input

public INDArray input()

Specified by:

input in interface Model

getOptimizer

public ConvexOptimizer getOptimizer()

Specified by:

getOptimizer in interface Model

getParam

public INDArray getParam(String param)

Specified by:

getParam in interface Model

addListeners

public void addListeners(TrainingListener... listener)

Specified by:

addListeners in interface Model

paramTable

public Map<String,INDArray> paramTable()

Specified by:

paramTable in interface Model

paramTable

public Map<String,INDArray> paramTable(boolean backprapParamsOnly)

Specified by:

paramTable in interface Model

setParamTable

public void setParamTable(Map<String,INDArray> paramTable)

Specified by:

setParamTable in interface Model

setParam

public void setParam(String key,
                     INDArray val)

Specified by:

setParam in interface Model

clear

public void clear()

Specified by:

clear in interface Model

applyConstraints

public void applyConstraints(int iteration,
                             int epoch)

Specified by:

applyConstraints in interface Model

gradient

protected org.nd4j.linalg.primitives.Pair<Double,INDArray> gradient(INDArray p)

symmetrized

public INDArray symmetrized(INDArray rowP,
                            INDArray colP,
                            INDArray valP)

Symmetrize the value matrix

Parameters:

rowP -

colP -

valP -

Returns:

computeGaussianKernel

public org.nd4j.linalg.primitives.Pair<INDArray,Double> computeGaussianKernel(INDArray distances,
                                                                              double beta,
                                                                              int k)

Computes a gaussian kernel given a vector of squared distance distances

Parameters:

distances -

beta -

Returns:

init

public void init()

Init the model

Specified by:

init in interface Model

setListeners

public void setListeners(Collection<TrainingListener> listeners)

Set the trainingListeners for the ComputationGraph (and all layers in the network)

Specified by:

setListeners in interface Model

Parameters:

listeners -

setListeners

public void setListeners(TrainingListener... listeners)

Set the trainingListeners for the ComputationGraph (and all layers in the network)

Specified by:

setListeners in interface Model

Parameters:

listeners -

fit

public void fit()

Specified by:

fit in interface Model

update

public void update(Gradient gradient)

Specified by:

update in interface Model

step

public void step(INDArray p,
                 int i)

An individual iteration

Parameters:

p - the probabilities that certain points are near each other

i - the iteration (primarily for debugging purposes)

update

public void update(INDArray gradient,
                   String paramType)

Specified by:

update in interface Model

saveAsFile

public void saveAsFile(List<String> labels,
                       String path)
                throws IOException

Save the model as a file with a csv format, adding the label as the last column.

Parameters:

labels -

path - the path to write

Throws:

IOException

plot

@Deprecated
public void plot(INDArray matrix,
                             int nDims,
                             List<String> labels,
                             String path)
                      throws IOException

Deprecated. use fit(INDArray) and saveAsFile(List, String) instead.

Plot tsne

Parameters:

matrix - the matrix to plot

nDims - the number

labels -

path - the path to write

Throws:

IOException

score

public double score()

Specified by:

score in interface Model

computeGradientAndScore

public void computeGradientAndScore(LayerWorkspaceMgr workspaceMgr)

Specified by:

computeGradientAndScore in interface Model

params

public INDArray params()

Specified by:

params in interface Model

numParams

public long numParams()

Specified by:

numParams in interface Model

numParams

public long numParams(boolean backwards)

Specified by:

numParams in interface Model

setParams

public void setParams(INDArray params)

Specified by:

setParams in interface Model

setParamsViewArray

public void setParamsViewArray(INDArray params)

Specified by:

setParamsViewArray in interface Model

getGradientsViewArray

public INDArray getGradientsViewArray()

Specified by:

getGradientsViewArray in interface Model

setBackpropGradientsViewArray

public void setBackpropGradientsViewArray(INDArray gradients)

Specified by:

setBackpropGradientsViewArray in interface Model

fit

public void fit(INDArray data)

fit

public void fit(INDArray data,
                LayerWorkspaceMgr workspaceMgr)

Specified by:

fit in interface Model

fit

@Deprecated
public void fit(INDArray data,
                            int nDims)

Deprecated. Use fit(INDArray)

Change the dimensions with

gradient

public Gradient gradient()

Specified by:

gradient in interface Model

gradientAndScore

public org.nd4j.linalg.primitives.Pair<Gradient,Double> gradientAndScore()

Specified by:

gradientAndScore in interface Model

batchSize

public int batchSize()

Specified by:

batchSize in interface Model

conf

public NeuralNetConfiguration conf()

Specified by:

conf in interface Model

setConf

public void setConf(NeuralNetConfiguration conf)

Specified by:

setConf in interface Model

getData

public INDArray getData()

Return the matrix reduce to the NDim.

setData

public void setData(INDArray data)