<commit_before>.. _semi_stoch_table:

semi_stoch options
==================

The semi-stochastic approach [Petruzielo12]_, [Blunt15]_ divides the Hilbert space into two regions: a small region in
which the action of the Hamiltonian is applied exactly, and the remainder of the Hilbert
space, in which the action is applied stochastically.  This can substantially reduce the
stochastic error in many cases.

``space``
    type: string.

    Required.

    Possible values: 'read', 'high'.

    The type of deterministic space to use.  Using 'read' uses a deterministic space
    produced from a previous calculation and saved to file using the semi_stoch 
    ``write`` option (the ``write_determ_space`` can be used but is now deprecated).
    Using 'high' sets the deterministic space to consist of the states with
    the highest population when the semi-stochastic projection is enabled.
``size``
    type: integer.

    Required if ``space`` is 'high', otherwise ignored.

    The number of states to include in the semi-stochastic space.
``start_iteration``
    type: integer.

    Optional.  Default: 1.

    The number of iterations to perform, during which the action of the Hamiltonian is
    applied entirely stochastically, before semi-stochastic projection is enabled.  This
    allows for a period for the population to grow and the ground-state wavefunction to
    emerge before the deterministic space is selected.
``shift_start_iteration``
    type: integer.

    Optional.  Default: None.  Overrides ``start_iteration``.

    The number of iterations to perform after the shift is varied (i.e. after the
    ``target_population`` is reached) before the semi-stochastic projection is enabled.
``separate_annihilation``
    type: boolean.

    Optional.  Default: true.

    If true, the deterministic amplitudes are communicated separately at the cost of an
    additional MPI call.  If false, the annihilation of particles created from
    deterministic and stochastic projections are performed separately, which removes the<commit_msg>Correct statement about separate_annihilation option in semi_stoch docs.<commit_after>.. _semi_stoch_table:

semi_stoch options
==================

The semi-stochastic approach [Petruzielo12]_, [Blunt15]_ divides the Hilbert space into two regions: a small region in
which the action of the Hamiltonian is applied exactly, and the remainder of the Hilbert
space, in which the action is applied stochastically.  This can substantially reduce the
stochastic error in many cases.

``space``
    type: string.

    Required.

    Possible values: 'read', 'high'.

    The type of deterministic space to use.  Using 'read' uses a deterministic space
    produced from a previous calculation and saved to file using the semi_stoch 
    ``write`` option (the ``write_determ_space`` can be used but is now deprecated).
    Using 'high' sets the deterministic space to consist of the states with
    the highest population when the semi-stochastic projection is enabled.
``size``
    type: integer.

    Required if ``space`` is 'high', otherwise ignored.

    The number of states to include in the semi-stochastic space.
``start_iteration``
    type: integer.

    Optional.  Default: 1.

    The number of iterations to perform, during which the action of the Hamiltonian is
    applied entirely stochastically, before semi-stochastic projection is enabled.  This
    allows for a period for the population to grow and the ground-state wavefunction to
    emerge before the deterministic space is selected.
``shift_start_iteration``
    type: integer.

    Optional.  Default: None.  Overrides ``start_iteration``.

    The number of iterations to perform after the shift is varied (i.e. after the
    ``target_population`` is reached) before the semi-stochastic projection is enabled.
``separate_annihilation``
    type: boolean.

    Optional.  Default: true.

    If true, the deterministic amplitudes are communicated separately at the cost of an
    additional MPI call.  If false, the annihilation of particles created from
    deterministic and stochastic projections are performed together, which removes the
{'fraction_non_alphanumeric': 0.06509728561133797, 'fraction_numerical': 0.0024021138601969735, 'mean_word_length': 3.8930669800235016, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '126672', 'n_tokens_mistral': 1097, 'n_tokens_neox': 1006, 'n_words': 524}