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__ = [
    "ID",
    "Client",
    "Project",
    "Experiment",
    "TrainingSession",
    "ValidationSession",
    "AnnotationSet",
    "AnnotationType",
    "Dataset",
    "Box2d",
    "Box3d",
    "Mask",
    "Sample",
    "FileType",
    "Annotation",
    "DatasetParams",
    "Task",
    "TaskInfo",
    "Stage",
    "version",
]

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.18/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.18/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.18/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

__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

box3d property 

box3d

group property 

group

label property 

label

mask property 

mask

name property 

name

object_id property 

object_id

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.

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.

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).

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'.

height property 

height

width property 

width

x property 

x

y property 

y

__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'.

depth property 

depth

height property 

height

width property 

width

x property 

x

y property 

y

z property 

z

__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'.

__new__ builtin 

__new__(*args, **kwargs)

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

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)

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, description, percentage
)

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

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.

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.

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).

ID

__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

__new__ builtin 

__new__(*args, **kwargs)

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

Mask

__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'.

polygon property 

polygon

__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.

Sample

__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

group property 

group

id property 

id

name property 

name

sequence_name property 

sequence_name

uid property 

uid

__new__ builtin 

__new__(*args, **kwargs)

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

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

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'.

id property 

id

name property 

name

status property 

status

task_type property 

task_type

uid property 

uid

__new__ builtin 

__new__(*args, **kwargs)

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

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

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.

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.

version builtin 

version()