Skip to content

core.services.context.config

config

Classes:

Name Description
Auth
Run
Experiment
ModelVersion
DatasetVersion
Datalake
JobTraining
JobPreAnn
JobDSVCreate
JobAutoTag
JobModelProcess
OverrideOutputsMixin

Shared toggle to overwrite/replace existing outputs without prompting.

InputDatasetVersionCreation
OutputDatasetVersionCreation
DatasetVersionCreationConfig
InputPreAnnotation
PreAnnotationConfig
AutoTagRunParams
InputDataAutoTagging
OutputDataAutoTagging
DataAutoTaggingConfig
InputModelProcess
ModelProcessConfig
InputTraining
OutputTraining

Auth

Bases: BaseModel

Attributes:

Name Type Description
organization_name str
env str | None
host str | None

organization_name instance-attribute

env = None class-attribute instance-attribute

host = None class-attribute instance-attribute

Run

Bases: BaseModel

Attributes:

Name Type Description
name str | None
working_dir str | None
mode Literal['local', 'picsellia'] | None

name = None class-attribute instance-attribute

working_dir = None class-attribute instance-attribute

mode = None class-attribute instance-attribute

Experiment

Bases: BaseModel

Attributes:

Name Type Description
id str | None
name str | None
project_name str | None
url str | None

id = None class-attribute instance-attribute

name = None class-attribute instance-attribute

project_name = None class-attribute instance-attribute

url = None class-attribute instance-attribute

ModelVersion

Bases: BaseModel

Attributes:

Name Type Description
id str
name str | None
origin_name str | None
url str | None
visibility Literal['private', 'public']

id instance-attribute

name = None class-attribute instance-attribute

origin_name = None class-attribute instance-attribute

url = None class-attribute instance-attribute

visibility instance-attribute

DatasetVersion

Bases: BaseModel

Attributes:

Name Type Description
id str | None
name str | None
origin_name str | None
version_name str | None
url str | None

id = None class-attribute instance-attribute

name = None class-attribute instance-attribute

origin_name = None class-attribute instance-attribute

version_name = None class-attribute instance-attribute

url = None class-attribute instance-attribute

Datalake

Bases: BaseModel

Attributes:

Name Type Description
id str
name str | None
url str | None

id instance-attribute

name = None class-attribute instance-attribute

url = None class-attribute instance-attribute

JobTraining

Bases: BaseModel

Attributes:

Name Type Description
type Literal['TRAINING']

type instance-attribute

JobPreAnn

Bases: BaseModel

Attributes:

Name Type Description
type Literal['PRE_ANNOTATION']

type instance-attribute

JobDSVCreate

Bases: BaseModel

Attributes:

Name Type Description
type Literal['DATASET_VERSION_CREATION']

type instance-attribute

JobAutoTag

Bases: BaseModel

Attributes:

Name Type Description
type Literal['DATA_AUTO_TAGGING']

type instance-attribute

JobModelProcess

Bases: BaseModel

Attributes:

Name Type Description
type Literal['MODEL_CONVERSION', 'MODEL_COMPRESSION']

type instance-attribute

OverrideOutputsMixin

Bases: BaseModel

Shared toggle to overwrite/replace existing outputs without prompting.

Attributes:

Name Type Description
override_outputs bool

override_outputs = Field(default=False, description='If true, existing target outputs (e.g., experiment bindings, dataset versions, target datalakes) will be overwritten or recreated without confirmation prompts where applicable.') class-attribute instance-attribute

InputDatasetVersionCreation

Bases: BaseModel

Attributes:

Name Type Description
dataset_version DatasetVersion

dataset_version instance-attribute

OutputDatasetVersionCreation

Bases: BaseModel

Attributes:

Name Type Description
dataset_version DatasetVersion

dataset_version instance-attribute

DatasetVersionCreationConfig

Bases: OverrideOutputsMixin, BaseModel

Attributes:

