bayesline.api.equity.MCapFilterSettings

bayesline.api.equity.MCapFilterSettings#

model MCapFilterSettings#

Specify the lower and upper bound for the market cap filter.

By default the bounds are infinite.

Fields#

Field

Type

Required

Default

Constraints

lower

float

No

0.0

ge=0

upper

float

No

1e+20

gt=0.0, ge=0
Validators#

Validator

Mode

Fields

check_upper_gt_lower

after

model
field lower: float [Optional]#

Lower bound of the cap filter in USD.

Constraints:

  • ge = 0

Validated by:

check_upper_gt_lower

field upper: float [Optional]#

Upper bound of the cap filter in USD.

Constraints:

  • gt = 0.0

  • ge = 0

Validated by:

check_upper_gt_lower

validator check_upper_gt_lower(mode=after)#

Validate that the upper bound is greater than the lower bound. Returns ——- MCapFilterSettings The validated instance. Raises —— ValueError If the upper bound is not greater than the lower bound.

Validates:

entire model