DeploymentDetailsHelper
Bases: Object
Helper to share deployment details with the user and the algorithm, see IResultHandler.add_deployment_detail
add(key: str, value: str) -> None
Adds or updates a deployment detail entry on the result handler loaded in the Composer, if any. Key value pairs the brokerage, data queue handler or any other component wants to share with the user, through the results, and the algorithm, for example account information. Sensitive data, like credentials, should never be added
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
The deployment detail key |
required |
value
|
str
|
The deployment detail value |
required |