Skip to content

FeatureDefinition

Source code in docs_src/capo_sagemaker/types/feature_definition.py 
14
15
16
17
18
19
20
21
22
23
24
class FeatureDefinition(TypedDict, closed=True):
    feature_name: NotRequired["capo_sagemaker.types.feature_name.FeatureName"]
    """<p>The name of a feature. The type must be a string. <code>FeatureName</code> cannot be any of the following: <code>is_deleted</code>, <code>write_time</code>, <code>api_invocation_time</code>.</p> <p>The name:</p> <ul> <li> <p>Must start with an alphanumeric character.</p> </li> <li> <p>Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.</p> </li> </ul>"""
    feature_type: NotRequired["capo_sagemaker.types.feature_type.FeatureType"]
    """<p>The value type of a feature. Valid values are Integral, Fractional, or String.</p>"""
    collection_type: NotRequired["capo_sagemaker.types.collection_type.CollectionType"]
    """<p>A grouping of elements where each element within the collection must have the same feature type (<code>String</code>, <code>Integral</code>, or <code>Fractional</code>).</p> <ul> <li> <p> <code>List</code>: An ordered collection of elements.</p> </li> <li> <p> <code>Set</code>: An unordered collection of unique elements.</p> </li> <li> <p> <code>Vector</code>: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types. </p> </li> </ul>"""
    collection_config: NotRequired[
        "capo_sagemaker.types.collection_config.CollectionConfig"
    ]
    """<p>Configuration for your collection.</p>"""

collection_config instance-attribute 

collection_config: NotRequired[CollectionConfig]

Configuration for your collection.

collection_type instance-attribute 

collection_type: NotRequired[CollectionType]

A grouping of elements where each element within the collection must have the same feature type (String, Integral, or Fractional).

  • List: An ordered collection of elements.

  • Set: An unordered collection of unique elements.

  • Vector: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types.

feature_name instance-attribute 

feature_name: NotRequired[FeatureName]

The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time.

The name:

  • Must start with an alphanumeric character.

  • Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.

feature_type instance-attribute 

feature_type: NotRequired[FeatureType]

The value type of a feature. Valid values are Integral, Fractional, or String.