pycmtensor.models.MNL#

Module Contents#

class pycmtensor.models.MNL.MNL(db, params: Dict, utility: Union[list[aesara.tensor.var.TensorVariable], aesara.tensor.var.TensorVariable], av: List[aesara.tensor.var.TensorVariable] = None, **kwargs)[source]#

Bases: pycmtensor.pycmtensor.PyCMTensorModel

Defines a Multinomial Logit model

Parameters:

  • db (pycmtensor.Data) – the database object

  • params (dict) – dictionary of parameters

  • utility (list or TensorVariable) – the vector of utility functions

  • av (list, optional) – list of availability conditions. If None, all availability is set to 1

  • **kwargs – keyword arguments. Possible options are optimizer: pycmtensor.optimizer=Adam set the optimizer to use. see pycmtensor.optimizer for available options.