Skip to content

Studio Client

EdgeFirst Client Library This library provides a client for the EdgeFirst API, allowing users to interact with the EdgeFirst Studio Server and perform various operations such as logging in, managing projects, and working with datasets and snapshots.

This is the Python API binding for the EdgeFirst Client Library. A Rust library and a command-line interface are also available. The CLI tool is bundled with the Python wheel and can be called using the edgefirst-client command.

The Python API is available as the edgefirst_client module. The main class is Client, which provides methods for interacting with the EdgeFirst Studio Server. To use the Client object you need to create an instance, with an optional authentication token or username and password.

__all__ module-attribute 

__all__ = [
    "ProjectID",
    "DatasetID",
    "ExperimentID",
    "OrganizationID",
    "SampleID",
    "AnnotationSetID",
    "TaskID",
    "TrainingSessionID",
    "ValidationSessionID",
    "SnapshotID",
    "ImageId",
    "SequenceId",
    "AppId",
    "FileTokenStorage",
    "MemoryTokenStorage",
    "Client",
    "Project",
    "Experiment",
    "TrainingSession",
    "ValidationSession",
    "Snapshot",
    "SnapshotRestoreResult",
    "SnapshotFromDatasetResult",
    "AnnotationSet",
    "Group",
    "Label",
    "AnnotationType",
    "Dataset",
    "Box2d",
    "Box3d",
    "Polygon",
    "Sample",
    "SampleFile",
    "FileType",
    "Annotation",
    "PresignedUrl",
    "SamplesCountResult",
    "SamplesPopulateResult",
    "DatasetParams",
    "Parameter",
    "Task",
    "TaskInfo",
    "Stage",
    "version",
    "is_polars_enabled",
    "coco_to_arrow",
    "arrow_to_coco",
]

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

__cached__ module-attribute 

__cached__ = "/opt/hostedtoolcache/Python/3.10.20/x64/lib/python3.10/site-packages/edgefirst_client/__pycache__/__init__.cpython-310.pyc"

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__doc__ module-attribute 

__doc__ = "EdgeFirst Client Library\nThis library provides a client for the EdgeFirst API, allowing users to\ninteract with the EdgeFirst Studio Server and perform various operations\nsuch as logging in, managing projects, and working with datasets and\nsnapshots.\n\nThis is the Python API binding for the EdgeFirst Client Library.  A Rust\nlibrary and a command-line interface are also available.  The CLI tool is\nbundled with the Python wheel and can be called using the\n`edgefirst-client` command.\n\nThe Python API is available as the `edgefirst_client` module.  The main\nclass is `Client`, which provides methods for interacting with the EdgeFirst\nStudio Server.  To use the `Client` object you need to create an instance,\nwith an optional authentication token or username and password."

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__file__ module-attribute 

__file__ = "/opt/hostedtoolcache/Python/3.10.20/x64/lib/python3.10/site-packages/edgefirst_client/__init__.py"

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__name__ module-attribute 

__name__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__package__ module-attribute 

__package__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__path__ module-attribute 

__path__ = [
    "/opt/hostedtoolcache/Python/3.10.20/x64/lib/python3.10/site-packages/edgefirst_client"
]

Built-in mutable sequence.

If no argument is given, the constructor creates a new empty list. The argument must be an iterable if specified.

Annotation

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

box2d property 

box2d

box2d_score property 

box2d_score

Confidence score for the 2D bounding box.

box3d property 

box3d

box3d_score property 

box3d_score

Confidence score for the 3D bounding box.

group property 

group

iscrowd property 

iscrowd

Whether this annotation marks a crowd region.

label property 

label

label_index property 

label_index

mask property 

mask

The raster mask as raw PNG bytes, if available.

mask_score property 

mask_score

Confidence score for the raster mask.

name property 

name

object_id property 

object_id

polygon property 

polygon

polygon_score property 

polygon_score

Confidence score for the polygon segmentation.

sample_id property 

sample_id

sequence_name property 

sequence_name

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

set_box2d method descriptor 

set_box2d(box2d)

Sets the 2D bounding box for this annotation.

set_box2d_score method descriptor 

set_box2d_score(score)

Sets the 2D bounding box confidence score.

set_box3d method descriptor 

set_box3d(box3d)

Sets the 3D bounding box for this annotation.

set_box3d_score method descriptor 

set_box3d_score(score)

Sets the 3D bounding box confidence score.

set_iscrowd method descriptor 

set_iscrowd(iscrowd)

Sets the iscrowd flag for this annotation.

set_label method descriptor 

set_label(label)

Sets the label for this annotation.

set_mask method descriptor 

set_mask(mask)

Sets the raster mask (PNG bytes) for this annotation.

Validates that the bytes are a valid grayscale PNG before storing.

Errors

Raises ValueError if the bytes are not a valid grayscale PNG.

set_mask_score method descriptor 

set_mask_score(score)

Sets the mask confidence score.

set_object_id method descriptor 

set_object_id(object_id)

Sets the object identifier for this annotation.

set_polygon method descriptor 

set_polygon(polygon)

Sets the polygon for this annotation.

set_polygon_score method descriptor 

set_polygon_score(score)

Sets the polygon confidence score.

AnnotationSet

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

created property 

created

dataset_id property 

dataset_id

description property 

description

id property 

id

name property 

name

uid property 

uid

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

annotations method descriptor 

annotations(
    groups=Ellipsis,
    annotation_types=Ellipsis,
    progress=None,
)

Get annotations for this annotation set.

Parameters:

  • groups –

    List of dataset groups (train, val, test)

  • annotation_types –

    List of annotation types to filter

  • progress –

    Optional callback for fetch progress. Supports two signatures: - callback(current, total) - basic progress (backwards compatible) - callback(current, total, status) - with status message (v2.8.0+)

Progress

Reports progress with status=None as samples are fetched and processed for their annotations. Progress unit is samples processed (not individual annotations).

Returns:

  • –

    List[Annotation]: Annotations in this set

delete method descriptor 

delete()

Delete this annotation set.

Requires an embedded client reference (annotation sets returned by the client methods automatically have one).

