hyperiax.models package

Subpackages

• hyperiax.models.functional package
  • Submodules
  • hyperiax.models.functional.reducers module
    • sum_fuse_children()
  • hyperiax.models.functional.shortup module
    • pass_up()
  • Module contents
• hyperiax.models.prebuilts package
  • Submodules
  • hyperiax.models.prebuilts.mean_estimation module
    • PhyloMeanModel
      • PhyloMeanModel.transform()
      • PhyloMeanModel.up()
  • Module contents

Submodules

hyperiax.models.basemodel module

class hyperiax.models.basemodel.BaseModel

Bases: ABC

class hyperiax.models.basemodel.ReducerModel(reductions)

Bases: BaseModel

hyperiax.models.lambdamodels module

class hyperiax.models.lambdamodels.DownLambda(down_fn)

Bases: DownModel

Lambda model that only contains a down interface

:param DownModel Requires a down function.

down(*args, **kwargs)

Down function to define values to fuse function :return: input arguments to fuse function

class hyperiax.models.lambdamodels.UpLambda(up_fn)

Bases: UpModel

Lambda model that only contains an upward interface

up(*args, **kwargs)

Up function to calculate the upward action on the tree :return: calculated values from child and current values

class hyperiax.models.lambdamodels.UpLambdaReducer(up_fn, transform_fn, reductions)

Bases: UpReducer

Lambda model that only contains an up interface

Parameters:

UpModel – Requires an up and fuse function.

transform(*args, **kwargs)

Fuse function to define calculations from up parameters :return: calculated values from up parameters to parent node

up(*args, **kwargs)

Up function to define values to fuse function :return: input arguments to fuse function

class hyperiax.models.lambdamodels.UpdateLambda(update_fn)

Bases: UpdateModel

Lambda model that only contains a local update interface

Parameters:

UpdateModel – Requires an update function.

update(*args, **kwargs)

update function to define calculations from up parameters :return: calculated values from child and parent parameters

class hyperiax.models.lambdamodels.UpdateLambdaReducer(up_fn, update_fn, reductions)

Bases: UpdateReducer

Lambda model that only contains a local update interface

Parameters:

UpdateModel – Requires an update function.

up(*args, **kwargs)

Up function to define values to fuse function :return: input arguments to fuse function

update(*args, **kwargs)

Fuse function to define calculations from up parameters :return: calculated values from up parameters to parent node

hyperiax.models.updatemodel module

class hyperiax.models.updatemodel.UpdateModel

Bases: BaseModel

abstract update(**kwargs)

class hyperiax.models.updatemodel.UpdateReducer(reductions)

Bases: ReducerModel

abstract up(**kwargs)

abstract update(**kwargs)

hyperiax.models.updownmodel module

class hyperiax.models.updownmodel.DownModel

Bases: BaseModel

abstract down(**kwargs)

class hyperiax.models.updownmodel.UpModel

Bases: BaseModel

abstract up(**kwargs)

class hyperiax.models.updownmodel.UpReducer(reductions)

Bases: ReducerModel

abstract transform(**kwargs)

abstract up(**kwargs)

Module contents