From cf745b4ad11785338981b1e9f617c899440d0f73 Mon Sep 17 00:00:00 2001 From: SebastianCa <18167671+SebastianCa@users.noreply.github.com> Date: Thu, 21 Dec 2023 14:51:08 +0100 Subject: [PATCH] minor edits sim_ber docstring --- sionna/utils/misc.py | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/sionna/utils/misc.py b/sionna/utils/misc.py index 4db99293..6873ae02 100644 --- a/sionna/utils/misc.py +++ b/sionna/utils/misc.py @@ -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