pystruct.models.LatentNodeCRF

class pystruct.models.LatentNodeCRF(n_labels=2, n_features=None, n_hidden_states=2, inference_method='lp', class_weight=None, latent_node_features=False)

CRF with latent variables.

Input x is tuple (features, edges, n_hidden) First features.shape[0] nodes are observed, then n_hidden unobserved nodes.

Currently unobserved nodes don’t have features.

Parameters :

n_labels : int, default=2

Number of states for observed variables.

n_hidden_states : int, default=2

Number of states for hidden variables.

n_features : int, default=None

Number of features per node. None means n_states.

inference_method : string, default=”lp”

Function to call to do inference and loss-augmented inference. Possible values are:

• ‘qpbo’ for QPBO + alpha expansion.
• ‘dai’ for LibDAI bindings (which has another parameter).
• ‘lp’ for Linear Programming relaxation using GLPK.
• ‘ad3’ for AD3 dual decomposition.

class_weight : None, or array-like

Class weights. If an array-like is passed, it must have length n_classes. None means equal class weights.

latent_node_features : bool, default=False

Whether latent nodes have features. We assume that if True, the number of features is the same as for visible nodes.

Methods

base_loss(y, y_hat)
batch_inference(X, w[, relaxed])
batch_loss(Y, Y_hat)
batch_loss_augmented_inference(X, Y, w[, ...])
batch_psi(X, Y[, Y_true])
continuous_loss(y, y_hat)
get_edges(x)
get_features(x)
get_pairwise_potentials(x, w)	Computes pairwise potentials for x and w.
get_unary_potentials(x, w)	Computes unary potentials for x and w.
inference(x, w[, relaxed, return_energy])	Inference for x using parameters w.
init_latent(X, Y)
label_from_latent(h)
latent(x, y, w)
loss(h, h_hat)
loss_augmented_inference(x, h, w[, relaxed, ...])
max_loss(h)
psi(x, y)	Feature vector associated with instance (x, y).

__init__(n_labels=2, n_features=None, n_hidden_states=2, inference_method='lp', class_weight=None, latent_node_features=False)

get_pairwise_potentials(x, w)

Computes pairwise potentials for x and w.

Parameters :

x : tuple

Instance Representation.

w : ndarray, shape=(size_psi,)

Weight vector for CRF instance.

Returns :

pairwise : ndarray, shape=(n_states, n_states)

Pairwise weights.

get_unary_potentials(x, w)

Computes unary potentials for x and w.

Parameters :

x : tuple

Instance Representation.

w : ndarray, shape=(size_psi,)

Weight vector for CRF instance.

Returns :

unary : ndarray, shape=(n_states)

Unary weights.

inference(x, w, relaxed=False, return_energy=False)

Inference for x using parameters w.

Finds (approximately) armin_y np.dot(w, psi(x, y)) using self.inference_method.

Parameters :

x : tuple

Instance of a graph with unary evidence. x=(unaries, edges) unaries are an nd-array of shape (n_nodes, n_states), edges are an nd-array of shape (n_edges, 2)

w : ndarray, shape=(size_psi,)

Parameters for the CRF energy function.

relaxed : bool, default=False

Whether relaxed inference should be performed. Only meaningful if inference method is ‘lp’ or ‘ad3’. By default fractional solutions are rounded. If relaxed=True, fractional solutions are returned directly.

return_energy : bool, default=False

Whether to return the energy of the solution (x, y) that was found.

Returns :

y_pred : ndarray or tuple

By default an inter ndarray of shape=(width, height) of variable assignments for x is returned. If relaxed=True and inference_method is lp or ad3, a tuple (unary_marginals, pairwise_marginals) containing the relaxed inference result is returned. unary marginals is an array of shape (width, height, n_states), pairwise_marginals is an array of shape (n_states, n_states) of accumulated pairwise marginals.

psi(x, y)

Feature vector associated with instance (x, y).

Feature representation psi, such that the energy of the configuration (x, y) and a weight vector w is given by np.dot(w, psi(x, y)).

Parameters :

x : tuple

Unary evidence.

y : ndarray or tuple

Either y is an integral ndarray, giving a complete labeling for x. Or it is the result of a linear programming relaxation. In this case, y=(unary_marginals, pariwise_marginals).

Returns :

p : ndarray, shape (size_psi,)

Feature vector associated with state (x, y).