Module API

class supervisely_lib.api.module_api.ApiField[source]

Bases: object

ID = 'id'
NAME = 'name'
DESCRIPTION = 'description'
CREATED_AT = 'createdAt'
UPDATED_AT = 'updatedAt'
ROLE = 'role'
TEAM_ID = 'teamId'
WORKSPACE_ID = 'workspaceId'
CONFIG = 'config'
SIZE = 'size'
PLUGIN_ID = 'pluginId'
PLUGIN_VERSION = 'pluginVersion'
HASH = 'hash'
STATUS = 'status'
ONLY_TRAIN = 'onlyTrain'
USER_ID = 'userId'
README = 'readme'
PROJECT_ID = 'projectId'
IMAGES_COUNT = 'imagesCount'
ITEMS_COUNT = 'itemsCount'
DATASET_ID = 'datasetId'
WIDTH = 'width'
HEIGHT = 'height'
WEIGHTS_LOCATION = 'weightsLocation'
IMAGE_ID = 'imageId'
IMAGE_NAME = 'imageName'
ANNOTATION = 'annotation'
TASK_ID = 'taskId'
LABELS_COUNT = 'labelsCount'
FILTER = 'filter'
META = 'meta'
EXPLORE_PATH = 'explorePath'
MIME = 'mime'
EXT = 'ext'
TYPE = 'type'
DEFAULT_VERSION = 'defaultVersion'
DOCKER_IMAGE = 'dockerImage'
CONFIGS = 'configs'
VERSIONS = 'versions'
VERSION = 'version'
TOKEN = 'token'
CAPABILITIES = 'capabilities'
STARTED_AT = 'startedAt'
FINISHED_AT = 'finishedAt'
AGENT_ID = 'agentId'
MODEL_ID = 'modelId'
RESTART_POLICY = 'restartPolicy'
SETTINGS = 'settings'
SORT = 'sort'
SORT_ORDER = 'sort_order'
IMAGES = 'images'
IMAGE_IDS = 'imageIds'
ANNOTATIONS = 'annotations'
EMAIL = 'email'
LOGIN = 'login'
LOGINS = 'logins'
DISABLED = 'disabled'
LAST_LOGIN = 'lastLogin'
PASSWORD = 'password'
ROLE_ID = 'roleId'
IS_RESTRICTED = 'isRestricted'
DISABLE = 'disable'
TEAMS = 'teams'
USER_IDS = 'userIds'
PROJECT_NAME = (['projectTitle'], 'project_name')
DATASET_NAME = (['datasetTitle'], 'dataset_name')
WORKSPACE_NAME = (['workspaceTitle'], 'workspace_name')
CREATED_BY_ID = (['createdBy'], 'created_by_id')
CREATED_BY_LOGIN = (['managerLogin'], 'created_by_login')
ASSIGNED_TO_ID = (['userId'], 'assigned_to_id')
ASSIGNED_TO_LOGIN = (['labelerLogin'], 'assigned_to_login')
FINISHED_IMAGES_COUNT = 'finishedImagesCount'
PROGRESS_IMAGES_COUNT = 'progressImagesCount'
CLASSES_TO_LABEL = (['meta', 'classes'], 'classes_to_label')
TAGS_TO_LABEL = (['meta', 'projectTags'], 'tags_to_label')
IMAGES_RANGE = (['meta', 'range'], 'images_range')
REJECTED_IMAGES_COUNT = 'rejectedImagesCount'
ACCEPTED_IMAGES_COUNT = 'acceptedImagesCount'
OBJECTS_LIMIT_PER_IMAGE = (['meta', 'imageFiguresLimit'], 'objects_limit_per_image')
TAGS_LIMIT_PER_IMAGE = (['meta', 'imageTagsLimit'], 'tags_limit_per_image')
FILTER_IMAGES_BY_TAGS = (['meta', 'imageTags'], 'filter_images_by_tags')
INCLUDE_IMAGES_WITH_TAGS = ([], 'include_images_with_tags')
EXCLUDE_IMAGES_WITH_TAGS = ([], 'exclude_images_with_tags')
SIZEB = (['size'], 'sizeb')
FRAMES_COUNT = (['fileMeta', 'framesCount'], 'frames_count')
PATH_ORIGINAL = 'pathOriginal'
OBJECTS_COUNT = 'objectsCount'
FRAMES_TO_TIMECODES = (['fileMeta', 'framesToTimecodes'], 'frames_to_timecodes')
TAGS = 'tags'
VIDEO_ID = 'videoId'
FRAME_INDEX = (['meta', 'frame'], 'frame_index')
LABELING_TOOL = 'tool'
GEOMETRY_TYPE = 'geometryType'
GEOMETRY = 'geometry'
OBJECT_ID = 'objectId'
FRAME = 'frame'
STREAMS = 'streams'
VIDEO_IDS = 'videoIds'
FRAME_WIDTH = (['fileMeta', 'width'], 'frame_width')
FRAME_HEIGHT = (['fileMeta', 'height'], 'frame_height')
VIDEO_NAME = 'videoName'
FRAME_RANGE = 'frameRange'
TRACK_ID = 'trackId'
PROGRESS = 'progress'
CURRENT = 'current'
TOTAL = 'total'
STOPPED = 'stopped'
VIDEOS = 'videos'
FILENAME = 'filename'
SHAPE = 'shape'
COLOR = 'color'
CLASS_ID = 'classId'
ENTITY_ID = 'entityId'
ANNOTATION_OBJECTS = 'annotationObjects'
TAG_ID = 'tagId'
ERROR = 'error'
MESSAGE = 'message'
CONTENT = 'content'
FIGURES = 'figures'
WIDGETS = 'widgets'
CLOUD_MIME = (['fileMeta', 'mime'], 'cloud_mime')
PREVIEW = 'preview'
FIGURES_COUNT = 'figuresCount'
ANN_OBJECTS_COUNT = (['annotationObjectsCount'], 'objects_count')
POINTCLOUD_ID = 'pointCloudId'
POINTCLOUD_IDS = 'pointCloudIds'
POINTCLOUDS = 'pointClouds'
ADVANCED = 'advanced'
IGNORE_AGENT = 'ignoreAgent'
SCRIPT = 'script'
LOGS = 'logs'
FILES = 'files'
HASHES = 'hashes'
SUBTITLE = 'subtitle'
COMMAND = 'command'
DEFAULT_VALUE = 'defaultValue'
TITLE = 'title'
AREA = 'area'
OPTIONS = 'options'
REPORT_ID = 'reportId'
WIDGET = 'widget'
LAYOUT = 'layout'
PAYLOAD = 'payload'
FIELD = 'field'
FIELDS = 'fields'
APPEND = 'append'
WITH_CUSTOM_DATA = 'withCustomBigData'
PATH = 'path'
SESSION_ID = 'sessionId'
ACTION = 'action'
FIGURE_ID = 'figureId'
VALUE = 'value'
ZOOM_FACTOR = 'zoomFactor'
FULL_STORAGE_URL = 'fullStorageUrl'
REVIEWER_ID = 'reviewerId'
REVIEWER_LOGIN = 'reviewerLogin'
RECURSIVE = 'recursive'
ECOSYSTEM_ITEM_ID = 'moduleId'
APP_ID = 'appId'
PROJECT = 'project'
OUTPUT = 'output'
REFERENCE_IMAGE_URL = 'referenceImageUrl'
GENERAL = 'general'
ENTITIES = 'entities'
STORAGE_PATH = 'storagePath'
EXT2 = (['meta', 'ext'], 'ext')
MIME2 = (['meta', 'mime'], 'mime')
SIZEB2 = (['meta', 'size'], 'sizeb')
JOB_ID = 'jobId'
DATASETS_COUNT = 'datasetsCount'
CUSTOM_DATA = 'customData'
CONTEXT = 'context'
STATE = 'state'
IDS = 'ids'
class supervisely_lib.api.module_api.ModuleApiBase(api)[source]

