event#
Classes:
An event type indicating a checkpoint in the job's execution. |
|
Base class for all event types. |
|
An event with an image and optional text. |
|
An event with an interactive plot and optional text. |
|
An image file associated with an interactive event, along with its components. |
|
An event with only text and no additional image or interactive data. |
- class CheckpointEvent#
An event type indicating a checkpoint in the job’s execution.
Attributes:
Available worker system memory at the time of the event, in MB.
CPU memory used by the job process at the time of the event, in MB.
When this object was first created.
List of flags associated with this event.
Job UID that this event belongs to.
Metadata associated with this event.
Project UID that this event belongs to.
Checkpoint events always have type 'checkpoint'.
When this object was last modified.
- avail_mb: float | None#
Available worker system memory at the time of the event, in MB.
- cpumem_mb: float | None#
CPU memory used by the job process at the time of the event, in MB.
- 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.
- flags: List[str]#
List of flags associated with this event.
- id: str#
- job_uid: str#
Job UID that this event belongs to.
- meta: Dict[str, Any]#
Metadata associated with this event.
- project_uid: str#
Project UID that this event belongs to.
- type: Literal['checkpoint']#
Checkpoint events always have type ‘checkpoint’.
- updated_at: datetime#
When this object was last modified.
- class Event#
Base class for all event types.
Attributes:
Available worker system memory at the time of the event, in MB.
CPU memory used by the job process at the time of the event, in MB.
When this object was first created.
List of flags associated with this event.
Job UID that this event belongs to.
Metadata associated with this event.
Project UID that this event belongs to.
When this object was last modified.
- avail_mb: float | None#
Available worker system memory at the time of the event, in MB.
- cpumem_mb: float | None#
CPU memory used by the job process at the time of the event, in MB.
- 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.
- flags: List[str]#
List of flags associated with this event.
- id: str#
- job_uid: str#
Job UID that this event belongs to.
- meta: Dict[str, Any]#
Metadata associated with this event.
- project_uid: str#
Project UID that this event belongs to.
- updated_at: datetime#
When this object was last modified.
- class ImageEvent#
An event with an image and optional text. Used for plots.
Attributes:
Available worker system memory at the time of the event, in MB.
CPU memory used by the job process at the time of the event, in MB.
When this object was first created.
List of flags associated with this event.
List of image assets associated with the event.
Job UID that this event belongs to.
Metadata associated with this event.
Project UID that this event belongs to.
Text description of the image event.
Image events always have type 'image'.
When this object was last modified.
- avail_mb: float | None#
Available worker system memory at the time of the event, in MB.
- cpumem_mb: float | None#
CPU memory used by the job process at the time of the event, in MB.
- 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.
- flags: List[str]#
List of flags associated with this event.
- id: str#
- imgfiles: List[GridFSAsset]#
List of image assets associated with the event.
- job_uid: str#
Job UID that this event belongs to.
- meta: Dict[str, Any]#
Metadata associated with this event.
- project_uid: str#
Project UID that this event belongs to.
- text: str#
Text description of the image event.
- type: Literal['image']#
Image events always have type ‘image’.
- updated_at: datetime#
When this object was last modified.
- class InteractiveEvent#
An event with an interactive plot and optional text. Used for 3D scatter plots.
Attributes:
Available worker system memory at the time of the event, in MB.
List of data component indices included in this interactive event.
CPU memory used by the job process at the time of the event, in MB.
When this object was first created.
in v4 the fileid field was stored as an ObjectID instead of str.
List of flags associated with this event.
Job UID that this event belongs to.
Metadata associated with this event.
List of preview image files associated with the interactive event.
Project UID that this event belongs to.
Subtype of interactive event, e.g. '3dscatter'.
Interactive events always have type 'interactive'.
When this object was last modified.
- avail_mb: float | None#
Available worker system memory at the time of the event, in MB.
- components: List[int]#
List of data component indices included in this interactive event.
- cpumem_mb: float | None#
CPU memory used by the job process at the time of the event, in MB.
- 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.
- datafile: GridFSAsset#
in v4 the fileid field was stored as an ObjectID instead of str. If a user needs to downgrade an migrate the fileid back to ObjectID, use the following commands:
csm icli from bson import ObjectId interactive_events = db.events.find({"type": "interactive"}) for event in interactive_events: db.events.update_one({"_id": event["_id"]}, {"$set": {"datafile.fileid": ObjectId(event["datafile"]["fileid"])}})
- Type:
Legacy note
- flags: List[str]#
List of flags associated with this event.
- id: str#
- job_uid: str#
Job UID that this event belongs to.
- meta: Dict[str, Any]#
Metadata associated with this event.
- preview_imgfiles: List[InteractiveImgfile]#
List of preview image files associated with the interactive event.
- project_uid: str#
Project UID that this event belongs to.
- subtype: str#
Subtype of interactive event, e.g. ‘3dscatter’.
- text: str#
- type: Literal['interactive']#
Interactive events always have type ‘interactive’.
- updated_at: datetime#
When this object was last modified.
- class InteractiveImgfile#
An image file associated with an interactive event, along with its components.
Attributes:
List of data component indices which this image file represents.
List of image assets.
- components: List[int]#
List of data component indices which this image file represents.
- imgfiles: List[GridFSAsset]#
List of image assets.
- class TextEvent#
An event with only text and no additional image or interactive data. May have “text”, “warning” or “error” type.
Attributes:
Available worker system memory at the time of the event, in MB.
CPU memory used by the job process at the time of the event, in MB.
When this object was first created.
List of flags associated with this event.
Job UID that this event belongs to.
Metadata associated with this event.
Project UID that this event belongs to.
Text content of the event.
'text', 'warning', or 'error'.
When this object was last modified.
- avail_mb: float | None#
Available worker system memory at the time of the event, in MB.
- cpumem_mb: float | None#
CPU memory used by the job process at the time of the event, in MB.
- 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.
- flags: List[str]#
List of flags associated with this event.
- id: str#
- job_uid: str#
Job UID that this event belongs to.
- meta: Dict[str, Any]#
Metadata associated with this event.
- project_uid: str#
Project UID that this event belongs to.
- text: str#
Text content of the event.
- type: Literal['text', 'warning', 'error']#
‘text’, ‘warning’, or ‘error’.
- Type:
Type of text event
- updated_at: datetime#
When this object was last modified.