If the AnnotationSet was created without a client reference, use client.delete_annotation_set(annotation_set.id) instead.

AnnotationSetID

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

value property 

value

__eq__ method descriptor 

__eq__(value)

Return self==value.

__ge__ method descriptor 

__ge__(value)

Return self>=value.

__gt__ method descriptor 

__gt__(value)

Return self>value.

__hash__ method descriptor 

__hash__()

Return hash(self).

__int__ method descriptor 

__int__()

int(self)

__le__ method descriptor 

__le__(value)

Return self<=value.

__lt__ method descriptor 

__lt__(value)

Return self<value.

__ne__ method descriptor 

__ne__(value)

Return self!=value.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

__str__ method descriptor 

__str__()

Return str(self).

AnnotationType

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__int__ method descriptor 

__int__()

int(self)

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

AppId

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

value property 

value

__eq__ method descriptor 

__eq__(value)

Return self==value.

__ge__ method descriptor 

__ge__(value)

Return self>=value.

__gt__ method descriptor 

__gt__(value)

Return self>value.

__hash__ method descriptor 

__hash__()

Return hash(self).

__int__ method descriptor 

__int__()

int(self)

__le__ method descriptor 

__le__(value)

Return self<=value.

__lt__ method descriptor 

__lt__(value)

Return self<value.

__ne__ method descriptor 

__ne__(value)

Return self!=value.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

__str__ method descriptor 

__str__()

Return str(self).

Box2d

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

cx property 

cx

cy property 

cy

height property 

height

left property 

left

top property 

top

width property 

width

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

Box3d

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

cx property 

cx

cy property 

cy

cz property 

cz

front property 

front

height property 

height

left property 

left

length property 

length

top property 

top

width property 

width

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

Client

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

server property 

server

Returns the server name for the current client (e.g., "saas", "test").

token_expiration property 

token_expiration

url property 

url

username property 

username

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

annotations method descriptor 

annotations(
    annotation_set_id,
    groups=Ellipsis,
    annotation_types=Ellipsis,
    progress=None,
)

Get annotations from an annotation set.

Parameters:

  • annotation_set_id –

    ID of the annotation set

  • groups –

    List of dataset groups (train, val, test)

  • annotation_types –

    List of annotation types to filter

  • progress –

    Optional callback for fetch progress. Supports two signatures: - callback(current, total) - basic progress (backwards compatible) - callback(current, total, status) - with status message (v2.8.0+)

Progress

Reports progress with status=None as samples are fetched and processed for their annotations. Progress unit is samples processed (not individual annotations).

Returns:

  • –

    List of Annotation objects

create_snapshot method descriptor 

create_snapshot(path, progress=None)

Create a new snapshot from an MCAP file or EdgeFirst Dataset directory.

Arguments
  • path - Local path to an MCAP file or directory containing EdgeFirst Dataset Format files
  • progress - Optional progress callback. Called with (current, total) bytes or (current, total, status) (v2.8.0+)
Returns

Returns the created Snapshot object.

create_snapshot_edgefirst_format method descriptor 

create_snapshot_edgefirst_format(
    arrow_path, zip_path, description=None, progress=None
)

Create a snapshot directly from EdgeFirst Dataset Format files.

Uploads an Arrow annotations file and a ZIP media archive as a new snapshot. Faster than create_snapshot when you already have EDF files.

Arguments
  • arrow_path - Local path to the .arrow annotations file
  • zip_path - Local path to the .zip media archive
  • description - Optional snapshot description (defaults to Arrow file stem)
  • progress - Optional progress callback with (current, total) bytes or (current, total, status)

create_snapshot_from_dataset method descriptor 

create_snapshot_from_dataset(
    dataset_id, description, annotation_set_id=None
)

Create a snapshot from an existing dataset on the server.

Triggers server-side snapshot generation which exports the dataset's images and annotations into a downloadable EdgeFirst Dataset Format.

Parameters:

  • dataset_id –

    The dataset ID to create snapshot from (DatasetID or string like "ds-xxx").

  • description –

    Description for the created snapshot.

  • annotation_set_id –

    Optional annotation set ID. If not provided, uses the "annotations" set or first available.

Returns:

  • –

    SnapshotFromDatasetResult containing the snapshot ID and task ID.

Example

result = client.create_snapshot_from_dataset( ... "ds-12345", "My Dataset Backup" ... ) print(f"Created snapshot: {result.id}") if result.task_id: ... client.task(result.task_id, monitor=True)

download_artifact method descriptor 

download_artifact(
    training_session_id,
    modelname,
    filename=None,
    progress=None,
)

Download a training artifact (exported model) to a local file.

Parameters:

  • training_session_id –

    ID of the training session

  • modelname –

    Name of the model artifact to download

  • filename –

    Optional local filename (defaults to modelname)

  • progress –

    Optional callback for download progress. Supports two signatures: - callback(current, total) - basic progress (backwards compatible) - callback(current, total, status) - with status message (v2.8.0+)

Progress