Bases: supervisely_lib.api.module_api._JsonConvertibleModule

MAX_WAIT_ATTEMPTS = 999
WAIT_ATTEMPT_TIMEOUT_SEC = 1
static info_sequence()[source]
static info_tuple_name()[source]
get_list_all_pages(method, data, progress_cb=None, convert_json_info_cb=None)[source]
get_info_by_id(id)[source]
class supervisely_lib.api.module_api.ModuleApi(api)[source]

Bases: supervisely_lib.api.module_api.ModuleApiBase

get_info_by_name(parent_id, name)[source]
get_list(parent_id, filters=None)[source]
exists(parent_id, name)[source]
get_free_name(parent_id, name)[source]
class supervisely_lib.api.module_api.ModuleNoParent(api)[source]

Bases: supervisely_lib.api.module_api.ModuleApiBase

get_info_by_name(name)[source]
get_list(filters=None)[source]
exists(name)[source]
get_free_name(name)[source]
class supervisely_lib.api.module_api.CloneableModuleApi(api)[source]

Bases: supervisely_lib.api.module_api.ModuleApi

clone(id, dst_workspace_id, dst_name)[source]
clone_from_explore(explore_path, dst_workspace_id, dst_name)[source]
get_or_clone_from_explore(explore_path, dst_workspace_id, dst_name)[source]
class supervisely_lib.api.module_api.ModuleWithStatus[source]

Bases: object

get_status(id)[source]
raise_for_status(status)[source]
exception supervisely_lib.api.module_api.WaitingTimeExceeded[source]

Bases: Exception

class supervisely_lib.api.module_api.UpdateableModule(api)[source]

Bases: supervisely_lib.api.module_api._JsonConvertibleModule

update(id, name=None, description=None)[source]
class supervisely_lib.api.module_api.RemoveableModuleApi(api)[source]

Bases: supervisely_lib.api.module_api.ModuleApi

remove(id)[source]
remove_batch(ids, progress_cb=None)[source]
class supervisely_lib.api.module_api.RemoveableBulkModuleApi(api)[source]

Bases: supervisely_lib.api.module_api.ModuleApi

remove_batch(ids, progress_cb=None)[source]
remove(id)[source]