Built-in Types

ProjectMetadata

Project metadata.

Bases

dataclass

Field	Type	Description
name	`str`	The name of the project, for example: `"My Cool Project"`

TagMetadata

Tag metadata.

Bases

dataclass

Field	Type	Description
name	`str`	The name of the tag
color	`str`	The color code of the tag, for example: `"#73aaff"`
description	`str`	The description of the tag.

Pagination

Pagination parameters.

Bases

dataclass

Field	Type	Description
page	`str`	A string that represents the page of results
limit	`int`	A limit on the number of objects to be returned, the Limit can range between 1 and 100, and the default is 100

AssetFilter

Asset list filter.

Bases

dataclass

Field	Type	Description
groups	`List[str]`	The filter groups.
filename	`str`	The query filename.
status	`str`	The status of the asset, enum: [`Annotated`, `Review`, `Completed`, `Tofix`, `None`]
metadata_query	`str`	The metadata query string. Please refer Here.

AssetMetadata

Asset Metadata.

📘
The custom metadata size that can be attached depends on your price plan. Please reference here for more information!

🚧
Only single-layered JSON objects are allowed to be uploaded as metadata. Examples of supported metadata types include strings, integers, floats. and boolean values. Nested lists and dictionaries are currently not supported.

Bases

dataclass

Field	Type	Description
status	`str`	The status of the asset, enum: [`Annotated`, `Review`, `Completed`, `Tofix`, `None`]
custom_metadata	`dict`	This metadata dictionary should contain the metadata information you want to preserve or add for use on the Nexus platform.

AnnotationFilter

Annotation list filter.

Bases

dataclass

Field	Type	Description
asset_ids	`List[str]`	The list of asset ids.

AnnotationMetadata

Annotation metadata.

Bases

dataclass

Field	Type	Description
asset_id	`str`	The id of the asset, example: `"asset_9f61bab8-ec60-476f-a1cf-63eca5c313dd"`
tag	`str`	The name of the tag
bound_type	`str`	The bound type of the annotation, Enum: [`Polygon`, `Rectangle`,`Classification`,`Keypoints`]
bound	`list`	The bound of the annotation, example: `[[0.0325, 0.8436],[0.0325, 0.9094],[0.1275, 0.9094],[0.1275, 0.8431]]`

AnnotationExportOptions

Annotation export options.

Bases

dataclass

Field	Type	Description
split_ratio	`int`	The ratio used to split the data into training and validation sets
seed	`int`	The number used to initialize a pseudorandom number generator
normalized	`bool`	The boolean indication on whether the exported annotations should be shuffled

AnnotationExportMetadata

Annotation Export Metadata.

Bases

dataclass

Field	Type	Description
format	AnnotationExportFormat	The format to export the annotations.
options	AnnotationExportOptions	The options to export the annotations

AssetMetadata

Asset Metadata.

📘
The custom metadata size that can be attached depends on your price plan. Please reference here for more information!

Bases

dataclass

Field	Type	Description
status	`str`	The status of the asset, enum: [`Annotated`, `Review`, `Completed`, `Tofix`, `None`]
custom_metadata	`dict`	This metadata dictionary should contain the metadata information you want to preserve or add for use on the Nexus platform.

AnnotationExportFormat

Annotation export formats.

Bases

Enum

Type	Description
`str`	The format of the annotation. Classification: class` \| Field \| Type \| Description Bounding Box*: \| \| :---- \| :---- \| :-------------------------------------------------------- \| \| name \| `str` \| The name o Segmentation*: mple: `"My Cool Project"` \| Keypoint**: g metadata.

Type

Description

str

The format of the annotation.

Classification*: class`

| Field | Type | Description
Bounding Box*: | | :---- | :---- | :-------------------------------------------------------- | | name | str | The name o
Segmentation*: mple: "My Cool Project" |
Keypoint*: g metadata.

FlowMetadata

Workflow Metadata.

Bases

dataclass

Field	Type	Description
title	`str`	The title of the Workflow, for example: `"New workflow title"`

RunSetupMetadata

Training settings.

Bases

dataclass

Field	Type	Description
accelerator	Accelerator	The hardware accelerator to use for the training run
checkpoint	Checkpoint	The checkpoint strategy name for the training run.
limit	Limit	The limit configuration for the training
preview	`bool`	A boolean value indicating whether to enable preview for the training
matrix	`bool`	A boolean value indicating whether to enable the matrix for the training

Accelerator

Run Accelerator Metadata.

Bases

dataclass

Field	Type	Description
name	`str`	The GPU type to use for the training run, enum: GPU_T4`,` GPU_L4`,`GPU_P100`,`GPU_V100`,`GPU_A100_40GB`]
count	`int`	The number of GPUs to use for the training run

Checkpoint

Run Checkpoint Metadata.

Bases

dataclass

Field	Type	Description
strategy	`str`	The checkpointing strategy name for the training, enum: `STRAT_EVERY_N_EPOCH`, `STRAT_ALWAYS_SAVE_LATEST`, `STRAT_LOWEST_VALIDATION_LOSS`, `STRAT_HIGHEST_ACCURACY`]
metric	`str`	The checkpointing metric for the training, enum: Loss/total_loss`,` Loss/regularization_loss`,` Loss/localization_loss`,` Loss/classification_loss`,` DetectionBoxes_Precision/mAP`,` DetectionBoxes_Precision/[email protected]`,` DetectionBoxes_Precision/mAP (small)`,` DetectionBoxes_Precision/mAP (medium)`,` DetectionBoxes_Precision/mAP (large)`,` DetectionBoxes_Recall/AR@1`,` DetectionBoxes_Recall/AR@10`,` DetectionBoxes_Recall/AR@100`,` DetectionBoxes_Recall/AR@100 (small)`,` DetectionBoxes_Recall/AR@100 (medium)`,` DetectionBoxes_Recall/AR@100 (large)`]
evaluation_interval	`int`	The checkpoint evaluation interval value for the training

