Skip to content

Utilties

Common helper functions for working with algorithms.

get_all_parameters(transmitters, receivers)

Get the parameters for multiple devices to enable joint optimization.

The parameters must be defined as a single iterator to be used with torch.optim.

Parameters:

Name Type Description Default
transmitters Iterable[Transmitter]

Transmitters to get parameters from.

required
receivers Iterable[Receiver]

Receivers to get parameters from.

required

Returns:

Type Description
Generator[Parameter, None, None]

Parameters for all devices as a single iterator.

get_random_bits(n_bits, batch_size=1)

Output a random packet of bits.

Parameters:

Name Type Description Default
n_bits int

How many bits to output per batch.

required
batch_size int

How many batches to create.

1

Returns:

Type Description
Tensor

An 0-1 integer valued tensor with shape [batch_size, n_bits].