Reports progress with status=None as file data is received. Progress unit is bytes downloaded. Total is determined from the HTTP Content-Length header (may be 0 if server doesn't provide it).

download_checkpoint method descriptor 

download_checkpoint(
    training_session_id,
    checkpoint,
    filename=None,
    progress=None,
)

Download a training checkpoint to a local file.

Parameters:

  • training_session_id –

    ID of the training session

  • checkpoint –

    Name of the checkpoint to download

  • filename –

    Optional local filename (defaults to checkpoint name)

  • progress –

    Optional callback for download progress. Supports two signatures: - callback(current, total) - basic progress (backwards compatible) - callback(current, total, status) - with status message (v2.8.0+)

Progress

Reports progress with status=None as file data is received. Progress unit is bytes downloaded. Total is determined from the HTTP Content-Length header (may be 0 if server doesn't provide it).

download_snapshot method descriptor 

download_snapshot(snapshot_id, output, progress=None)

Download a snapshot from EdgeFirst Studio to local storage.

Arguments
  • snapshot_id - The snapshot ID to download
  • output - Local directory path to save the downloaded files
  • progress - Optional progress callback. Called with (current, total) bytes or (current, total, status) (v2.8.0+)

get_or_create_group method descriptor 

get_or_create_group(dataset_id, name)

Get an existing group by name or create a new one.

This method is idempotent: calling it multiple times with the same name returns the same group ID. This makes it safe to use in concurrent workflows.

Parameters:

  • dataset_id –

    The dataset identifier (string, int, or DatasetID

object). name: The group name (e.g., "train", "val", "test").

Returns:

  • int –

    The group ID, which can be passed to set_sample_group_id().

Example
Create groups for a dataset split

train_id = client.get_or_create_group(dataset_id, "train") val_id = client.get_or_create_group(dataset_id, "val")

Assign samples to groups

client.set_sample_group_id(sample1, train_id) client.set_sample_group_id(sample2, val_id)

groups method descriptor 

groups(dataset_id)

List all groups for a dataset.

Groups organize samples into logical subsets such as "train", "val", and "test". This method retrieves all groups that have been created for the specified dataset.

Parameters:

  • dataset_id –

    The dataset identifier (string, int, or DatasetID

object).

Returns:

  • –

    List[Group]: All groups associated with this dataset.

Example

groups = client.groups(dataset_id) for group in groups: ... print(f"{group.name} (id={group.id})") train (id=1) val (id=2) test (id=3)

populate_samples method descriptor 

populate_samples(
    dataset_id, annotation_set_id, samples, progress=None
)

Populate samples into a dataset with automatic file uploads.

This method creates new samples in the specified dataset and automatically uploads their associated files (images, LiDAR, etc.) to S3 using presigned URLs.

The server will auto-generate UUIDs and extract image dimensions for samples that don't have them specified.

Parameters:

  • dataset_id –

    ID of the dataset to populate

  • annotation_set_id –

    ID of the annotation set for sample annotations

  • samples –

    List of Sample objects to create (with files and

annotations) progress: Optional callback for upload progress. Supports two signatures: - callback(current, total) - basic progress (backwards compatible) - callback(current, total, status) - with status message (v2.8.0+)

Progress

Reports progress with status=None as each sample's files are

uploaded. Progress unit is samples (not individual files). Each sample may contain multiple files (image, lidar, radar, etc.) which are all uploaded before the sample is counted as complete.

Returns:

  • –

    List of SamplesPopulateResult objects with UUIDs and presigned URLs

Example

```python from edgefirst_client import Client, Sample, SampleFile, Annotation,

Box2d

client = Client()
sample = Sample()
sample.set_image_name("test.png")
sample.add_file(SampleFile("image", "path/to/test.png"))

annotation = Annotation()
annotation.set_label("car")
annotation.set_box2d(Box2d(10.0, 20.0, 100.0, 50.0))
sample.add_annotation(annotation)

# 2-arg callback (backwards compatible)
results = client.populate_samples(
    dataset_id,
    annotation_set_id,
    [sample],
    lambda curr, total: print(f"{curr}/{total}")
)

# 3-arg callback (with status message)
def progress(curr, total, status):
    msg = f" - {status}" if status else ""
    print(f"{curr}/{total}{msg}")
results = client.populate_samples(dataset_id, ann_set_id, [sample],

progress) ```

populate_samples_with_concurrency method descriptor 

populate_samples_with_concurrency(
    dataset_id,
    samples,
    annotation_set_id=None,
    progress=None,
    concurrency=None,
)

Populate samples with configurable upload concurrency.

Identical to populate_samples but exposes the concurrency knob that controls how many S3 file uploads run in parallel. The default (None) uses the server maximum (32).

Arguments
  • dataset_id - Target dataset
  • samples - List of samples to create
  • annotation_set_id - Optional annotation set (vs. required in populate_samples)
  • progress - Optional progress callback with (current, total) or (current, total, status)
  • concurrency - Max parallel S3 uploads. None uses the default (32)

sample_names method descriptor 

sample_names(dataset_id, groups=Ellipsis, progress=None)

Return the set of sample names in a dataset.

Names are normalised (file extension stripped). Lightweight alternative to samples() when only names are needed.

Arguments
  • dataset_id - Dataset to query
  • groups - Optional list of group names to filter by (empty = all groups)
  • progress - Optional progress callback with (current, total) or (current, total, status)

samples method descriptor 

samples(
    dataset_id,
    annotation_set_id=None,
    annotation_types=Ellipsis,
    groups=Ellipsis,
    types=Ellipsis,
    progress=None,
)

Get samples from a dataset with optional annotations.

Parameters:

  • dataset_id –

    Dataset identifier

  • annotation_set_id –

    Optional annotation set to include annotations from

  • annotation_types –

    Filter by annotation types

  • groups –

    Filter by sample groups (e.g., ["train", "val"])

  • types –

    File types to include (default: [FileType.Image])

  • progress –

    Optional callback for fetch progress. Supports two signatures: - callback(current, total) - basic progress (backwards compatible) - callback(current, total, status) - with status message (v2.8.0+)

Progress

Reports progress with status=None as samples are fetched from the server in paginated batches. Progress unit is samples fetched.

Returns:

  • –

    List of Sample objects

samples_dataframe method descriptor 

samples_dataframe(
    dataset_id,
    annotation_set_id=None,
    groups=Ellipsis,
    annotation_types=Ellipsis,
    progress=None,
)

Get samples as a DataFrame with complete 2025.10 schema.

Parameters:

  • dataset_id –

    Dataset identifier

  • annotation_set_id –

    Optional annotation set filter

  • groups –

    List of dataset groups (train, val, test)

  • annotation_types –

    List of annotation types (bbox, box3d, mask)

  • progress –

    Optional callback for fetch progress. Supports two signatures: - callback(current, total) - basic progress (backwards compatible) - callback(current, total, status) - with status message (v2.8.0+)

Progress

Reports progress with status=None as samples are fetched from the server in paginated batches. Progress unit is samples fetched.

Returns:

  • –

    Polars DataFrame with 13 columns (2025.10 schema)

Example

df = client.samples_dataframe( ... dataset_id, ... annotation_set_id, ... ["train"], ... [], ... None ... )

save_token method descriptor 

save_token()

Persist the current authentication token to the configured storage.

The token is written using the client's configured storage backend. When no custom storage has been configured, the token is saved to an OS-appropriate default location determined at runtime. Callers should not hard-code the path; use the FileTokenStorage class to retrieve it.

set_sample_group_id method descriptor 

set_sample_group_id(sample_id, group_id)

Set the group for a sample.

Assigns a sample to a group, replacing any existing group assignment. Each sample can belong to at most one group at a time.

Parameters:

  • sample_id –

    The sample identifier (string, int, or SampleID object).

  • group_id –

    The group ID to assign (from get_or_create_group()).

Example
Assign a sample to the training group

train_id = client.get_or_create_group(dataset_id, "train") client.set_sample_group_id(sample_id, train_id)

set_stages method descriptor 

set_stages(task_id, stages)

Configures the task stages. Stages are used to show various steps in the task execution process.

task_info method descriptor 

task_info(task_id)

Get the information about a specific task.

task_status method descriptor 

task_status(task_id, status)

Updates the tasks status.

tasks method descriptor 

tasks(name=None, workflow=None, status=None, manager=None)

Get the list of known tasks for the current user. If name is provided then only tasks containing this name will be returned. The task list has basic information about each task, for detailed information use the task_info method with the ID of the desired task.

update_stage method descriptor 

update_stage(task_id, stage, status, message, percentage)

Updates the stage for the given task. This is used to show progress information to the user.

with_login method descriptor 

with_login(username, password)

Authenticate with username and password.

Parameters:

  • username –

    User email or username

  • password –

    User password

Returns:

  • Client –

    A new authenticated client

Example

client = Client().with_server("test") client = client.with_login("user@example.com", "password")

with_memory_storage method descriptor 

with_memory_storage()

Configure in-memory token storage (no persistence).

Tokens are stored in memory only and lost when the application exits.

Returns:

  • Client –

    A new client with memory storage

Example

client = Client().with_memory_storage() client = client.with_login("user", "pass")

with_no_storage method descriptor 

with_no_storage()

Disable token storage entirely.

Tokens are not persisted. Use this when you want to manage tokens entirely manually.

Returns:

  • Client –

    A new client without storage

with_server method descriptor 

with_server(server)

Configure the server instance.

The server parameter is an instance name that maps to a URL:

  • "" or "saas" → https://edgefirst.studio (default)
  • "test" → https://test.edgefirst.studio
  • "stage" → https://stage.edgefirst.studio
  • "dev" → https://dev.edgefirst.studio
  • "{name}" → https://{name}.edgefirst.studio
Server Selection Priority
  1. Token's server (highest) - JWT tokens encode their server.
  2. with_server() - Used when logging in or no token exists.
  3. Default "saas" - If no token and no server specified.
Important

If a token is already set, calling this method will drop it as tokens are server-specific. Use parse_token_server() to check a token's server before calling this method.

Parameters:

  • server –

    Server instance name

Returns:

  • Client –

    A new client connected to the specified server

Example

client = Client().with_server("test")

with_storage method descriptor 

with_storage(storage)

Configure custom token storage.

Parameters:

  • storage –

    A storage object (FileTokenStorage, MemoryTokenStorage, or any object with store/load/clear methods)

Returns:

  • Client –

    A new client with the specified storage

Example

storage = FileTokenStorage.with_path("/custom/path") client = Client().with_storage(storage)

with_token method descriptor 

with_token(token)

Authenticate with a token.

Parameters:

  • token –

    JWT authentication token

Returns:

  • Client –

    A new authenticated client

Example

client = Client().with_token("eyJ...")

Dataset

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

created property 

created

description property 

description

id property 

id

name property 

name

project_id property 

project_id

uid property 

uid

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

add_label method descriptor 

add_label(name_or_client, name=None)

Add a label to this dataset.

New API (v2.6.0+): dataset.add_label("name") - uses embedded client reference Deprecated API: dataset.add_label(client, "name") - passing client explicitly

annotation_sets method descriptor 

annotation_sets()

Get annotation sets for this dataset.

New API (v2.6.0+): dataset.annotation_sets() - uses embedded client reference

Returns:

  • –

    List of AnnotationSet objects associated with this dataset

If the Dataset was created without a client reference (legacy code), use client.annotation_sets(dataset.id) instead.

create_annotation_set method descriptor 

create_annotation_set(name, description=None)

Create a new annotation set on this dataset.

Returns the new annotation set ID as a string.

delete method descriptor 

delete()

Delete this dataset from EdgeFirst Studio.

After deletion the dataset object is no longer valid; any further method calls will fail with a server-side "not found" error.

download method descriptor 

download(
    output,
    groups=Ellipsis,
    types=Ellipsis,
    flatten=False,
    progress=None,
)

Download this dataset to a local directory.

New API (v2.6.0+): dataset.download(output, ...) - uses embedded client reference

Note: For downloading multiple samples, this is the recommended approach as it uses batch downloading for far higher performance compared to downloading samples individually.

Parameters:

  • output –

    Local directory path to save downloaded files

  • groups –

    Filter by sample groups (e.g., ["train", "val"])

  • types –

    File types to download (default: [FileType.Image])

  • flatten –

    If True, download all files to a flat directory structure

  • progress –

    Optional callback for download progress. Supports two signatures: - callback(current, total) - basic progress (backwards compatible) - callback(current, total, status) - with status message (v2.8.0+)

Progress

This operation has two phases with distinct progress reporting:

  1. Fetching metadata (status=None): Retrieves sample information from the server. Progress counts samples fetched.
  2. Downloading files (status="Downloading"): Downloads actual files to disk. Progress counts samples completed.

Applications should detect the status change to reset their progress bar for the second phase.

If the Dataset was created without a client reference (legacy code), use client.download_dataset(dataset.id, ...) instead.

groups method descriptor 

groups()

List all groups in this dataset.

labels method descriptor 

labels(client=None)

Get labels for this dataset.

New API (v2.6.0+): dataset.labels() - uses embedded client reference Deprecated API: dataset.labels(client) - passing client explicitly

If the Dataset was created without a client reference (legacy code), use client.labels(dataset.id) instead.

remove_label method descriptor 

remove_label(name_or_client, name=None)

Remove a label from this dataset by name.

New API (v2.6.0+): dataset.remove_label("name") - uses embedded client reference Deprecated API: dataset.remove_label(client, "name") - passing client explicitly

samples method descriptor 

samples(
    annotation_set_id=None,
    annotation_types=Ellipsis,
    groups=Ellipsis,
    types=Ellipsis,
    progress=None,
)

Get samples for this dataset.

New API (v2.6.0+): dataset.samples(...) - uses embedded client reference

Parameters:

  • annotation_set_id –

    Optional annotation set to include annotations from

  • annotation_types –

    Filter by annotation types

  • groups –

    Filter by sample groups (e.g., ["train", "val"])

  • types –

    File types to include (default: [FileType.Image])

  • progress –

    Optional callback for fetch progress. Supports two signatures: - callback(current, total) - basic progress (backwards compatible) - callback(current, total, status) - with status message (v2.8.0+)

Progress

Reports progress with status=None as samples are fetched from the server in paginated batches. Progress unit is samples fetched.

Returns:

  • –

    List of Sample objects

If the Dataset was created without a client reference (legacy code), use client.samples(dataset.id, ...) instead.

samples_count method descriptor 

samples_count(
    annotation_set_id=None,
    annotation_types=Ellipsis,
    groups=Ellipsis,
    types=Ellipsis,
)

Get the count of samples in this dataset.

New API (v2.6.0+): dataset.samples_count() - uses embedded client reference

Parameters:

  • annotation_set_id –

    Optional annotation set to filter by

  • annotation_types –

    Filter by annotation types

  • groups –

    Filter by sample groups (e.g., ["train", "val"])

  • types –

    File types to count (default: [FileType.Image])

Returns:

  • –

    SamplesCountResult with train/val/test counts

If the Dataset was created without a client reference (legacy code), use client.samples_count(dataset.id, ...) instead.

DatasetID

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

value property 

value

__eq__ method descriptor 

__eq__(value)

Return self==value.

__ge__ method descriptor 

__ge__(value)

Return self>=value.

__gt__ method descriptor 

__gt__(value)

Return self>value.

__hash__ method descriptor 

__hash__()

Return hash(self).

__int__ method descriptor 

__int__()

int(self)

__le__ method descriptor 

__le__(value)

Return self<=value.

__lt__ method descriptor 

__lt__(value)

Return self<value.

__ne__ method descriptor 

__ne__(value)

Return self!=value.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

__str__ method descriptor 

__str__()

Return str(self).

DatasetParams

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

annotation_set_id property 

annotation_set_id

dataset_id property 

dataset_id

train_group property 

train_group

val_group property 

val_group

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

Experiment

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

description property 

description

id property 

id

name property 

name

uid property 

uid

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

training_sessions method descriptor 

training_sessions(name=None)

Get training sessions for this experiment.

ExperimentID

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

value property 

value

__eq__ method descriptor 

__eq__(value)

Return self==value.

__ge__ method descriptor 

__ge__(value)

Return self>=value.

__gt__ method descriptor 

__gt__(value)

Return self>value.

__hash__ method descriptor 

__hash__()

Return hash(self).

__int__ method descriptor 

__int__()

int(self)

__le__ method descriptor 

__le__(value)

Return self<=value.

__lt__ method descriptor 

__lt__(value)

Return self<value.

__ne__ method descriptor 

__ne__(value)

Return self!=value.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

__str__ method descriptor 

__str__()

Return str(self).

FileTokenStorage

File-based token storage for desktop platforms.

Stores the authentication token in a file on the local filesystem. By default, uses the platform-specific config directory.

__doc__ class-attribute 

__doc__ = "File-based token storage for desktop platforms.\n\nStores the authentication token in a file on the local filesystem.\nBy default, uses the platform-specific config directory."

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

path property 

path

Returns the path where the token is stored.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

clear method descriptor 

clear()

Clear the stored token.

load method descriptor 

load()

Load the stored token.

store method descriptor 

store(token)

Store a token.

with_path staticmethod 

with_path(path)

Create a new FileTokenStorage with a custom file path.

FileType

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__int__ method descriptor 

__int__()

int(self)

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

Group

A dataset group for organizing samples into logical subsets.

Groups partition samples within a dataset for purposes such as training, validation, and testing. Common group names include "train", "val", and "test", following conventions from datasets like COCO and ImageNet.

Each sample can belong to at most one group. Groups are managed at the dataset level and can be created, listed, and assigned to samples through the Client.

Example

groups = client.groups(dataset_id) for group in groups: ... print(f"{group.name}: {group.id}") train: 1 val: 2

__doc__ class-attribute 

__doc__ = 'A dataset group for organizing samples into logical subsets.\n\nGroups partition samples within a dataset for purposes such as training,\nvalidation, and testing. Common group names include "train", "val", and\n"test", following conventions from datasets like COCO and ImageNet.\n\nEach sample can belong to at most one group. Groups are managed at the\ndataset level and can be created, listed, and assigned to samples through\nthe Client.\n\nExample:\n    >>> groups = client.groups(dataset_id)\n    >>> for group in groups:\n    ...     print(f"{group.name}: {group.id}")\n    train: 1\n    val: 2'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

id property 

id

The unique numeric identifier for this group.

This ID is used when assigning samples to groups via set_sample_group_id().

name property 

name

The human-readable name of the group (e.g., "train", "val", "test").

Group names are unique within a dataset.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

__str__ method descriptor 

__str__()

Return str(self).

ImageId

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

value property 

value

__eq__ method descriptor 

__eq__(value)

Return self==value.

__ge__ method descriptor 

__ge__(value)

Return self>=value.

__gt__ method descriptor 

__gt__(value)

Return self>value.

__hash__ method descriptor 

__hash__()

Return hash(self).

__int__ method descriptor 

__int__()

int(self)

__le__ method descriptor 

__le__(value)

Return self<=value.

__lt__ method descriptor 

__lt__(value)

Return self<value.

__ne__ method descriptor 

__ne__(value)

Return self!=value.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

__str__ method descriptor 

__str__()

Return str(self).

Label

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

dataset_id property 

dataset_id

id property 

id

index property 

index

name property 

name

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

__str__ method descriptor 

__str__()

Return str(self).

MemoryTokenStorage

In-memory token storage (no persistence).

Stores the authentication token in memory only. The token is lost when the application exits.

__doc__ class-attribute 

__doc__ = "In-memory token storage (no persistence).\n\nStores the authentication token in memory only. The token is lost when\nthe application exits."

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

clear method descriptor 

clear()

Clear the stored token.

load method descriptor 

load()

Load the stored token.

store method descriptor 

store(token)

Store a token.

OrganizationID

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

value property 

value

__eq__ method descriptor 

__eq__(value)

Return self==value.

__ge__ method descriptor 

__ge__(value)

Return self>=value.

__gt__ method descriptor 

__gt__(value)

Return self>value.

__hash__ method descriptor 

__hash__()

Return hash(self).

__int__ method descriptor 

__int__()

int(self)

__le__ method descriptor 

__le__(value)

Return self<=value.

__lt__ method descriptor 

__lt__(value)

Return self<value.

__ne__ method descriptor 

__ne__(value)

Return self!=value.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

__str__ method descriptor 

__str__()

Return str(self).

Polygon

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

rings property 

rings

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

PresignedUrl

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

filename property 

filename

key property 

key

url property 

url

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

Project

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

description property 

description

id property 

id

name property 

name

uid property 

uid

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

datasets method descriptor 

datasets(client_or_name=None, name=None)

Get datasets for this project.

New API (v2.6.0+): project.datasets() - uses embedded client reference Deprecated API: project.datasets(client) - passing client explicitly

experiments method descriptor 

experiments(client_or_name=None, name=None)

Get experiments for this project.

New API (v2.6.0+): project.experiments() - uses embedded client reference Deprecated API: project.experiments(client) - passing client explicitly

validation_sessions method descriptor 

validation_sessions(client=None)

Get validation sessions for this project.

New API (v2.6.0+): project.validation_sessions() - uses embedded client reference Deprecated API: project.validation_sessions(client) - passing client explicitly

ProjectID

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

value property 

value

__eq__ method descriptor 

__eq__(value)

Return self==value.

__ge__ method descriptor 

__ge__(value)

Return self>=value.

__gt__ method descriptor 

__gt__(value)

Return self>value.

__hash__ method descriptor 

__hash__()

Return hash(self).

__int__ method descriptor 

__int__()

int(self)

__le__ method descriptor 

__le__(value)

Return self<=value.

__lt__ method descriptor 

__lt__(value)

Return self<value.

__ne__ method descriptor 

__ne__(value)

Return self!=value.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

__str__ method descriptor 

__str__()

Return str(self).

Sample

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

annotations property 

annotations

date property 

date

files property 

files

frame_number property 

frame_number

group property 

group

height property 

height

id property 

id

image_name property 

image_name

image_url property 

image_url

name property 

name

sequence_description property 

sequence_description

sequence_name property 

sequence_name

sequence_uuid property 

sequence_uuid

source property 

source

timing property 

timing

Pipeline timing measurements (nanoseconds), if available.

Returns a dict with keys load, preprocess, inference, decode, each Optional[int] in nanoseconds.

uid property 

uid

uuid property 

uuid

width property 

width

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

add_annotation method descriptor 

add_annotation(annotation)

Adds an annotation to this sample.

add_file method descriptor 

add_file(file)

Adds a file to this sample.

assign_group method descriptor 

assign_group(group_id)

Assign this sample to a server-side group.

Groups are used to organize samples into splits such as "train", "val", and "test". Use :meth:Dataset.groups to list available groups, or :meth:Client.get_or_create_group to create one.

Requires an embedded client reference (samples returned by the client methods automatically have one).

Note: This updates the group assignment on the server. To set the local in-memory group name (for building new samples), use :meth:set_group.

Parameters:

  • group_id –

    Numeric group ID returned by :meth:Client.groups or :meth:Client.get_or_create_group

If the Sample was created without a client reference, use client.set_sample_group_id(sample.id, group_id) instead.

download method descriptor 

download(file_type_or_client=None, file_type=None)

Download sample file data.

New API (v2.6.0+): sample.download(file_type) - uses embedded client reference Deprecated API: sample.download(client, file_type) - passing client explicitly

Note: For downloading multiple samples, use dataset.download() which is far higher performance due to batch downloading.

Parameters:

  • file_type_or_client –

    Either FileType (new API) or Client

(deprecated) file_type: FileType when using deprecated API

Returns:

  • –

    Optional bytes of the downloaded file content

If the Sample was created without a client reference (e.g., Sample.new()), you must use the deprecated API with a client parameter.

set_frame_number method descriptor 

set_frame_number(frame_number)

Sets the frame number for this sample.

set_group method descriptor 

set_group(group)

Sets the group for this sample (e.g., "train", "val", "test").

set_image_name method descriptor 

set_image_name(image_name)

Sets the image filename for this sample.

set_sequence_description method descriptor 

set_sequence_description(sequence_description)

Sets the sequence description for this sample.

set_sequence_name method descriptor 

set_sequence_name(sequence_name)

Sets the sequence name for this sample.

set_sequence_uuid method descriptor 

set_sequence_uuid(sequence_uuid)

Sets the sequence UUID for this sample.

SampleFile

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

file_type property 

file_type

filename property 

filename

url property 

url

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

SampleID

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

value property 

value

__eq__ method descriptor 

__eq__(value)

Return self==value.

__ge__ method descriptor 

__ge__(value)

Return self>=value.

__gt__ method descriptor 

__gt__(value)

Return self>value.

__hash__ method descriptor 

__hash__()

Return hash(self).

__int__ method descriptor 

__int__()

int(self)

__le__ method descriptor 

__le__(value)

Return self<=value.

__lt__ method descriptor 

__lt__(value)

Return self<value.

__ne__ method descriptor 

__ne__(value)

Return self!=value.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

__str__ method descriptor 

__str__()

Return str(self).

SamplesCountResult

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

total property 

total

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

SamplesPopulateResult

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

urls property 

urls

uuid property 

uuid

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

SequenceId

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

value property 

value

__eq__ method descriptor 

__eq__(value)

Return self==value.

__ge__ method descriptor 

__ge__(value)

Return self>=value.

__gt__ method descriptor 

__gt__(value)

Return self>value.

__hash__ method descriptor 

__hash__()

Return hash(self).

__int__ method descriptor 

__int__()

int(self)

__le__ method descriptor 

__le__(value)

Return self<=value.

__lt__ method descriptor 

__lt__(value)

Return self<value.

__ne__ method descriptor 

__ne__(value)

Return self!=value.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

__str__ method descriptor 

__str__()

Return str(self).

Snapshot

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

created property 

created

description property 

description

id property 

id

path property 

path

status property 

status

uid property 

uid

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

delete method descriptor 

delete()

Delete this snapshot.

Requires an embedded client reference (snapshots returned by the client methods automatically have one).

If the Snapshot was created without a client reference, use client.delete_snapshot(snapshot.id) instead.

download method descriptor 

download(output_or_client, output=None, progress=None)

Download this snapshot to a local directory.

New API (v2.6.0+): snapshot.download(output_path) - uses embedded client reference. Deprecated API: snapshot.download(client, output_path) - passing client explicitly.

Arguments
  • output_or_client - Output directory path (new API) or Client (deprecated)
  • output - Output path when using deprecated API
  • progress - Optional progress callback. Called with (current, total) bytes or (current, total, status) (v2.8.0+). status is always None for this operation. Progress is only supported with the new API (embedded client).

If the Snapshot was created without a client reference (legacy code), use client.download_snapshot(snapshot.id, output) instead.

restore method descriptor 

restore(
    project_id,
    topics,
    autolabel,
    autodepth,
    dataset_name=None,
    dataset_description=None,
)

Restore this snapshot into a new dataset.

Requires an embedded client reference (snapshots returned by the client methods automatically have one).

Parameters:

  • project_id –

    The project ID to restore into (ProjectID or string like "proj-xxx")

  • topics –

    List of MCAP topics to include in the restored dataset

  • autolabel –

    List of autolabel pipeline names to run (empty list to skip)

  • autodepth –

    Whether to run the autodepth pipeline

  • dataset_name –

    Optional name for the created dataset

  • dataset_description –

    Optional description for the created dataset

Returns:

  • –

    class:SnapshotRestoreResult with the new dataset and task IDs

SnapshotFromDatasetResult

Result of creating a snapshot from a dataset.

Contains the snapshot ID and optional task ID for monitoring progress.

__doc__ class-attribute 

__doc__ = "Result of creating a snapshot from a dataset.\n\nContains the snapshot ID and optional task ID for monitoring progress."

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

id property 

id

The ID of the created snapshot.

task_id property 

task_id

The task ID for monitoring snapshot creation progress, if available.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

SnapshotID

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

value property 

value

__eq__ method descriptor 

__eq__(value)

Return self==value.

__ge__ method descriptor 

__ge__(value)

Return self>=value.

__gt__ method descriptor 

__gt__(value)

Return self>value.

__hash__ method descriptor 

__hash__()

Return hash(self).

__int__ method descriptor 

__int__()

int(self)

__le__ method descriptor 

__le__(value)

Return self<=value.

__lt__ method descriptor 

__lt__(value)

Return self<value.

__ne__ method descriptor 

__ne__(value)

Return self!=value.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

__str__ method descriptor 

__str__()

Return str(self).

SnapshotRestoreResult

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

annotation_set_id property 

annotation_set_id

dataset_id property 

dataset_id

dataset_name property 

dataset_name

date property 

date

description property 

description

id property 

id

task_id property 

task_id

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

Stage

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

description property 

description

message property 

message

percentage property 

percentage

stage property 

stage

status property 

status

task_id property 

task_id

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

Task

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

created property 

created

id property 

id

instance property 

instance

manager property 

manager

name property 

name

status property 

status

uid property 

uid

workflow property 

workflow

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

TaskID

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

value property 

value

__eq__ method descriptor 

__eq__(value)

Return self==value.

__ge__ method descriptor 

__ge__(value)

Return self>=value.

__gt__ method descriptor 

__gt__(value)

Return self>value.

__hash__ method descriptor 

__hash__()

Return hash(self).

__int__ method descriptor 

__int__()

int(self)

__le__ method descriptor 

__le__(value)

Return self<=value.

__lt__ method descriptor 

__lt__(value)

Return self<value.

__ne__ method descriptor 

__ne__(value)

Return self!=value.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

__str__ method descriptor 

__str__()

Return str(self).

TaskInfo

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

completed property 

completed

created property 

created

description property 

description

id property 

id

project_id property 

project_id

stages property 

stages

status property 

status

uid property 

uid

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

TrainingSession

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

dataset_params property 

dataset_params

description property 

description

experiment_id property 

experiment_id

id property 

id

model property 

model

model_params property 

model_params

name property 

name

task property 

task

uid property 

uid

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

artifacts method descriptor 

artifacts(client=None)

Get artifacts for this training session.

New API (v2.6.0+): session.artifacts() - uses embedded client reference Deprecated API: session.artifacts(client) - passing client explicitly

download method descriptor 

download(filename_or_client, filename=None)

Download a file from the training session.

New API (v2.6.0+): session.download(filename) - uses embedded client reference Deprecated API: session.download(client, filename) - passing client explicitly

Parameters:

  • filename_or_client –

    Either str filename (new API) or Client

(deprecated) filename: str filename when using deprecated API

download_artifact method descriptor 

download_artifact(filename_or_client, filename=None)

Download an artifact file from the training session.

New API (v2.6.0+): session.download_artifact(filename) - uses embedded client reference Deprecated API: session.download_artifact(client, filename) - passing client explicitly

download_checkpoint method descriptor 

download_checkpoint(filename_or_client, filename=None)

Download a checkpoint file from the training session.

New API (v2.6.0+): session.download_checkpoint(filename) - uses embedded client reference Deprecated API: session.download_checkpoint(client, filename) - passing client explicitly

metrics method descriptor 

metrics(client=None)

Get metrics for this training session.

New API (v2.6.0+): session.metrics() - uses embedded client reference Deprecated API: session.metrics(client) - passing client explicitly

set_metrics method descriptor 

set_metrics(metrics_or_client, metrics=None)

Set metrics for this training session.

New API (v2.6.0+): session.set_metrics(metrics) - uses embedded client reference Deprecated API: session.set_metrics(client, metrics) - passing client explicitly

upload method descriptor 

upload(files_or_client, files=None)

Upload files to the training session.

New API (v2.6.0+): session.upload(files) - uses embedded client reference Deprecated API: session.upload(client, files) - passing client explicitly

Parameters:

  • files_or_client –

    Either List[Tuple[str, Path]] (new API) or Client

(deprecated) files: List[Tuple[str, Path]] when using deprecated API

upload_artifact method descriptor 

upload_artifact(
    filename_or_client, filename_or_path=None, path=None
)

Upload an artifact file to the training session.

New API (v2.6.0+): session.upload_artifact(filename, path) - uses embedded client reference Deprecated API: session.upload_artifact(client, filename, path) - passing client explicitly

upload_checkpoint method descriptor 

upload_checkpoint(
    filename_or_client, filename_or_path=None, path=None
)

Upload a checkpoint file to the training session.

New API (v2.6.0+): session.upload_checkpoint(filename, path) - uses embedded client reference Deprecated API: session.upload_checkpoint(client, filename, path) - passing client explicitly

TrainingSessionID

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

value property 

value

__eq__ method descriptor 

__eq__(value)

Return self==value.

__ge__ method descriptor 

__ge__(value)

Return self>=value.

__gt__ method descriptor 

__gt__(value)

Return self>value.

__hash__ method descriptor 

__hash__()

Return hash(self).

__int__ method descriptor 

__int__()

int(self)

__le__ method descriptor 

__le__(value)

Return self<=value.

__lt__ method descriptor 

__lt__(value)

Return self<value.

__ne__ method descriptor 

__ne__(value)

Return self!=value.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

__str__ method descriptor 

__str__()

Return str(self).

ValidationSession

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

annotation_set_id property 

annotation_set_id

dataset_id property 

dataset_id

description property 

description

experiment_id property 

experiment_id

id property 

id

name property 

name

params property 

params

task property 

task

training_session_id property 

training_session_id

uid property 

uid

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

artifacts method descriptor 

artifacts(client=None)

Get artifacts for this validation session.

New API (v2.6.0+): session.artifacts() - uses embedded client reference Deprecated API: session.artifacts(client) - passing client explicitly

Note: Returns artifacts from the associated training session.

download_artifact method descriptor 

download_artifact(filename)

Download an artifact file from the associated training session.

Returns the file content as bytes.

Parameters:

  • filename –

    Name of the artifact file to download (e.g., "labels.txt")

Returns:

  • bytes –

    The downloaded file content

download_checkpoint method descriptor 

download_checkpoint(filename)

Download a checkpoint file from the associated training session.

Returns the file content as bytes.

Parameters:

  • filename –

    Name of the checkpoint file to download (e.g., "best.pt")

Returns:

  • bytes –

    The downloaded file content

metrics method descriptor 

metrics(client=None)

Get metrics for this validation session.

New API (v2.6.0+): session.metrics() - uses embedded client reference Deprecated API: session.metrics(client) - passing client explicitly

set_metrics method descriptor 

set_metrics(metrics_or_client, metrics=None)

Set metrics for this validation session.

New API (v2.6.0+): session.set_metrics(metrics) - uses embedded client reference Deprecated API: session.set_metrics(client, metrics) - passing client explicitly

upload method descriptor 

upload(files_or_client, files=None)

Upload files to the validation session.

New API (v2.6.0+): session.upload(files) - uses embedded client reference Deprecated API: session.upload(client, files) - passing client explicitly

ValidationSessionID

__doc__ class-attribute 

__doc__ = ''

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

__module__ class-attribute 

__module__ = 'edgefirst_client'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

value property 

value

__eq__ method descriptor 

__eq__(value)

Return self==value.

__ge__ method descriptor 

__ge__(value)

Return self>=value.

__gt__ method descriptor 

__gt__(value)

Return self>value.

__hash__ method descriptor 

__hash__()

Return hash(self).

__int__ method descriptor 

__int__()

int(self)

__le__ method descriptor 

__le__(value)

Return self<=value.

__lt__ method descriptor 

__lt__(value)

Return self<value.

__ne__ method descriptor 

__ne__(value)

Return self!=value.

__new__ builtin 

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

__repr__ method descriptor 

__repr__()

Return repr(self).

__str__ method descriptor 

__str__()

Return str(self).

arrow_to_coco builtin 

arrow_to_coco(
    arrow_path,
    output_path,
    include_masks=True,
    groups=Ellipsis,
    progress=None,
)

Convert EdgeFirst Arrow format to COCO dataset.

Arguments

  • arrow_path - Path to EdgeFirst Arrow file
  • output_path - Output COCO JSON file path
  • include_masks - Include segmentation masks (default: True)
  • groups - Filter by group names (empty list = all)
  • progress - Optional callback function(current, total) for progress

Returns

Number of annotations converted

coco_to_arrow builtin 

coco_to_arrow(
    coco_path,
    output_path,
    include_masks=True,
    group=None,
    progress=None,
)

Convert COCO dataset to EdgeFirst Arrow format.

Arguments

  • coco_path - Path to COCO annotation JSON file or ZIP archive
  • output_path - Output Arrow file path
  • include_masks - Include segmentation masks (default: True)
  • group - Optional group name for all samples (e.g., "train")
  • progress - Optional callback function(current, total) for progress

Returns

Number of annotations converted

is_polars_enabled builtin 

is_polars_enabled()

version builtin 

version()