job

job#

Classes:

`AllocatedResources`	Scheduler target resources allocated for a job the scheduler at launch time.
`Job`	Specification for a CryoSPARC Job object.
`JobLastAccessed`	Record for when a user last accessed a job.
`JobWorkflowInfo`	Information about the workflow a job is part of.
`RunError`	Details about a runtime error encountered during job execution.
`UiTileImage`	Details about a job tile image shown in the UI.

class AllocatedResources#

Scheduler target resources allocated for a job the scheduler at launch time.

Attributes:

`fixed`	Fixed compute resources allocated for this job.
`hostname`	For node targets, hostname of selected worker node.
`lane`	Name of lane the job is queued to.
`lane_type`	Type of allocated lane ("node" or "cluster")
`licenses_acquired`	Number of GPU tokens allocated for this job.
`slots`	Listings of compute resources allocated for this job.
`target`	Allocated scheduler target full details.

fixed: FixedResourceSlots#: Fixed compute resources allocated for this job.

hostname: str#: For node targets, hostname of selected worker node.

lane: str | None#: Name of lane the job is queued to.

lane_type: str | None#: Type of allocated lane (“node” or “cluster”)

licenses_acquired: int#: Number of GPU tokens allocated for this job.

slots: ResourceSlots#: Listings of compute resources allocated for this job.

target: SchedulerTarget | None#: Allocated scheduler target full details.

class Job#

Specification for a CryoSPARC Job object. Access parameters, inputs and outputs from spec field.

Attributes:

`PID_main`	Process ID number of main job process
`PID_monitor`	Process ID number of job monitor process
`PID_workers`	Process ID numbers of worker processes spawned by main job process
`attach_status`
`bench`	Benchmarking data
`bench_timings`	list_of_timings}
`build_errors`	List of build errors for this job.
`children`	Set of child job UIDs based on output connections.
`cloned_from`	Job this job was cloned from
`cluster_job_custom_vars`
`cluster_job_id`
`cluster_job_monitor_event_id`
`cluster_job_monitor_last_run_at`
`cluster_job_monitor_retries`
`cluster_job_status`
`cluster_job_status_code`
`cluster_job_submission_script`
`completed_at`	When job finished
`completed_count`	How many times this job was marked as completed
`created_at`	When this object was first created.
`created_by_job_uid`	Job ID of job that created this job.
`created_by_user_id`	Object ID of user account that created this job.
`deleted`	True if the job has been marked as deleted.
`deleted_at`
`deleting`	True if the job is being deleted
`description`	Human-readable job markdown description.
`dumped_at`	When the model was last dumped to disk
`enable_bench`	Enable benchmarking for this job.
`errors_run`	Runtime errors, limited to last 10 errors.
`failed_at`	When job failed
`has_error`	If True, there's an error in the streamlog
`has_warning`	If True, there's a warning in the streamlog
`heartbeat_at`	Last heartbeat received
`id`
`import_status`
`imported_at`
`instance_information`	Details about the active instance
`interactive_port`	Port assigned to a job's interactive server by operation system, only available after an interactive job enters waiting status.
`intermediate_results_size_bytes`
`intermediate_results_size_last_updated`
`is_ancestor_of_final_result`	Similar to is_final_result
`is_experiment`	Is the job part of an experiment?
`is_final_result`	Job and its anscestors is the final result and should not be deleted during data cleanup steps.
`job_dir`	Job directory relative to project directory, usually the same as uid
`job_dir_size`	Job directory size
`job_dir_size_last_updated`	Job directory last updated timestamp
`job_sig`	Job signature created by licensing module
`killed_at`	When job was killed
`last_accessed`	When a specific user last opened this job in the user interface
`last_dumped_version`	The version of CryoSPARC last dumped at
`last_exported_at`	Time of last export of outputs
`last_exported_location`	Time of last exported outputs location
`last_exported_version`	Version of CryoSPARC this job was last exported from
`last_intermediate_data_cleared_amount`
`last_intermediate_data_cleared_at`
`last_scheduled_at`	When scheduler last tried to launch this job
`launched_at`	When job initial monitor process starts
`no_check_inputs_ready`	If True, a queued job will be launched even if parent connected jobs have not finished running yet.
`num_tokens`	number of (GPU) tokens required to run the job
`parents`	Set of parent jobs UIDs based on input connections.
`priority`	Queue priority set by user or default for system.
`progress`	Progress log
`project_uid`	Project unique ID, e.g., "P3".
`project_uid_num`	Numeric part of the project UID.
`queue_message`	GPU"
`queue_status`	waiting_inputs, project_paused, actively_queued, launched
`queued_at`	When added to the queue
`queued_by_user_id`	ID of user account that queued this job.
`queued_job_hash`	hash of puid, juid, # tokens requested, job type and user for scheduler
`queued_to_gpu`	database field is sometimes `False` in older CryoSPARC jobs, cast validator prevents this
`queued_to_hostname`	database field is sometimes `False` in older CryoSPARC jobs, cast validator prevents this
`queued_to_lane`	set at queue time based on params
`requeue_windows_ends_at`	If set, job can be cleared and requeued until this time without losing its place in the queue
`resources_allocated`	Set by scheduler before launching
`run_as_user`	Developer job register to use (internal use only)
`running_at`	When job monitor process forks into main process
`spec`	Job type-specific settings, including params, inputs, outputs, resources, etc.
`starred_by`	List of user IDs who have starred this job.
`started_at`	When internal scheduler launches/submits
`status`	Job scheduling status, e.g., "building", "queued", "running".
`status_num`	Numeric representation of job status.
`tags`	Tags associated with this job
`title`	Human-readable job title.
`tokens_acquired_at`	When job got confirmation from the licensing server to run
`tokens_requested_at`	When job started waiting for tokens to become available
`ui_tile_images`	Job tile images in app
`uid`	Job unique ID, e.g., "J42".
`uid_num`	Numeric part of the job UID.
`updated_at`	When this object was last modified.
`version`	Version of CryoSPARC that last ran this job
`version_created`	Version of CryoSPARC used to create this job
`waiting_at`	When job last went into waiting for interaction status
`workflow`	Information about workflow that job ran from, if any
`workspace_uids`	List of workspace UIDs this job belongs to.

