Skip to content

core.contexts.processing.dataset.local_context

local_context

Classes:

Name Description
LocalDatasetProcessingContext

Local context for testing a processing pipeline without executing a real job on Picsellia.

LocalDatasetProcessingContext(processing_parameters_cls, processing_parameters=None, api_token=None, host=None, organization_id=None, organization_name=None, job_type=None, input_dataset_version_id=None, output_dataset_version_id=None, target_version_name=None, target_id=None, inputs=None, use_id=True, download_annotations=True, model_version_id=None, working_dir=None)

Bases: PicselliaLocalProcessingContext, Generic[TParameters]


              flowchart TD
              picsellia_cv_engine.core.contexts.processing.dataset.local_context.LocalDatasetProcessingContext[LocalDatasetProcessingContext]
              picsellia_cv_engine.core.contexts.processing.common.local_picsellia_context.PicselliaLocalProcessingContext[PicselliaLocalProcessingContext]
              picsellia_cv_engine.core.contexts.common.picsellia_context.PicselliaContext[PicselliaContext]

                              picsellia_cv_engine.core.contexts.processing.common.local_picsellia_context.PicselliaLocalProcessingContext --> picsellia_cv_engine.core.contexts.processing.dataset.local_context.LocalDatasetProcessingContext
                                picsellia_cv_engine.core.contexts.common.picsellia_context.PicselliaContext --> picsellia_cv_engine.core.contexts.processing.common.local_picsellia_context.PicselliaLocalProcessingContext
                



              click picsellia_cv_engine.core.contexts.processing.dataset.local_context.LocalDatasetProcessingContext href "" "picsellia_cv_engine.core.contexts.processing.dataset.local_context.LocalDatasetProcessingContext"
              click picsellia_cv_engine.core.contexts.processing.common.local_picsellia_context.PicselliaLocalProcessingContext href "" "picsellia_cv_engine.core.contexts.processing.common.local_picsellia_context.PicselliaLocalProcessingContext"
              click picsellia_cv_engine.core.contexts.common.picsellia_context.PicselliaContext href "" "picsellia_cv_engine.core.contexts.common.picsellia_context.PicselliaContext"
            

Local context for testing a processing pipeline without executing a real job on Picsellia.

Can create or retrieve dataset versions and model versions as needed.

Methods:

Name Description
to_dict

Convert context to a dictionary for logging or serialization.

get_dataset_version
get_model_version
get_or_create_target_dataset_version

Attributes:

Name Type Description
download_annotations
job_type
asset_ids
target
input_dataset_version_id str
target_version_name str
model_version_id str | None
api_token
host
organization_id
organization_name
client
working_dir str
target_id
parameters dict[str, Any]
inputs
use_id
processing_parameters TParameters

download_annotations = download_annotations instance-attribute

job_type = job_type instance-attribute

asset_ids = None instance-attribute

target = self.client.get_dataset_version_by_id(id=(self.target_id)) instance-attribute

input_dataset_version_id property

target_version_name property

model_version_id property

api_token = api_token or os.getenv('api_token') instance-attribute

host = host or os.getenv('host', 'https://app.picsellia.com') instance-attribute

organization_id = organization_id or os.getenv('organization_id') instance-attribute

organization_name = organization_name or os.getenv('organization_name') instance-attribute

client = self._initialize_client() instance-attribute

working_dir property

target_id = target_id instance-attribute

parameters = parameters_dict if parameters_dict is not None else {} instance-attribute

inputs = inputs instance-attribute

use_id = use_id instance-attribute

processing_parameters = processing_parameters_cls(log_data=(self.parameters)) instance-attribute

to_dict()

Convert context to a dictionary for logging or serialization.

get_dataset_version(dataset_version_id)

get_model_version()

get_or_create_target_dataset_version(input_dataset_version, target_version_name)