anatools.anaclient.umap module

UMAP Functions

create_umap(self, datasetIds, samples, workspaceId=None)

Creates a UMAP dataset comparison job on the platform.

Parameters

• datasetIds ([str]) – Dataset ID to retrieve information for.

• samples ([int]) – Samples to take from each dataset.

• workspaceId (str) – Workspace ID where the datasets exists.

Returns

The UMAP Job ID.

Return type

str

delete_umap(self, umapId, workspaceId=None)

Deletes/cancels a UMAP dataset comparison on the platform.

Parameters

• umapId (str) – UMAP Job ID.

• workspaceId (str) – Workspace ID where the datasets exists.

Returns

Status.

Return type

bool

get_umaps(self, umapId=None, datasetId=None, workspaceId=None)

Retrieves information about UMAP dataset comparison from the platform.

Parameters

• umapId (str) – UMAP Job ID.

• datasetId (str) – Dataset Id to filter on.

• workspaceId (str) – Workspace ID where the datasets exists.

Returns

UMAP information.

Return type

dict