PID_main: int | None#: Process ID number of main job process

PID_monitor: int | None#: Process ID number of job monitor process

PID_workers: List[int]#: Process ID numbers of worker processes spawned by main job process

attach_status: Literal['attaching', 'complete', 'failed'] | None#

bench: Dict[str, float | int | Dict[str, Any]]#: Benchmarking data

bench_timings: Dict[str, List[Tuple[datetime, datetime | None]]]#

list_of_timings}

Type:: Benchmark timing data in the form {key

build_errors: List[JobBuildError]#: List of build errors for this job. Jobs cannot be queued or launched if there are build errors.

children: List[str]#: Set of child job UIDs based on output connections.

cloned_from: str | None#: Job this job was cloned from

cluster_job_custom_vars: Dict[str, str]#

cluster_job_id: str | None#

cluster_job_monitor_event_id: str | None#

cluster_job_monitor_last_run_at: datetime | None#

cluster_job_monitor_retries: int#

cluster_job_status: str | None#

cluster_job_status_code: str | None#

cluster_job_submission_script: str | None#

completed_at: datetime | None#: When job finished

completed_count: int#: How many times this job was marked as completed

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.

created_by_job_uid: str | None#: Job ID of job that created this job.

created_by_user_id: str | None#: Object ID of user account that created this job.

deleted: bool#: True if the job has been marked as deleted.

deleted_at: datetime | None#

deleting: bool#: True if the job is being deleted

description: str#: Human-readable job markdown description.

dumped_at: datetime | None#: When the model was last dumped to disk

enable_bench: bool#: Enable benchmarking for this job. Used by extensive workflow

errors_run: List[RunError]#: Runtime errors, limited to last 10 errors.

failed_at: datetime | None#: When job failed

has_error: bool#: If True, there’s an error in the streamlog

has_warning: bool#: If True, there’s a warning in the streamlog

heartbeat_at: datetime | None#: Last heartbeat received

id: str#

import_status: Literal['importing', 'complete', 'failed'] | None#

imported_at: datetime | None#

instance_information: InstanceInformation#: Details about the active instance

interactive_port: int | None#: Port assigned to a job’s interactive server by operation system, only available after an interactive job enters waiting status.

intermediate_results_size_bytes: int#

intermediate_results_size_last_updated: datetime | None#

is_ancestor_of_final_result: bool#: Similar to is_final_result

is_experiment: bool#: Is the job part of an experiment?

is_final_result: bool#: Job and its anscestors is the final result and should not be deleted during data cleanup steps.

job_dir: str#: Job directory relative to project directory, usually the same as uid

job_dir_size: int#: Job directory size

job_dir_size_last_updated: datetime#: Job directory last updated timestamp

job_sig: str | None#: Job signature created by licensing module

killed_at: datetime | None#: When job was killed

last_accessed: JobLastAccessed | None#: When a specific user last opened this job in the user interface

last_dumped_version: str | None#: The version of CryoSPARC last dumped at

last_exported_at: datetime | None#: Time of last export of outputs

last_exported_location: str | None#: Time of last exported outputs location

last_exported_version: str | None#: Version of CryoSPARC this job was last exported from

last_intermediate_data_cleared_amount: int#

last_intermediate_data_cleared_at: datetime | None#

last_scheduled_at: datetime | None#: When scheduler last tried to launch this job

launched_at: datetime | None#: When job initial monitor process starts

no_check_inputs_ready: bool#: If True, a queued job will be launched even if parent connected jobs have not finished running yet.

num_tokens: int#: number of (GPU) tokens required to run the job

parents: List[str]#: Set of parent jobs UIDs based on input connections.

priority: int#: Queue priority set by user or default for system. higher number = higher priority.

progress: List[Dict[str, Any]]#: Progress log

project_uid: str#: Project unique ID, e.g., “P3”.

project_uid_num: int#: Numeric part of the project UID.

queue_message: str | None#

GPU”

Type:: e.g., “Waiting for resource in lane xxx

queue_status: Literal['waiting_inputs', 'project_paused', 'actively_queued', 'launched', 'waiting_maintenance', 'waiting_licenses', 'waiting_resources'] | None#: waiting_inputs, project_paused, actively_queued, launched

queued_at: datetime | None#: When added to the queue

queued_by_user_id: str | None#: ID of user account that queued this job.

queued_job_hash: int | None#: hash of puid, juid, # tokens requested, job type and user for scheduler

queued_to_gpu: List[int] | None#

database field is sometimes False in older CryoSPARC jobs, cast validator prevents this

Type:: NOTE

queued_to_hostname: str | None#

database field is sometimes False in older CryoSPARC jobs, cast validator prevents this

Type:: NOTE

queued_to_lane: str | None#: set at queue time based on params

requeue_windows_ends_at: datetime | None#: If set, job can be cleared and requeued until this time without losing its place in the queue

resources_allocated: AllocatedResources | None#: Set by scheduler before launching

run_as_user: str | None#: Developer job register to use (internal use only)

running_at: datetime | None#: When job monitor process forks into main process

spec: JobSpec#: Job type-specific settings, including params, inputs, outputs, resources, etc.

starred_by: List[str]#: List of user IDs who have starred this job.

started_at: datetime | None#: When internal scheduler launches/submits

status: Literal['building', 'queued', 'launched', 'started', 'running', 'waiting', 'completed', 'killed', 'failed']#: Job scheduling status, e.g., “building”, “queued”, “running”.

status_num: int#: Numeric representation of job status.

tags: List[str]#: Tags associated with this job

title: str#: Human-readable job title.

tokens_acquired_at: datetime | None#: When job got confirmation from the licensing server to run

tokens_requested_at: datetime | None#: When job started waiting for tokens to become available

ui_tile_images: List[UiTileImage]#: Job tile images in app

uid: str#: Job unique ID, e.g., “J42”.

uid_num: int#: Numeric part of the job UID.

updated_at: datetime#: When this object was last modified.

version: str | None#: Version of CryoSPARC that last ran this job

version_created: str | None#: Version of CryoSPARC used to create this job

waiting_at: datetime | None#: When job last went into waiting for interaction status

workflow: JobWorkflowInfo | None#: Information about workflow that job ran from, if any

workspace_uids: List[str]#: List of workspace UIDs this job belongs to. Must have at least one item

class JobLastAccessed#

Record for when a user last accessed a job.

Attributes:

`accessed_at`	Timestamp of the last access.
`name`	Username that last accessed the job.

accessed_at: datetime#: Timestamp of the last access.

name: str#: Username that last accessed the job.

class JobWorkflowInfo#

Information about the workflow a job is part of.

Attributes:

`id`
`jobId`
`run`

id: str#

jobId: str#

run: int#

class RunError#

Details about a runtime error encountered during job execution.

Attributes:

`message`
`warning`

message: str#

warning: bool#

class UiTileImage#

Details about a job tile image shown in the UI.

Attributes:

`fileid`
`name`
`num_cols`
`num_rows`

fileid: str#

name: str#

num_cols: int | None#

num_rows: int | None#

job

Contents

job#