abacusai.use_case_requirements

Classes

UseCaseRequirements

Use Case Requirements

Module Contents

class abacusai.use_case_requirements.UseCaseRequirements(client, datasetType=None, name=None, description=None, required=None, multi=None, allowedFeatureMappings=None, allowedNestedFeatureMappings=None)

Bases: abacusai.return_class.AbstractApiClass

Use Case Requirements

Parameters:

  • client (ApiClient) – An authenticated API Client instance

  • datasetType (str) – The project-specific enum value of the dataset type.

  • name (str) – The user-friendly name of the dataset type.

  • description (str) – The description of the dataset type.

  • required (bool) – True if the dataset type is required for this project.

  • multi (bool) – If true, multiple versions of the dataset type can be used for training.

  • allowedFeatureMappings (dict) – A collection of key-value pairs, with each key being a column mapping enum (see a list of column mapping enums here) and each value being in the following dictionary format: { “description”: str, “allowed_feature_types”: feature_type_enum, “required”: bool }.

  • allowedNestedFeatureMappings (dict) – A collection of key-value pairs, with each key being a column mapping enum (see a list of column mapping enums here) and each value being in the following dictionary format: { “description”: str, “allowed_feature_types”: feature_type_enum, “required”: bool }.

dataset_type
name
description
required
multi
allowed_feature_mappings
allowed_nested_feature_mappings
deprecated_keys
__repr__()
to_dict()

Get a dict representation of the parameters in this class

Returns:

The dict value representation of the class parameters

Return type:

dict