anatools.client.analytics module

Analytics Functions

create_analytics(self, datasetId, type, range=[], images=True, workspaceId=None)

Generate analytics for a dataset.

Parameters
  • datasetId (str) – Dataset ID to download image annotation for.

  • type (str) – The type of dataset analytics to generate.

  • range ([int]) – The range of runs to generate analytics for.

  • workspaceId (str) – Workspace ID of the dataset to generate annotation for. If none is provided, the current workspace will get used.

Returns

The analyticsId for the analytics job.

Return type

str

delete_analytics(self, analyticsId, workspaceId=None)

Deletes a dataset analytics.

Parameters
  • analyticsId (str) – Analytics ID for the analytics to delete.

  • workspaceId (str) – Workspace ID where the analytics exist. If none is provided, the current workspace will get used.

Returns

If true, successfully deleted the analytics.

Return type

bool

get_analytics(self, datasetId, analyticsId, workspaceId=None)

Retrieve information about analytics jobs for a dataset or analyticsId.

Parameters
  • datasetId (str) – Dataset ID to retrieve analytics for.

  • analyticsId (str) – Analytics ID to retrieve analytics for.

  • workspaceId (str) – Workspace ID where the analytics exist. If none is provided, the current workspace will get used.

Returns

Analytics information.

Return type

json

get_analytics_types(self)

Retrieve the analytics types available on the platform.

Returns

The analytics types available on the platform.

Return type

str