sagemaker.core.jumpstart.filters

This module stores filters related to SageMaker JumpStart.

Functions

evaluate_filter_expression(model_filter, ...)	Evaluates model filter with cached model spec value, returns boolean.
parse_filter_string(filter_string)	Parse filter string and return a serialized ModelFilter object.

Classes

And(*operands)	And operator class for filtering JumpStart content.
BooleanValues(value)	Enum class for boolean values.
Constant(constant)	Constant operator class for filtering JumpStart content.
FilterOperators(value)	Enum class for filter operators for JumpStart models.
Identity(operand)	Identity operator class for filtering JumpStart content.
ModelFilter(key, value, operator)	Data holder class to store model filters.
Not(operand)	Not operator class for filtering JumpStart content.
Operand(unresolved_value[, resolved_value])	Operand class for filtering JumpStart content.
Operator([resolved_value, unresolved_value])	Operator class for filtering JumpStart content.
Or(*operands)	Or operator class for filtering JumpStart content.
ProprietaryModelFilterIdentifiers(value)	Enum class for proprietary model filter keys.
SpecialSupportedFilterKeys(value)	Enum class for special supported filter keys.

class sagemaker.core.jumpstart.filters.And(*operands: Operand | str)

Bases: Operator

And operator class for filtering JumpStart content.

eval() → None

Evaluates operator.

Raises:

RuntimeError – If the operands remain unevaluated after calling eval, or if the resolved value isn’t a BooleanValues type.

class sagemaker.core.jumpstart.filters.BooleanValues(value)

Bases: str, Enum

Enum class for boolean values.

This is a status value that an Operand can resolve to.

FALSE = 'false'

TRUE = 'true'

UNEVALUATED = 'unevaluated'

UNKNOWN = 'unknown'

class sagemaker.core.jumpstart.filters.Constant(constant: BooleanValues)

Bases: Operator

Constant operator class for filtering JumpStart content.

eval() → None

Evaluates constant

class sagemaker.core.jumpstart.filters.FilterOperators(value)

Bases: str, Enum

Enum class for filter operators for JumpStart models.

BEGINS_WITH = 'begins_with'

ENDS_WITH = 'ends_with'

EQUALS = 'equals'

IN = 'in'

INCLUDES = 'includes'

NOT_EQUALS = 'not_equals'

NOT_IN = 'not_in'

NOT_INCLUDES = 'not_includes'

class sagemaker.core.jumpstart.filters.Identity(operand: Operand | str)

Bases: Operator

Identity operator class for filtering JumpStart content.

eval() → None

Evaluates operator.

Raises:

RuntimeError – If the operand remains unevaluated after calling eval, or if the resolved value isn’t a BooleanValues type.

class sagemaker.core.jumpstart.filters.ModelFilter(key: str, value: str, operator: str)

Bases: JumpStartDataHolderType

Data holder class to store model filters.

For a given filter string “task == ic”, the key corresponds to “task” and the value corresponds to “ic”, with the operation being “==”.

key

operator

set_key(key: str) → None

Sets the key for the model filter.

Parameters:

key (str) – The key to be set.

set_value(value: str) → None

Sets the value for the model filter.

Parameters:

value (str) – The value to be set.

value

class sagemaker.core.jumpstart.filters.Not(operand: Operand | str)

Bases: Operator

Not operator class for filtering JumpStart content.

eval() → None

Evaluates operator.

Raises:

RuntimeError – If the operand remains unevaluated after calling eval, or if the resolved value isn’t a BooleanValues type.

class sagemaker.core.jumpstart.filters.Operand(unresolved_value: Any, resolved_value: BooleanValues = BooleanValues.UNEVALUATED)

Bases: object

Operand class for filtering JumpStart content.

eval() → None

Evaluates operand.

property resolved_value: BooleanValues

Getter method for resolved_value.

static validate_operand(operand: Any) → Any

Validate operand and return Operand object.

Parameters:

operand (Any) – The operand to validate.

Raises:

RuntimeError – If the operand is not of Operand or str type.

class sagemaker.core.jumpstart.filters.Operator(resolved_value: BooleanValues = BooleanValues.UNEVALUATED, unresolved_value: Any | None = None)

Bases: Operand

Operator class for filtering JumpStart content.

An operator in this case corresponds to an operand that is also an operation. For example, given the expression (True or True) and True, (True or True) is an operand to an And expression, but is also itself an operator. (True or True) and True would also be considered an operator.

eval() → None

Evaluates operator.

class sagemaker.core.jumpstart.filters.Or(*operands: Operand | str)

Bases: Operator

Or operator class for filtering JumpStart content.

eval() → None

Evaluates operator.

Raises:

RuntimeError – If the operands remain unevaluated after calling eval, or if the resolved value isn’t a BooleanValues type.

class sagemaker.core.jumpstart.filters.ProprietaryModelFilterIdentifiers(value)

Bases: str, Enum

Enum class for proprietary model filter keys.

MARKETPLACE = 'marketplace'

PROPRIETARY = 'proprietary'

class sagemaker.core.jumpstart.filters.SpecialSupportedFilterKeys(value)

Bases: str, Enum

Enum class for special supported filter keys.

FRAMEWORK = 'framework'

MODEL_TYPE = 'model_type'

TASK = 'task'

sagemaker.core.jumpstart.filters.evaluate_filter_expression(model_filter: ModelFilter, cached_model_value: str | bool | int | float | Dict[str, Any] | List[Any] | None) → BooleanValues

Evaluates model filter with cached model spec value, returns boolean.

Parameters:

• model_filter (ModelFilter) – The model filter for evaluation.

• cached_model_value (Any) – The value in the model manifest/spec that should be used to evaluate the filter.

sagemaker.core.jumpstart.filters.parse_filter_string(filter_string: str) → ModelFilter

Parse filter string and return a serialized ModelFilter object.

Parameters:

filter_string (str) – The filter string to be serialized to an object.