Skip to content

Commit

Permalink
minor edits sim_ber docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
SebastianCa authored Dec 21, 2023
1 parent 6a06278 commit cf745b4
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions sionna/utils/misc.py
Original file line number Diff line number Diff line change
Expand Up @@ -498,19 +498,18 @@ def sim_ber(mc_fun,
If `False`, the simulation ends and returns the intermediate simulation
results.
callback: callable Defaults to `None`. If specified, ``callback``
will be called after each Monte-Carlo step. Can be used for
logging or advanced early stopping. Input signature of
``callback`` must match `callback(mc_iter, esno_idx, ebno_dbs,
bit_errors, block_errors, nb_bits, nb_blocks)` where
``mc_iter`` denotes the number of processed batches for the
current SNR, ``esno_idx`` is the index of the current esno
step, ``ebno_dbs`` is the vector of all SNR points,
``bit_errors`` the vector of number of bit errors for each
esno step, ``block_errors`` the vector of number of block
errors, ``nb_bits`` the vector of number of simulated bits,
``nb_blocks`` the vector of number of simulated blocks. If
``callable`` returns `sim_ber.CALLBACK_NEXT_SNR`, early
callback: `None` (default) | callable
If specified, ``callback`` will be called after each Monte-Carlo step.
Can be used for logging or advanced early stopping. Input signature of
``callback`` must match `callback(mc_iter, snr_idx, ebno_dbs,
bit_errors, block_errors, nb_bits, nb_blocks)` where ``mc_iter``
denotes the number of processed batches for the current SNR point,
``snr_idx`` is the index of the current SNR point, ``ebno_dbs`` is the
vector of all SNR points to be evaluated, ``bit_errors`` the vector of
number of bit errors for each SNR point, ``block_errors`` the vector of
number of block errors, ``nb_bits`` the vector of number of simulated
bits, ``nb_blocks`` the vector of number of simulated blocks,
respectively. If ``callable`` returns `sim_ber.CALLBACK_NEXT_SNR`, early
stopping is detected and the simulation will continue with the
next SNR point. If ``callable`` returns
`sim_ber.CALLBACK_STOP`, the simulation is stopped
Expand Down

0 comments on commit cf745b4

Please sign in to comment.