abacusai.project_feature_group
==============================

.. py:module:: abacusai.project_feature_group


Classes
-------

.. autoapisummary::

   abacusai.project_feature_group.ProjectFeatureGroup


Module Contents
---------------

.. py:class:: ProjectFeatureGroup(client, featureGroupId=None, modificationLock=None, name=None, featureGroupSourceType=None, tableName=None, sql=None, datasetId=None, functionSourceCode=None, functionName=None, sourceTables=None, createdAt=None, description=None, sqlError=None, latestVersionOutdated=None, referencedFeatureGroups=None, tags=None, primaryKey=None, updateTimestampKey=None, lookupKeys=None, streamingEnabled=None, incremental=None, mergeConfig=None, samplingConfig=None, cpuSize=None, memory=None, streamingReady=None, featureTags=None, moduleName=None, templateBindings=None, featureExpression=None, useOriginalCsvNames=None, pythonFunctionBindings=None, pythonFunctionName=None, useGpu=None, versionLimit=None, exportOnMaterialization=None, featureGroupType=None, features={}, duplicateFeatures={}, pointInTimeGroups={}, annotationConfig={}, concatenationConfig={}, indexingConfig={}, codeSource={}, featureGroupTemplate={}, explanation={}, refreshSchedules={}, exportConnectorConfig={}, projectFeatureGroupSchema={}, projectConfig={}, latestFeatureGroupVersion={}, operatorConfig={})

   Bases: :py:obj:`abacusai.feature_group.FeatureGroup`


   A feature group along with project specific mappings

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param featureGroupId: Unique identifier for this feature group.
   :type featureGroupId: str
   :param modificationLock: If feature group is locked against a change or not.
   :type modificationLock: bool
   :param name:
   :type name: str
   :param featureGroupSourceType: The source type of the feature group
   :type featureGroupSourceType: str
   :param tableName: Unique table name of this feature group.
   :type tableName: str
   :param sql: SQL definition creating this feature group.
   :type sql: str
   :param datasetId: Dataset ID the feature group is sourced from.
   :type datasetId: str
   :param functionSourceCode: Source definition creating this feature group.
   :type functionSourceCode: str
   :param functionName: Function name to execute from the source code.
   :type functionName: str
   :param sourceTables: Source tables for this feature group.
   :type sourceTables: list[str]
   :param createdAt: Timestamp at which the feature group was created.
   :type createdAt: str
   :param description: Description of the feature group.
   :type description: str
   :param sqlError: Error message with this feature group.
   :type sqlError: str
   :param latestVersionOutdated: Is latest materialized feature group version outdated.
   :type latestVersionOutdated: bool
   :param referencedFeatureGroups: Feature groups this feature group is used in.
   :type referencedFeatureGroups: list[str]
   :param tags: Tags added to this feature group.
   :type tags: list[str]
   :param primaryKey: Primary index feature.
   :type primaryKey: str
   :param updateTimestampKey: Primary timestamp feature.
   :type updateTimestampKey: str
   :param lookupKeys: Additional indexed features for this feature group.
   :type lookupKeys: list[str]
   :param streamingEnabled: If true, the feature group can have data streamed to it.
   :type streamingEnabled: bool
   :param incremental: If feature group corresponds to an incremental dataset.
   :type incremental: bool
   :param mergeConfig: Merge configuration settings for the feature group.
   :type mergeConfig: dict
   :param samplingConfig: Sampling configuration for the feature group.
   :type samplingConfig: dict
   :param cpuSize: CPU size specified for the Python feature group.
   :type cpuSize: str
   :param memory: Memory in GB specified for the Python feature group.
   :type memory: int
   :param streamingReady: If true, the feature group is ready to receive streaming data.
   :type streamingReady: bool
   :param featureTags: Tags for features in this feature group
   :type featureTags: dict
   :param moduleName: Path to the file with the feature group function.
   :type moduleName: str
   :param templateBindings: Config specifying variable names and values to use when resolving a feature group template.
   :type templateBindings: dict
   :param featureExpression: If the dataset feature group has custom features, the SQL select expression creating those features.
   :type featureExpression: str
   :param useOriginalCsvNames: If true, the feature group will use the original column names in the source dataset.
   :type useOriginalCsvNames: bool
   :param pythonFunctionBindings: Config specifying variable names, types, and values to use when resolving a Python feature group.
   :type pythonFunctionBindings: dict
   :param pythonFunctionName: Name of the Python function the feature group was built from.
   :type pythonFunctionName: str
   :param useGpu: Whether this feature group is using gpu
   :type useGpu: bool
   :param versionLimit: Version limit for the feature group.
   :type versionLimit: int
   :param exportOnMaterialization: Whether to export the feature group on materialization.
   :type exportOnMaterialization: bool
   :param featureGroupType: Project type when the feature group is used in the context of a project.
   :type featureGroupType: str
   :param features: List of resolved features.
   :type features: Feature
   :param duplicateFeatures: List of duplicate features.
   :type duplicateFeatures: Feature
   :param pointInTimeGroups: List of Point In Time Groups.
   :type pointInTimeGroups: PointInTimeGroup
   :param annotationConfig: Annotation config for this feature
   :type annotationConfig: AnnotationConfig
   :param latestFeatureGroupVersion: Latest feature group version.
   :type latestFeatureGroupVersion: FeatureGroupVersion
   :param concatenationConfig: Feature group ID whose data will be concatenated into this feature group.
   :type concatenationConfig: ConcatenationConfig
   :param indexingConfig: Indexing config for the feature group for feature store
   :type indexingConfig: IndexingConfig
   :param codeSource: If a Python feature group, information on the source code.
   :type codeSource: CodeSource
   :param featureGroupTemplate: FeatureGroupTemplate to use when this feature group is attached to a template.
   :type featureGroupTemplate: FeatureGroupTemplate
   :param explanation: Natural language explanation of the feature group
   :type explanation: NaturalLanguageExplanation
   :param refreshSchedules: List of schedules that determines when the next version of the feature group will be created.
   :type refreshSchedules: RefreshSchedule
   :param exportConnectorConfig: The export config (file connector or database connector information) for feature group exports.
   :type exportConnectorConfig: FeatureGroupRefreshExportConfig
   :param projectFeatureGroupSchema: Project-specific schema for this feature group.
   :type projectFeatureGroupSchema: ProjectFeatureGroupSchema
   :param projectConfig: Project-specific config for this feature group.
   :type projectConfig: ProjectConfig
   :param operatorConfig: Operator configuration settings for the feature group.
   :type operatorConfig: OperatorConfig


   .. py:attribute:: feature_group_id
      :value: None



   .. py:attribute:: modification_lock
      :value: None



   .. py:attribute:: name
      :value: None



   .. py:attribute:: feature_group_source_type
      :value: None



   .. py:attribute:: table_name
      :value: None



   .. py:attribute:: sql
      :value: None



   .. py:attribute:: dataset_id
      :value: None



   .. py:attribute:: function_source_code
      :value: None



   .. py:attribute:: function_name
      :value: None



   .. py:attribute:: source_tables
      :value: None



   .. py:attribute:: created_at
      :value: None



   .. py:attribute:: description
      :value: None



   .. py:attribute:: sql_error
      :value: None



   .. py:attribute:: latest_version_outdated
      :value: None



   .. py:attribute:: referenced_feature_groups
      :value: None



   .. py:attribute:: tags
      :value: None



   .. py:attribute:: primary_key
      :value: None



   .. py:attribute:: update_timestamp_key
      :value: None



   .. py:attribute:: lookup_keys
      :value: None



   .. py:attribute:: streaming_enabled
      :value: None



   .. py:attribute:: incremental
      :value: None



   .. py:attribute:: merge_config
      :value: None



   .. py:attribute:: sampling_config
      :value: None



   .. py:attribute:: cpu_size
      :value: None



   .. py:attribute:: memory
      :value: None



   .. py:attribute:: streaming_ready
      :value: None



   .. py:attribute:: feature_tags
      :value: None



   .. py:attribute:: module_name
      :value: None



   .. py:attribute:: template_bindings
      :value: None



   .. py:attribute:: feature_expression
      :value: None



   .. py:attribute:: use_original_csv_names
      :value: None



   .. py:attribute:: python_function_bindings
      :value: None



   .. py:attribute:: python_function_name
      :value: None



   .. py:attribute:: use_gpu
      :value: None



   .. py:attribute:: version_limit
      :value: None



   .. py:attribute:: export_on_materialization
      :value: None



   .. py:attribute:: feature_group_type
      :value: None



   .. py:attribute:: features


   .. py:attribute:: duplicate_features


   .. py:attribute:: point_in_time_groups


   .. py:attribute:: annotation_config


   .. py:attribute:: concatenation_config


   .. py:attribute:: indexing_config


   .. py:attribute:: code_source


   .. py:attribute:: feature_group_template


   .. py:attribute:: explanation


   .. py:attribute:: refresh_schedules


   .. py:attribute:: export_connector_config


   .. py:attribute:: project_feature_group_schema


   .. py:attribute:: project_config


   .. py:attribute:: latest_feature_group_version


   .. py:attribute:: operator_config


   .. py:attribute:: deprecated_keys


   .. py:method:: __repr__()


   .. py:method:: to_dict()

      Get a dict representation of the parameters in this class

      :returns: The dict value representation of the class parameters
      :rtype: dict



