Method
getCustomTrainFunctionInfo POST
Copy POST

Returns information about how to call the custom train function.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes projectId str The unique version ID of the project.
No featureGroupNamesForTraining List[str] A list of feature group table names to be used for training.
No trainingDataParameterNameOverride dict Override from feature group type to parameter name in the train function.
No trainingConfig TrainingConfig Training config for the options supported by the Abacus.AI platform.
KEY TYPE Description
ALGORITHM None None
_SUPPORT_KWARGS None None
_UPPER_SNAKE_CASE_KEYS None None
PROBLEM_TYPE None None
KWARGS None None
No customAlgorithmConfig Any User-defined config that can be serialized by JSON.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result CustomTrainFunctionInfo
KEY TYPE Description
trainingDataParameterNameMapping dict The mapping from feature group type to the dataframe parameter name
schemaMappings dict The feature type to feature name mapping for each dataframe
trainDataParameterToFeatureGroupIds dict The mapping from the dataframe parameter name to the feature group id backing the data
trainingConfig dict The configs for training

Exceptions:

TYPE WHEN
DataNotFoundError

projectId is not found.

ConflictError

Could not figure out a table name for the required feature group type.

InvalidParameterError

If the feature group name does not exist.

Language: