Parameter

class pharmpy.model.Parameter(name, init, lower=-inf, upper=inf, fix=False)

Bases: Immutable

A single parameter

Example

>>> from pharmpy.model import Parameter
>>> param = Parameter("TVCL", 0.005, lower=0.0)
>>> param.init
0.005

Parameters:

• name (str) – Name of the parameter

• init (number) – Initial estimate or simply the value of parameter.

• fix (bool) – A boolean to indicate whether the parameter is fixed or not. Note that fixing a parameter will keep its bounds even if a fixed parameter is actually constrained to one single value. This is so that unfixing will take back the previous bounds.

• lower (float) – The lower bound of the parameter. Default no bound. Must be less than the init.

• upper (float) – The upper bound of the parameter. Default no bound. Must be greater than the init.

Attributes Summary

fix	Should parameter be fixed or not
init	Initial parameter estimate or value
lower	Lower bound of the parameter
name	Parameter name
symbol	Symbol representing the parameter
upper	Upper bound of the parameter

Methods Summary

create(name, init[, lower, upper, fix])	Alternative constructor for Parameter with error checking
from_dict(d)
replace(**kwargs)	Replace properties and create a new Parameter
to_dict()

Attributes Documentation

fix

Should parameter be fixed or not

init

Initial parameter estimate or value

lower

Lower bound of the parameter

name

Parameter name

symbol

Symbol representing the parameter

upper

Upper bound of the parameter

Methods Documentation

classmethod create(name, init, lower=None, upper=None, fix=False)

Alternative constructor for Parameter with error checking

classmethod from_dict(d)

replace(**kwargs)

Replace properties and create a new Parameter

to_dict()