Limit

Run Limit Metadata.

Bases

dataclass

Field	Type	Description
metric	`str`	The limit metric for the training, enum: LIM_MINUTE`,` LIM_EPOCH`,` LIM_NONE`]
value	`int`	The limit metric value for the training

ArtifactFilters

Artifact filters data class.

Bases

dataclass

Field	Type	Description
run_ids	`List[str]`	The list of run ids.

ArtifactExportMetadata

Artifact exporting settings.

Bases

dataclass

Field	Type	Description
format	`str`	The format of the artifact exports, enum: ONNX`,` TensorFlow`,` PyTorch`,` TFLite`]
quantization	`str`	The quantization of the artifact exports, optional.

DeploymentMetadata

Deployment settings.

Bases

dataclass

Field	Type	Description
name	`str`	The name of the inference API instance
artifact_id	`int`	The unique identifier of the artifact to deploy
num_of_instances	`int`	The number of the inference API instances to deploy
version_tag	`str`	The current version tag of the inference instance.
resources	DeploymentResources	The resource allocation for the deployment instance, optional.
options	DeploymentOptions	The configuration options for the deployment instance, optional.

DeploymentResources

The resource allocation for the deployment instance, optional.

Bases

dataclass

Field	Type	Description
GPU_T4	`int`	The number of NVIDIA Tesla T4 GPUs to allocate to each Inference API instance, optional.

DeploymentOptions

The configuration options for creating each deployment API instance, optional.

Bases

dataclass

Field	Type	Description
evaluation_strategy	`str`	The evaluation strategy to use of each Inference API, default `entropy_score`.
evaluation_threshold	`int`	The evaluation threshold to use to trigger post-evaluation actions, default `0.5`.
evaluation_group	`str`	The asset group to which assets triggered by the active learning route will be uploaded, is a comma-separated list.

SequenceFilter

The filter to be applie

Bases

dataclass

Field	Type	Description
sequence_id	`str`	The query sequence ID.

SequenceLinkMetadata

Bases

dataclass

Field	Type	Description
name	`str`	Sequence name to link the asset to. If the sequence does not exist, it will be created automatically.
merge	`str`	String enum of how the asset should be merged into the sequence if it already exists within the sequence. `SequenceMergeMode.REPLACE_EXISTING_ENTRY`: When linking an asset to a sequence, overwrite any existing sequence entry which conflicts with the incoming entry. `RejectSequenceOperation`: When linking an asset to a sequence, cause the action to fail if it conflicts with an existing sequence entry.
ord	`Optional[int]`	An optional field to specify a unique position the asset will be placed in within the sequence.
role	`Optional[str]`	An optional field to specify the role. This may be shared across multiple assets.

SequencePatch

Bases

dataclass

Field	Type	Description
name	`str`	The name of the sequence. If the sequence with the specified name does not exist, it will automatically be created.
attributes	`dict[str, str]`	A dictionary containing key-value pairs of attributes.

SequenceAction

You may only specify up to 500 actions in a single bulk update. All SequenceBulkUpdateActionLink actions are executed first, followed by all SequenceBulkUpdateActionPatchSequence actions, followed by all SequenceBulkUpdateRemoveSequence actions.

For all SequenceBulkUpdateActionLink actions within a single bulk update, a single asset may be linked and unlinked at most once. You will get the error result FAILED_LINK_ASSET_ALREADY_PROCESSED if you refer to the same asset by ID in one action and by filename in another action.

For all SequenceBulkUpdateActionPatchSequence actions within a single bulk update, a single sequence may be updated at most once. You will get the error result FAILED_PATCH_SEQUENCE_SEQUENCE_ALREADY_PROCESSED if you referring to the same sequence by ID in one action and by name in another action.

For all SequenceBulkUpdateRemoveSequence actions within a single bulk update, a single sequence may be updated at most once. You will get the error result FAILED_REMOVE_SEQUENCE_SEQUENCE_ALREADY_PROCESSED if you refer to the same sequence by ID in one action and by name in another action.

Bases

dataclass

SequenceBulkUpdateActionLink

Links or unlinks an asset from a specified sequence. If the specified sequence does not exist, it will automatically be created. To unlink the asset, simply exclude the sequence field.

Note that either asset_id or asset_filename should be specified. You should not specify both, as that will return an error.

Field	Type	Description
sequence	`SequenceLinkMetadata`	The metadata of the asset to be linked.
asset_id	`str`	The ID of the asset to be linked. If this is specified, the `asset_filename` field should be excluded.
asset_filename	`str`	The filename of the asset to be linked. If this is specified, the `asset_id` field should be excluded.

SequenceBulkUpdateActionPatchSequence

Patches the metadata of a specified sequence, such as the name and attributes.

Field	Type	Description
sequence_id	`str`	The ID of the sequence to modify. If this is specified, the `sequence_name` field should be excluded.
sequence_name	`str`	The name of the sequence to modify. If this is specified, the `sequence_id` field should be excluded.
patch	`SequencePatch`	The patch metadata to apply to the sequence.

SequenceBulkUpdateActionRemoveSequence

❗️
Removing a sequence is irreversible. Please be sure before you remove a sequence.

Removes a sequence entirely. This will unlink all assets within the sequence, and remove all attributes associated with the sequence.

Field	Type	Description
sequence_id	`str`	The ID of the sequence to modify. If this is specified, the `sequence_name` field should be excluded.
sequence_name	`str`	The name of the sequence to modify. If this is specified, the `sequence_id` field should be excluded.