sdk.algorithm_computation.create()

elements.sdk.api.algorithm_computation

Create an Algorithm Computation.

Create the runnable component in the system, by specifying the Algorithm to be run, the set of AOIs to be run on, and the TOI to specify the recurrence. The Algorithm Computation ID is returned so that it can be run. Note that until an Algorithm Computation has been run, its underlying resources are NOT locked and therefore can be changed.

Parameters

  • algorithm_config_id (str) - Algorithm Config to use in computation
  • aoi_collection_id (str) - AOI Collection to use in computation
  • toi_id (str) - TOI to use in computation

Returns

AlgorithmComputation

Example(s)

# Create an Algorithm Computation
algo_computation = await sdk.algorithm_computation.create(
  algorithm_config_id="a551c228-f283-42d4-899c-aefa2fa1e52d",
  toi_id="12847bf4-2c77-4468-a1ef-dd67566954e3",
  aoi_collection_id="41e3fb68-fa89-4e20-b4d1-2884ef3cb0ce"
)

# Output (AlgorithmComputation)
id: "01d0d2ec-9ed8-4b9e-a9c7-f95dbbc092ff"
aoi_collection_id: "41e3fb68-fa89-4e20-b4d1-2884ef3cb0ce"
algo_config_id: "a551c228-f283-42d4-899c-aefa2fa1e52d"
toi_id: "12847bf4-2c77-4468-a1ef-dd67566954e3"
state: NOT_STARTED