anatools.client.gan module

GAN Functions

add_gan_access(self, modelId, targetOrganizationId)

Adds access to a model for new organization; can only be done by a user in the organization that owns the model.

Parameters

  • modelId (str) – Id for the GAN model.

  • targetOrganizationId (str) – Organization ID where the model is be granted access.

Returns

Returns true if the GAN model was granted access.

Return type

bool

create_gan_dataset(self, modelId, datasetId, workspaceId=None)

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

Parameters

  • modelId (str) – Model ID to use for the GAN.

  • datasetId (str) – Dataset ID to input into the GAN.

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

Returns

The datsetId for the GAN Dataset job.

Return type

str

delete_gan_dataset(self, datasetId, workspaceId=None)

Deletes a GAN dataset job.

Parameters

  • datasetId (str) – Dataset ID for the GAN dataset.

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

Returns

Returns true if the GAN dataset was successfully deleted.

Return type

bool

delete_gan_model(self, modelId)

Delete the GAN model and remove access to it from all shared organizations. This can only be done by a user in the organization that owns the model.

Parameters

modelId (str) – The ID of a specific GAN model.

Returns

Status

Return type

str

get_gan_dataset(self, datasetId, workspaceId=None)

Retrieve information about GAN dataset jobs.

Parameters

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

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

Returns

Information about the GAN Dataset.

Return type

list[dict]

get_gan_models(self, modelId=None, workspaceId=None)

Retrieve information about GAN models that exist on the platform.

Parameters

modelId (str) – Model ID to retrieve information for.

Returns

GAN Model information.

Return type

list[dict]

remove_gan_access(self, modelId, targetOrganizationId)

Removes access to a model for an that does not own the model.

Parameters

  • modelId (str) – Id for the GAN model.

  • targetOrganizationId (str) – Organization ID where the model access is to be removed.

Returns

Returns true if the GAN model access was removed.

Return type

bool

upload_gan_model(self, modelFileName, name, description, flags=None, organizationId=None)

Uploades a GAN model to the microservice. The model will be owned by the specified organization. If not organizationId is given the model will be owned by that of the analcient.

Parameters

  • modelFileName (str) – The file of the model - relative to the local directry.

  • name (str) – A name for model.

  • description (str) – Details about the model.

  • flags (str) – Parameters for use when running the model.

  • organizationId (str) – Id of organization that owns the model, that of the anaclient if not given.

Returns

modleId – The unique identifier for this model.

Return type

str