ptyrad.params

Pydantic schema models for filling defaults, and validating entries from PtyRAD params files

ptyrad.params.load_params(file_path, validate=True)

Parameters:

• file_path (str)

• validate (bool)

Modules

constraint_params	Defines available options and validation rules for the constraint_params dictionary.
hypertune_params	Defines available options and validation rules for the hypertune_params dictionary.
init_params	Defines available options and validation rules for the init_params dictionary.
loss_params	Defines available options and validation rules for the loss_params dictionary.
model_params	Defines available options and validation rules for the model_params dictionary.
parser	Params files parsing functions
ptyrad_params	Defines the integrated pydantic model PtyRADParams used for default filling and validation of PtyRAD params files
recon_params	Defines available options and validation rules for the recon_params dictionary.