akride.core.entities package

Submodules

akride.core.entities.bgc_job module

class akride.core.entities.bgc_job.BGCJob(info: BCJobDetailedStatus)[source]

Bases: Entity

Class representing a dataset entity.

delete() → None[source]

Deletes an entity.

Return type:: None

akride.core.entities.catalogs module

class akride.core.entities.catalogs.Catalog(info: GetCatalogResponse)[source]

Bases: Entity

Class representing a catalog entity.

delete() → None[source]

Deletes an entity.

Return type:: None

akride.core.entities.containers module

class akride.core.entities.containers.Container(info: Container)[source]

Bases: Entity

Class representing a dataset entity.

delete() → None[source]

Deletes an entity.

Return type:: None

akride.core.entities.datasets module

class akride.core.entities.datasets.Dataset(info: DataSetsItem)[source]

Bases: Entity

Class representing a dataset entity.

delete() → None[source]

Deletes an entity.

Return type:: None

akride.core.entities.docker_image module

class akride.core.entities.docker_image.DockerImage(info: DockerImageItem | DockerImageResp)[source]

Bases: Entity

Class representing a Docker Image entity.

delete() → None[source]

Deletes an entity.

Return type:: None

class akride.core.entities.docker_image.DockerImageSpec(**kwargs)[source]

Bases: Dict

A Constructor for the DockerImageSpec class.

Parameters:

name: str: The display name of the Docker image.
namespace: str: The namespace for the Docker image, default is “default”.
description: str: A brief description of the Docker image.
repository_id: str: The repository ID of the Docker repository configured on DE
image_name: str: The name of the Docker image.
image_tag: str: The tag for the Docker image, default is “latest”.
filter_type: DockerImageType: The type of filter used by the Docker image, default is DockerImageType.FEATURIZER.
gpu_filter: bool: A flag indicating if the docker is a GPU filter, default is True.
allow_no_gpu: bool: A flag indicating if no GPU is allowed, default is True.
command: str: The command to be executed in the Docker image.
properties: Dict[str, Any]: Additional properties for DockerImageType.FEATURIZER.
gpu_mem_fraction: float: The fraction of GPU memory to be used, must be > 0 if gpu_filter is True.

raises ValueError:: If image_name is empty.:
raises ValueError:: If command is empty.:
raises ValueError:: If gpu_mem_fraction is <= 0 when gpu_filter is True.:
raises ValueError:: If properties are missing for filter type DockerImageType.FEATURIZER.:
raises ValueError:: If number of features, patch width, or:
raises length are empty or non-positive for filter type DockerImageType.FEATURIZER.:

akride.core.entities.docker_pipeline module

class akride.core.entities.docker_pipeline.DockerPipeline(info: PostPipelineResp)[source]

Bases: Entity

Class representing a Docker Pipeline Entity.

delete() → None[source]

Deletes an entity.

Return type:: None

class akride.core.entities.docker_pipeline.DockerPipelineSpec(pre_processor_docker: PipelineDocker, featurizer_docker: PipelineDocker, thumbnail_docker: PipelineDocker, attribute_generator_dockers: List[PipelineAttributeGenerator] | None = None, **kwargs)[source]

Bases: Dict

A Constructor for the DockerPipelineSpec class.

Parameters

pipeline_name: str: The name of the Docker pipeline.
pipeline_description: str: A brief description of the Docker pipeline.
data_type: str: The type of data processed by the pipeline, default is DataType.IMAGE.value.
namespace: str: The namespace for the Docker pipeline, default is “default”.
pre_processor_docker: PipelineDocker: The Docker image specification for the pre-processor.
featurizer_docker: PipelineDocker: The Docker image specification for the featurizer.
thumbnail_docker: PipelineDocker: The Docker image specification for the thumbnail generator.
attribute_generator_dockers :: List[PipelineAttributeGenerator], optional A list of Docker image specifications for attribute generators.

ValueError: If pipeline_name is empty. ValueError: If pipeline_description is empty. ValueError: If data_type is not one of the allowed values

(DataType.IMAGE.value or DataType.VIDEO.value).

akride.core.entities.docker_repository module

class akride.core.entities.docker_repository.DockerRepository(info: DockerRepositoryDetails)[source]

Bases: Entity

Class representing a Docker Repository entity.

delete() → None[source]

Deletes an entity.

Return type:: None

akride.core.entities.entity module

class akride.core.entities.entity.Entity(entity_id, name: str | None = None)[source]

Bases: ABC

Abstract base class representing an entity in the system.

abstract delete() → None[source]

Deletes an entity.

Return type:: None

get_id() → str | None[source]

Method for getting the ID of the entity.

Returns:: The ID of the entity.
Return type:: str

get_name() → str | None[source]

Method for getting the name of the entity.

Returns:: The name of the entity.
Return type:: str

to_dict() → dict[source]

Method for converting the entity to a dictionary.

Returns:: A dictionary representing the entity.
Return type:: dict

akride.core.entities.jobs module

class akride.core.entities.jobs.Job(info: CreateJobRequestResponse | CompatibleRefJob)[source]

Bases: Entity

Class representing a job entity.

property dataset_id

delete() → None[source]

Deletes an entity.

Return type:: None

get_max_clusters() → int[source]

Get total number of clusters available for visualization

Raises:: ValueError – If job details are not available
Returns:: int

get_num_clusters() → int[source]

Get the default number of clusters available for visualization

Raises:: ValueError – If job details are not available
Returns:: int

property ownername

property pipeline_id

class akride.core.entities.jobs.JobSpec(dataset: Dataset, **kwargs)[source]

Bases: Dict

Class representing a job specification. TODO: separate specs for different job types

akride.core.entities.pipeline module

class akride.core.entities.pipeline.Pipeline(info: Pipeline)[source]

Bases: Entity

Class representing a Pipeline entity.

delete() → None[source]

Deletes an entity.

Return type:: None

akride.core.entities.resultsets module

class akride.core.entities.resultsets.Resultset(info: ResultsetListResponseItem | ResultsetGetResponseItem, entity_id: str | None = None)[source]

Bases: Entity

Class representing a result set entity.

delete() → None[source]

Deletes an entity.

Return type:: None

property job_id

property version

akride.core.entities.sms_secrets module

class akride.core.entities.sms_secrets.SMSSecrets(info: SMSSecretDetailedResponse)[source]

Bases: Entity

Class representing a SMS Secrets entity.

delete() → None[source]

Deletes an entity.

Return type:: None

akride.core.entities package

Submodules

akride.core.entities.bgc_job module

akride.core.entities.catalogs module

akride.core.entities.containers module

akride.core.entities.datasets module

akride.core.entities.docker_image module

Parameters:

akride.core.entities.docker_pipeline module

akride.core.entities.docker_repository module

akride.core.entities.entity module

akride.core.entities.jobs module

akride.core.entities.pipeline module

akride.core.entities.resultsets module

akride.core.entities.sms_secrets module

Module contents