netket.experimental.nn.rnn.ensure_prev_neighbors

netket.experimental.nn.rnn.ensure_prev_neighbors(*, reorder_idx=None, inv_reorder_idx=None, prev_neighbors=None, graph=None, check=False)

Deduce the missing arguments between reorder_idx, inv_reorder_idx, and inv_reorder_idx from the specified arguments.

See netket.experimental.models.RNN for details about the reordering indices.

If no information on neighbors or graph is provided, assumes a 1D ordering.

Parameters:

• reorder_idx (HashableArray | None) – indices to transform the inputs from unordered to ordered. See netket.models.AbstractARNN.reorder() for details

• inv_reorder_idx (HashableArray | None) – indices to transform the inputs from ordered to unordered. See netket.models.AbstractARNN.reorder() for details.

• prev_neighbors (HashableArray | None) – previous neighbors of each site.

• graph (AbstractGraph) – graph of the physical system, to deduce neighbors.

• check (bool) – check the validity of the provided values.

Return type:

tuple[HashableArray, HashableArray, HashableArray]