akride.core.entities package

Submodules

akride.core.entities.catalogs module

Copyright (C) 2024, Akridata, Inc - All Rights Reserved. Unauthorized copying of this file, via any medium is strictly prohibited

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.datasets module

Copyright (C) 2024, Akridata, Inc - All Rights Reserved. Unauthorized copying of this file, via any medium is strictly prohibited

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.entity module

class akride.core.entities.entity.Entity(entity_id, name)[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

Copyright (C) 2024, Akridata, Inc - All Rights Reserved. Unauthorized copying of this file, via any medium is strictly prohibited

class akride.core.entities.jobs.Job(info: CreateJobRequestResponse)[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 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

Copyright (C) 2024, Akridata, Inc - All Rights Reserved. Unauthorized copying of this file, via any medium is strictly prohibited

class akride.core.entities.resultsets.Resultset(info: ResultsetListResponseItem)[source]

Bases: Entity

Class representing a result set entity.

delete() → None[source]

Deletes an entity.

Return type:

None

property job_id
property version

Module contents