dimod.Initialized.parse_initial_states

Initialized.parse_initial_states(bqm: dimod.binary.binary_quadratic_model.BinaryQuadraticModel, initial_states: Optional[Union[Sequence[Union[float, numpy.floating, numpy.integer]], Mapping[Hashable, Union[float, numpy.floating, numpy.integer]], Tuple[Sequence[Union[float, numpy.floating, numpy.integer]], Sequence[Hashable]], Tuple[numpy.ndarray, Sequence[Hashable]], numpy.ndarray, Sequence[Sequence[Union[float, numpy.floating, numpy.integer]]], Tuple[Sequence[Sequence[Union[float, numpy.floating, numpy.integer]]], Sequence[Hashable]], Sequence[Union[Sequence[Union[float, numpy.floating, numpy.integer]], Mapping[Hashable, Union[float, numpy.floating, numpy.integer]], Tuple[Sequence[Union[float, numpy.floating, numpy.integer]], Sequence[Hashable]], Tuple[numpy.ndarray, Sequence[Hashable]], numpy.ndarray]], Iterator[Union[Sequence[Union[float, numpy.floating, numpy.integer]], Mapping[Hashable, Union[float, numpy.floating, numpy.integer]], Tuple[Sequence[Union[float, numpy.floating, numpy.integer]], Sequence[Hashable]], Tuple[numpy.ndarray, Sequence[Hashable]], numpy.ndarray]]]] = None, initial_states_generator: str = 'random', num_reads: Optional[int] = None, seed: Optional[int] = None, copy_always: bool = False) → dimod.core.initialized.ParsedInputs[source]

Parse or generate initial states for an initialized sampler.

Parameters

  • bqm – Binary quadratic model.

  • initial_states (samples-like) – One or more samples, each defining an initial state for all the problem variables. Initial states are given one per read, but if fewer than num_reads initial states are defined, additional values are generated as specified by initial_states_generator. See func:dimod.as_samples for a description of “samples-like”.

  • initial_states_generator –

    Defines the expansion of initial_states if fewer than num_reads are specified:

    • ”none”:

      If the number of initial states specified is smaller than num_reads, raises ValueError.

    • ”tile”:

      Reuses the specified initial states if fewer than num_reads or truncates if greater.

    • ”random”:

      Expands the specified initial states with randomly generated states if fewer than num_reads or truncates if greater.

  • num_reads – Number of reads. Defaults to the number of initial states, if initial_states is specified, or to 1, if not.

  • seed – 32-bit unsigned integer seed to use for the PRNG. Specifying a particular seed with a constant set of parameters produces identical results. If not provided, a random seed is chosen.

  • copy_always – If True, initial_states is always copied; otherwise it is copied only if necessary.

Returns

A named tuple with ['initial_states', 'initial_states_generator', 'num_reads', 'seed'] as generated by this function.