Method
describeCustomLossFunction GET
Copy GET

Retrieve a full description of a previously registered custom loss function.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes name str Registered name of the custom loss function.
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 CustomLossFunction
KEY TYPE Description
notebookId str The unique identifier of the notebook used to create/edit the loss function.
name str Name assigned to the custom loss function.
createdAt str When the loss function was created.
lossFunctionName str The name of the function defined in the source code.
lossFunctionType str The category of problems that this loss would be applicable to, e.g. regression, multi-label classification, etc.
codeSource CodeSource Information about the source code of the loss function.
KEY TYPE Description
sourceType str The type of the source, one of TEXT, PYTHON, FILE_UPLOAD, or APPLICATION_CONNECTOR
sourceCode str If the type of the source is TEXT, the raw text of the function
applicationConnectorId str The Application Connector to fetch the code from
applicationConnectorInfo str Args passed to the application connector to fetch the code
packageRequirements list The pip package dependencies required to run the code
status str The status of the code and validations
error str If the status is failed, an error message describing what went wrong
publishingMsg dict Warnings in the source code
moduleDependencies list The list of internal modules dependencies required to run the code

Exceptions:

TYPE WHEN
InvalidParameterError

If the loss function name is invalid.
DataNotFoundError

If a loss function with the given name is not found in the organization.
Language:

© Copyright