sdk.algorithm_version.get()

Retrieve an Algorithm Version.

Get the details for a specific Algorithm Version. By default it does not include the Algorithm Manifest. Setting include_manifest to true, will also include the manifest in the response for each requested Algorithm Version.

Parameters

algorithm_version_ids (List[str]) - list of Algorithm Version IDs to return details for
[Optional] pagination (Pagination) - Pagination object only with page size field set

Returns

List[AlgorithmVersions]

Example(s)

# Returns details from the list of algorithm_version_ids
await sdk.algorithm_version.get(["690abea1-776c-4f33-843a-a51ed9fde281"])

# Output (List[AlgorithmVersion])
[
  {
    "algorithm": {
        "author": "[email protected]",
        "displayName": "Heatmap",
        "id": "389fa76f-1128-413f-afa6-81d2f86782b0",
        "name": "heatmap-ad31e2c6"
    },
    "createdOn": "2022-10-26T19:14:07.876Z",
    "id": "690abea1-776c-4f33-843a-a51ed9fde281",
    "manifest": {
        "container_parameters": {
            "command": [
                "python",
                "/orbital/base/algorithms/traceability_heatmap/src/py/traceability_heatmap/traceability_heatmap.py"
            ],
            "image": "orbitalinsight/traceability_heatmap:cd1ca4a0",
            "resource_request": {
                "cpu_millicore": 200.0,
                "gpu": 0.0,
                "memory_gb": 5.0
            }
        },
        "inputs": [
            {
                "data_type_name": "algorithm",
                "max_count": 1.0,
                "min_count": 1.0
            }
        ],
        "interface": {
            "interface_type": "FILESYSTEM_TASK_WORKER"
        },
        "manifest_version": "0.1.0",
        "metadata": {
            "description": "Generate Heatmap data given a list of device tracks.",
            "tags": [
                "heatmap",
                "device_tracks",
                "traceability"
            ],
            "version": "0.0.5"
        },
        "outputs": {
            "output_data_types": [
                "traceability_heatmap"
            ]
        },
        "parameters": [
            {
                "default": 24.0,
                "description": "Number of hours to look back before the first recorded ping for each device, to analyze device movements.",
                "max": 720.0,
                "min": 0.0,
                "name": "look_back_time",
                "type": "integer",
                "units": "hours"
            },
            {
                "default": 24.0,
                "description": "Number of hours to look forward after the last recorded ping for each device, to analyze device movements.",
                "max": 720.0,
                "min": 0.0,
                "name": "look_forward_time",
                "type": "integer",
                "units": "hours"
            },
            {
                "default": 30.0,
                "description": "Maximum timedelta between consecutive pings by a device, for which we will calculate velocity (distance/time).",
                "max": 360.0,
                "min": 1.0,
                "name": "velocity_window",
                "type": "integer",
                "units": "minutes"
            },
            {
                "default": 0.0,
                "description": "Velocity filter in kilometers per hour used to remove pings that appear to move slower than the set min velocity.",
                "max": 200.0,
                "min": 0.0,
                "name": "min_velocity",
                "type": "double",
                "units": "kilometers per hour"
            },
            {
                "default": 1.0,
                "description": "Velocity filter in kilometers per hour used to remove pings that appear to move faster than the set max velocity.",
                "max": 200.0,
                "min": 0.01,
                "name": "max_velocity",
                "type": "double",
                "units": "kilometers per hour"
            },
            {
                "default": 0.0,
                "description": "Filter used to remove pings that do not stay in the same location for more than the set minimum time, in minutes.",
                "maximum": 360.0,
                "minimum": 0.0,
                "name": "min_dwell_time",
                "type": "integer",
                "units": "minutes"
            },
            {
                "default": 0.0025,
                "description": "Heatmap pixel resolution, in decimal degrees.",
                "max": 0.01,
                "min": 0.001,
                "name": "heatmap_resolution",
                "type": "double",
                "units": "decimal degrees"
            }
        ]
    },
    "version": "0.0.5"
  }
]