job_register

Classes:

JobRegister	A registry of all available job types and their specifications.
JobRegisterJobSpec	Full specification for a job type in the job register.
JobRegisterParamSpec	Full specification for a job parameter.
JobRegisterParamTypeSpec

class JobRegister

A registry of all available job types and their specifications.

Attributes:

categories	Category values to titles map which also indicates order in which jobs should be grouped.
created_at	When this object was first created.
error	Error information if there was an issue generating the registry.
id
specs	List of job type specifications in the registry.
updated_at	When this object was last modified.

categories: Dict[str, str]

Category values to titles map which also indicates order in which jobs should be grouped.

created_at: datetime

When this object was first created. Imported objects such as projects and jobs will retain the created time from their original CryoSPARC instance.

error: JobRegisterError | None

Error information if there was an issue generating the registry.

id: str

specs: List[JobRegisterJobSpec]

List of job type specifications in the registry.

updated_at: datetime

When this object was last modified.

class JobRegisterJobSpec

Full specification for a job type in the job register.

Attributes:

category	Category of the job type for grouping in the UI.
description	Detailed description of the job type.
hidden	Whether the job type is hidden in the UI.
inputs	Input specifications for the job type.
interactive	Whether this is an interactive job.
lightweight	Whether this is a lightweight job.
outputs	Output specifications for the job type.
params	Parameter specifications for the job type.
shorttitle	Short title of the job type.
stability	Stability level of the job type.
tags	Job Builder tags associated with the job type.
title	Human-readable title of the job type.
type	Unique identifier for the job type, e.g., 'import_movies'.

category: Literal['import', 'motion_correction', 'ctf_estimation', 'exposure_curation', 'particle_picking', 'extraction', 'deep_picker', 'particle_curation', 'reconstruction', 'refinement', 'ctf_refinement', 'variability', 'flexibility', 'postprocessing', 'local_refinement', 'helix', 'utilities', 'simulations', 'live', 'instance_testing', 'workflows']

Category of the job type for grouping in the UI.

description: str

Detailed description of the job type.

hidden: bool

Whether the job type is hidden in the UI.

inputs: InputSpecs

Input specifications for the job type.

interactive: bool

Whether this is an interactive job. Jobs of this type can only run directly on master.

lightweight: bool

Whether this is a lightweight job. Lightweight jobs never require GPUs and can run on either master or workers.

outputs: OutputSpecs

Output specifications for the job type.

params: Dict[str, JobRegisterParamSpec]

Parameter specifications for the job type.

shorttitle: str

Short title of the job type.

stability: Literal['develop', 'beta', 'stable', 'legacy', 'obsolete']

Stability level of the job type. ‘obsolete’ jobs cannot be created or run.

tags: List[Literal['new', 'interactive', 'gpuEnabled', 'multiGpu', 'utility', 'import', 'live', 'benchmark', 'wrapper']]

Job Builder tags associated with the job type.

title: str

Human-readable title of the job type.

type: str

Unique identifier for the job type, e.g., ‘import_movies’.

class JobRegisterParamSpec

Full specification for a job parameter.

Attributes:

advanced	Whether the parameter is considered advanced.
allowed	Allowed path types for path parameters that have type 'string' and format 'path'.
anyOf	List of possible types for union or nullable parameters.
default	Default value for the parameter.
description	Detailed description of the parameter.
enum	List of allowed values for the parameter, if applicable.
examples	Example values for the parameter.
format	Expected format or subtype of the parameter, if applicable.
ge	Greater than or equal to constraint for numeric parameters.
gt	Greater than constraint for numeric parameters.
hidden	Whether the parameter is hidden in the UI.
items	Specification for items in an 'array' type parameter.
labels	Human-readable labels for each value in enum.
le	Less than or equal to constraint for numeric parameters.
legacy_name	Legacy name of the parameter in previous versions of CryoSPARC, if applicable.
lt	Less than constraint for numeric parameters.
multiple_of	Multiple of constraint for numeric parameters.
pattern	Regex pattern that string parameters must match.
required_param	Whether the parameter must be set to launch the job.
section	Section the parameter belongs to in the UI.
title	Human-readable title of the parameter.
type	Basic type of the parameter.
validate_path	Whether to validate that paths parameter values exist and are the right allowed type before launching a job.

advanced: bool

Whether the parameter is considered advanced.

allowed: List[Literal['dir', 'file', 'glob']]

Allowed path types for path parameters that have type ‘string’ and format ‘path’.

anyOf: List[JobRegisterParamTypeSpec]

List of possible types for union or nullable parameters.

default: str | int | float | List[str] | None

Default value for the parameter.

description: str | None

Detailed description of the parameter.

enum: List[str | int | float | List[str]] | None

List of allowed values for the parameter, if applicable.

examples: List[Any] | None

Example values for the parameter.

format: Literal['path', 'resources'] | None

Expected format or subtype of the parameter, if applicable.

ge: float | None

Greater than or equal to constraint for numeric parameters.

gt: float | None

Greater than constraint for numeric parameters.

hidden: bool | When

Whether the parameter is hidden in the UI.

items: JobRegisterParamTypeSpec | None

Specification for items in an ‘array’ type parameter.

labels: List[str] | None

Human-readable labels for each value in enum.

le: float | None

Less than or equal to constraint for numeric parameters.

legacy_name: str | None

Legacy name of the parameter in previous versions of CryoSPARC, if applicable.

lt: float | None

Less than constraint for numeric parameters.

multiple_of: float | None

Multiple of constraint for numeric parameters.

pattern: str | None

Regex pattern that string parameters must match.

required_param: bool

Whether the parameter must be set to launch the job.

section: ParamSection | None

Section the parameter belongs to in the UI.

title: str | None

Human-readable title of the parameter.

type: Literal['string', 'integer', 'number', 'boolean', 'null', 'array'] | None

Basic type of the parameter. Will be empty if ‘anyOf’ is used.

validate_path: bool

Whether to validate that paths parameter values exist and are the right allowed type before launching a job.

class JobRegisterParamTypeSpec

Attributes:

format	Expected format or subtype of the parameter, if applicable.
type	Basic type of the parameter.

format: Literal['path', 'resources'] | None

Expected format or subtype of the parameter, if applicable.

type: Literal['string', 'integer', 'number', 'boolean', 'null', 'array']

Basic type of the parameter.