Name Type Description
job JobDSVCreate
auth Auth
run Run
input InputDatasetVersionCreation
output OutputDatasetVersionCreation
parameters dict[str, Any]
override_outputs bool

job instance-attribute

auth instance-attribute

run = Run() class-attribute instance-attribute

input instance-attribute

output instance-attribute

parameters = Field(default_factory=dict) class-attribute instance-attribute

override_outputs = Field(default=False, description='If true, existing target outputs (e.g., experiment bindings, dataset versions, target datalakes) will be overwritten or recreated without confirmation prompts where applicable.') class-attribute instance-attribute

InputPreAnnotation

Bases: BaseModel

Attributes:

Name Type Description
dataset_version DatasetVersion | None
model_version ModelVersion | None

dataset_version = None class-attribute instance-attribute

model_version = None class-attribute instance-attribute

PreAnnotationConfig

Bases: OverrideOutputsMixin, BaseModel

Attributes:

Name Type Description
job JobPreAnn
auth Auth
run Run
input InputPreAnnotation
parameters dict[str, Any]
override_outputs bool

job instance-attribute

auth instance-attribute

run = Run() class-attribute instance-attribute

input instance-attribute

parameters = Field(default_factory=dict) class-attribute instance-attribute

override_outputs = Field(default=False, description='If true, existing target outputs (e.g., experiment bindings, dataset versions, target datalakes) will be overwritten or recreated without confirmation prompts where applicable.') class-attribute instance-attribute

AutoTagRunParams

Bases: BaseModel

Attributes:

Name Type Description
offset int
limit int

offset = 0 class-attribute instance-attribute

limit = 100 class-attribute instance-attribute

InputDataAutoTagging

Bases: BaseModel

Attributes:

Name Type Description
datalake Datalake
model_version ModelVersion | None

datalake instance-attribute

model_version = None class-attribute instance-attribute

OutputDataAutoTagging

Bases: BaseModel

Attributes:

Name Type Description
datalake Datalake

datalake instance-attribute

DataAutoTaggingConfig

Bases: OverrideOutputsMixin, BaseModel

Attributes:

Name Type Description
job JobAutoTag
auth Auth
run Run
input InputDataAutoTagging
output OutputDataAutoTagging
run_parameters AutoTagRunParams
parameters dict[str, Any]
override_outputs bool

job instance-attribute

auth instance-attribute

run = Run() class-attribute instance-attribute

input instance-attribute

output instance-attribute

run_parameters instance-attribute

parameters = Field(default_factory=dict) class-attribute instance-attribute

override_outputs = Field(default=False, description='If true, existing target outputs (e.g., experiment bindings, dataset versions, target datalakes) will be overwritten or recreated without confirmation prompts where applicable.') class-attribute instance-attribute

InputModelProcess

Bases: BaseModel

Attributes:

Name Type Description
model_version ModelVersion

model_version instance-attribute

ModelProcessConfig

Bases: OverrideOutputsMixin, BaseModel

Attributes:

Name Type Description
job JobModelProcess
auth Auth
run Run
input InputModelProcess
parameters dict[str, Any]
override_outputs bool

job instance-attribute

auth instance-attribute

run = Run() class-attribute instance-attribute

input instance-attribute

parameters = Field(default_factory=dict) class-attribute instance-attribute

override_outputs = Field(default=False, description='If true, existing target outputs (e.g., experiment bindings, dataset versions, target datalakes) will be overwritten or recreated without confirmation prompts where applicable.') class-attribute instance-attribute

InputTraining

Bases: BaseModel

Attributes:

Name Type Description
train_dataset_version DatasetVersion | None
test_dataset_version DatasetVersion | None
validation_dataset_version DatasetVersion | None
model_version ModelVersion | None

train_dataset_version = None class-attribute instance-attribute

test_dataset_version = None class-attribute instance-attribute

validation_dataset_version = None class-attribute instance-attribute

model_version = None class-attribute instance-attribute

OutputTraining

Bases: BaseModel

Attributes:

Name Type Description
experiment Experiment

experiment instance-attribute