anatools.client.datasets module

Dataset Functions

anatools.client.datasets.cancel_dataset(self, datasetId, workspaceId=None)

Stop a running job.

Parameters

  • datasetId (str) – Dataset ID of the running job to stop.

  • workspaceId (str) – Workspace ID of the running job. If none is provided, the default workspace will get used.

Returns

Succes or error message about stopping the job execution.

Return type

str

anatools.client.datasets.create_dataset(self, name, graphId, description, interpretations=1, priority=1, seed=1, workspaceId=None)

Create a new dataset based off an existing graph. This will start a new job.

Parameters

  • name (str) – Name for dataset.

  • graphId (str) – Graph ID of the graph to create dataset from.

  • description (str) – Description for new dataset.

  • interpretations (int) – Number of interpretations.

  • priority (int) – Job priority.

  • seed (int) – Seed number.

  • workspaceId (str) – Workspace ID of the graph’s workspace. If none is provided, the current workspace will get used.

Returns

Success or failure message about dataset creation.

Return type

str

anatools.client.datasets.delete_dataset(self, datasetId, workspaceId=None)

Delete an existing dataset.

Parameters

  • datasetId (str) – Dataset ID of dataset to delete.

  • workspaceId (str) – Workspace ID that the dataset is in. If none is provided, the current workspace will get used.

Returns

Success or failure message about dataset deletion.

Return type

str

anatools.client.datasets.download_dataset(self, datasetId, workspaceId=None)

Download a dataset.

Parameters

  • datasetId (str) – Dataset ID of dataset to download.

  • workspaceId (str) – Workspace ID that the dataset is in. If none is provided, the default workspace will get used.

Returns

Success or failure message about dataset download.

Return type

str

anatools.client.datasets.edit_dataset(self, datasetId, description=None, name=None, workspaceId=None)

Update dataset description.

Parameters

  • datasetId (str) – Dataset ID to update description for.

  • description (str) – New description.

  • name (str) – New name for dataset.

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

Returns

Success or failure message about dataset update.

Return type

str

anatools.client.datasets.get_datasets(self, datasetId=None, name=None, email=None, workspaceId=None)

Queries the workspace datasets based off provided parameters. Checks on datasetId, name, owner in this respective order within the specified workspace. If only workspace ID is provided, this will return all the graphs in a workspace.

Parameters

  • datasetId (str) – Dataset ID to filter.

  • name (str) – Dataset name.

  • email (str) – Owner of the dataset.

  • workspaceId (str) – Workspace ID of the graph’s workspace. If none is provided, the current workspace will get used.

Returns

Information about the dataset based off the query parameters provided or a failure message.

Return type

str