Skip to content

core.contexts.processing.model.picsellia_model_processing_context

picsellia_model_processing_context

Classes:

Name Description
PicselliaModelProcessingContext

Context for model version processing jobs in Picsellia, including export logic.

PicselliaModelProcessingContext(processing_parameters_cls, export_parameters_cls, api_token=None, host=None, organization_id=None, job_id=None, use_id=True, download_annotations=True)

Bases: PicselliaContext, Generic[TParameters, TExportParameters]

Context for model version processing jobs in Picsellia, including export logic.

Methods:

Name Description
to_dict

Convert context to a dictionary representation.

get_model_version

Fetch a model version by ID.

Attributes:

Name Type Description
job_id
job
job_type
job_context
model_version
use_id
download_annotations
processing_parameters
export_parameters
model_version_id str | None

Return the model version ID, or raise if missing.

api_token
host
organization_id
organization_name
client
working_dir str

Abstract property to define the working directory path.

job_id = job_id or os.environ.get('job_id') instance-attribute

job = self._initialize_job() instance-attribute

job_type = self.job.sync()['type'] instance-attribute

job_context = self._initialize_job_context() instance-attribute

model_version = self.get_model_version() instance-attribute

use_id = use_id instance-attribute

download_annotations = download_annotations instance-attribute

processing_parameters = processing_parameters_cls(log_data=parameters_log_data) instance-attribute

export_parameters = export_parameters_cls(log_data=parameters_log_data) instance-attribute

model_version_id property

Return the model version ID, or raise if missing.

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 abstractmethod property

Abstract property to define the working directory path.

This should be implemented by subclasses to specify where files such as datasets, weights, and logs are stored locally.

Returns:

Name Type Description
str str

Path to the working directory.

to_dict()

Convert context to a dictionary representation.

get_model_version()

Fetch a model version by ID.