nip.parameters.protocol.MnipProtocolParameters

class nip.parameters.protocol.MnipProtocolParameters(max_message_rounds: int = 8, min_message_rounds: int = 1, sequential: bool = False, prover0_first: bool = True, randomize_channel_order: bool = True)

Additional parameters for the MNIP interaction protocol.

Parameters:

• max_message_rounds (int) – The maximum number of rounds of the game. Each round corresponds to one move by one or more agents.

• min_message_rounds (int) – The minimum number of rounds of messages. Before this point, the verifier’s guesses are not registered.

• sequential (bool) – Whether the provers send messages one after the other, or both simultaneously.

• prover0_first (bool) – When the provers send messages sequentially, whether prover 0 goes first.

• randomize_channel_order (bool) – Whether to randomize the order of the channels when prompting the verifier. Only relevant in text-based protocols.

Methods Summary

__eq__(other)	Return self==value.
__init__([max_message_rounds, ...])
__post_init__()
__repr__()	Return repr(self).
_get_param_class_from_dict(param_dict)	Try to get the parameter class from a dictionary of serialised parameters.
construct_test_params()	Construct a set of basic parameters for testing.
from_dict(params_dict[, ignore_extra_keys])	Create a parameters object from a dictionary.
get(address)	Get a value from the parameters object using a dot-separated address.
to_dict()	Convert the parameters object to a dictionary.

Attributes

max_message_rounds
min_message_rounds
prover0_first
randomize_channel_order
sequential

Methods

__eq__(other)

Return self==value.

__init__(max_message_rounds: int = 8, min_message_rounds: int = 1, sequential: bool = False, prover0_first: bool = True, randomize_channel_order: bool = True) → None

__post_init__()

__repr__()

Return repr(self).

classmethod _get_param_class_from_dict(param_dict: dict) → type[ParameterValue] | None

Try to get the parameter class from a dictionary of serialised parameters.

Parameters:

param_dict (dict) – A dictionary of parameters, which may have come from a to_dict method. This dictionary may contain a _type key, which is used to determine the class of the parameter.

Returns:

param_class (type[ParameterValue] | None) – The class of the parameter, if it can be determined.

Raises:

ValueError – If the class specified in the dictionary is not a valid parameter class.

classmethod construct_test_params() → BaseHyperParameters

Construct a set of basic parameters for testing.

classmethod from_dict(params_dict: dict, ignore_extra_keys: bool = False) → BaseHyperParameters

Create a parameters object from a dictionary.

Parameters:

• params_dict (dict) – A dictionary of the parameters.

• ignore_extra_keys (bool, default=False) – If True, ignore keys in the dictionary that do not correspond to fields in the parameters object.

Returns:

hyper_params (BaseParameters) – The parameters object.

get(address: str) → Any

Get a value from the parameters object using a dot-separated address.

Parameters:

address (str) – The path to the value in the parameters object, separated by dots.

Returns:

value (Any) – The value at the address.

Raises:

KeyError – If the address does not exist.

to_dict() → dict

Convert the parameters object to a dictionary.

Turns enums into strings, and sub-parameters into dictionaries. Includes the is_random parameter if it exists.

Returns:

params_dict (dict) – A dictionary of the parameters.