io.improbable.keanu.backend

Interface ComputableGraphBuilder<T extends ComputableGraph>

All Known Implementing Classes:

KeanuCompiledGraphBuilder

public interface ComputableGraphBuilder<T extends ComputableGraph>

Method Summary

Modifier and Type	Method and Description
VariableReference	add(VariableReference left, VariableReference right) Creates an addition operation for the left and right arguments.
T	build()
void	connect(java.util.Map<? extends Vertex<?>,? extends Vertex<?>> connections)
default void	convert(java.util.Collection<? extends Vertex> vertices)
default void	convert(java.util.Collection<? extends Vertex> vertices, java.util.Collection<? extends Vertex> outputs)
void	create(Vertex visiting)
void	createConstant(Vertex visiting)
void	createVariable(Vertex visiting)
java.util.Collection<VariableReference>	getLatentVariables()
void	registerOutput(VariableReference output)

Method Detail

createConstant

void createConstant(Vertex visiting)

Parameters:

visiting - create this vertex as a constant in the computable graph that is being built.

createVariable

void createVariable(Vertex visiting)

Parameters:

visiting - create this vertex as a variable in the computable graph that is being built.

create

void create(Vertex visiting)

Parameters:

visiting - create this vertex in the compiled graph that is being built.

connect

void connect(java.util.Map<? extends Vertex<?>,? extends Vertex<?>> connections)

Parameters:

connections - tells the graph builder that any time a vertex is referenced in a connection to reroute it to another vertex. This is used to hook up proxy vertices that aren't actually connected to parents until they are being added to a graph with this builder.

registerOutput

void registerOutput(VariableReference output)

Parameters:

output - a variable reference to a variable that should be used as an output. This lets the builder know that the variable should not be mutated and to possibly trim any operations that is not needed for this output.

getLatentVariables

java.util.Collection<VariableReference> getLatentVariables()

add

VariableReference add(VariableReference left,
                      VariableReference right)

Creates an addition operation for the left and right arguments. This is used for adding two graphs that aren't otherwise connected. This happens when summing multiple logProb graphs to form a joint logProb variable

Parameters:

left - a variable reference to the left arg

right - a variable reference to the right arg

Returns:

a new variable reference for the resulting sum

build

T build()

Returns:

a computable graph that can be used for a calculation described by the vertices used to build it.

convert

default void convert(java.util.Collection<? extends Vertex> vertices,
                     java.util.Collection<? extends Vertex> outputs)

Parameters:

vertices - vertices that represent a graph to create a computable graph from.

outputs - explicitly specified outputs. This allows the builder to prune operations not needed in order to provide the outputs.

convert

default void convert(java.util.Collection<? extends Vertex> vertices)

Parameters:

vertices - vertices that represent a graph to create a computable graph from.