SDK Reference¶

Annotation¶

Annnotation - Working with labeling data of individual images. Annotation is the class that wraps all the labeling data for a given image: its Labels (geometrical objects) and Tags.

`Annotation`	Annotation for a single image.
`AnnotationJsonFields`	Json fields for `Annotation`

`Label`
`LabelJsonFields`	Json fields for `Annotation`

`ObjClass`	General information about `Label`.
`ObjClassJsonFields`	Json fields for `Annotation`

`ObjClassCollection`	Collection with `ObjClass` instances.

`Tag`	`Tag` can be attached to whole image and/or to individual `Label`.
`TagJsonFields`	Json fields for `Annotation`

`TagCollection`	Collection with `Tag` instances.

`TagMeta`	General information about `Tag`.
`TagMetaJsonFields`	Json fields for `TagMeta`
`TagApplicableTo`	Defines Tag applicability only to images, objects or both.
`TagValueType`	Restricts Tag to have a certain value type.

`TagMetaCollection`	Collection with `TagMeta` instances.

API¶

API - Python wrappers to script your interactions with the Supervisely web instance. Instead of clicking around, you can write a script to request, via the API, a sequence of tasks, like training up a neural network and then running inference on a validation dataset.

`Api`	An API connection to the server with which you can communicate with your teams, workspaces and projects.

`AgentApi`	API for working with agent.

`AnnotationApi`	Annotation for a single image.

`AppApi`	AppApi

`DatasetApi`	API for working with `Dataset`.

`FileApi`	API for working with Files.

`StorageApi`	API for working with Files and Folders in Team Files and Cloud Storage.

`ImageAnnotationToolApi`
`ImageAnnotationToolAction`	An enumeration.

`ImageApi`	API for working with `Image`.
`ImageInfo`	Object with image parameters from Supervisely.

`ImportStorageApi`

`LabelingJobApi`	API for working with Labeling Jobs.

`ApiField`	ApiField
`ModuleApi`	Base class for entities that have a parent object in the system.
`ModuleApiBase`	ModuleApiBase
`CloneableModuleApi`	CloneableModuleApi
`UpdateableModule`	UpdateableModule
`RemoveableModuleApi`	RemoveableModuleApi
`RemoveableBulkModuleApi`	RemoveableBulkModuleApi
`ModuleWithStatus`	ModuleWithStatus

`NeuralNetworkApi`

`ObjectClassApi`	API for working with `ObjClass`.

`PluginApi`	API for working with plugins.

`ProjectApi`	API for working with `Project`.

`ProjectClassApi`	API for working with classes in Project.

`RoleApi`	API for working with Roles.

`TaskApi`	API for working with Tasks.

`ActivityAction`	List of Team Actions to sort Team Activity.
`TeamApi`	API for working with Team.

`UserApi`	API for working with `Users`.

`WorkspaceApi`	API for working with Workspace.

Video API¶

Video API - API for working with videos in Supervisely.

`VideoApi`	API for working with `Video`.
`VideoInfo`	Object with `Video` parameters from Supervisely.

`VideoAnnotationAPI`	`VideoAnnotation` for a single video.

`VideoFigureApi`	`VideoFigure` for a single video.

`VideoFrameAPI`	`Frame` for a single video.

`VideoObjectApi`	`VideoObject` for `VideoAnnotation`.

`VideoTagApi`	`VideoTag` for a single video.

Volume API¶

Volume API - API for working with volumes in Supervisely.

`VolumeApi`	API for working with `Volume`.
`VolumeInfo`	Object with `Volume` parameters from Supervisely.

`VolumeAnnotationAPI`	`VolumeAnnotation` for a single volume.

`VolumeFigureApi`	`VolumeFigure` for a single volume.

`VolumeObjectApi`	`VolumeObject` for `VolumeAnnotation`.

`VolumeTagApi`	`VolumeTag` for a single volume.

Pointcloud API¶

Pointcloud API - API for working with pointclouds in Supervisely.

`PointcloudApi`	API for working with `Pointcloud`.
`PointcloudInfo`	Object with `Pointcloud` parameters from Supervisely.

`PointcloudEpisodeApi`	API for working with `PointcloudEpisodes`.

`PointcloudAnnotationAPI`	`PointcloudAnnotation` for a single point cloud.

`PointcloudEpisodeAnnotationAPI`	`PointcloudEpisodeAnnotation` for a point clouds episodes.

`PointcloudFigureApi`	`PointcloudFigure` for a single point cloud.

`PointcloudObjectApi`	`PointcloudObject` for `PointcloudAnnotation`.

`PointcloudTagApi`	`PointcloudTag` for point clouds.

Augmentation¶

Augmentation - Data augmentations to create more data variety for neural networks training.

`aug`	Augmentations for images and annotations

Collection¶

`DuplicateKeyError`	Raised when trying to add already existing key to `KeyIndexedCollection`
`KeyObject`	Base class for objects that should implement the `key` method.
`KeyIndexedCollection`	Base class for `ObjClassCollection`, `TagMetaCollection` and `TagCollection` instances.
`MultiKeyIndexedCollection`	Base class for `TagCollection` instances.

Decorators¶

`profile`

Geometry¶

Geometry - All the logic concerned with working with geometric objects - compute statistics like object area, transform (rotate, scale, shift), extract bounding boxes, compute intersections and more.

`AnyGeometry`	AnyGeometry for a single `Label`.

`Bitmap`	Bitmap geometry for a single `Label`.
`SkeletonizeMethod`	Specifies possible skeletonization methods of `Bitmap`.

`AlphaMask`	AlphaMask geometry for a single `Label`.

`BitmapBase`	BitmapBase is a base class of `Bitmap` geometry.

`Cuboid`	Cuboid geometry for a single `Label`.
`CuboidFace`	CuboidFace for a single `Cuboid`.

`Cuboid3d`	This is a class for creating and using Cuboid3d objects for Labels
`Vector3d`	This is a class for creating and using Vector3d objects for Cuboid3d class objects

`Geometry`

`Point`	Point geometry for a single `Label`.

`Point3d`

`PointLocation`	PointLocation in (row, col) position.

`Polygon`	Polygon geometry for a single `Label`.

`Polyline`	Polyline geometry for a single `Label`.

`Rectangle`	Rectangle geometry for a single `Label`.

`ImageRotator`	ImageRotator for rotating images and geometry figures.

`VectorGeometry`	VectorGeometry is a base class of geometry for a single `Label`.

`Node`	Node for a single `GraphNodes`.
`GraphNodes`	GraphNodes geometry for a single `Label`.

Imaging¶

Imaging - Our wrappers for working with images. IO, transformations, text rendering, color conversions.

`font`
`color`
`image`

IO¶

IO - Low-level convenience IO wrappers that we found useful internally.

`fs`
`json`

Labeling Jobs¶

`utils`	utilities used for labeling jobs

Pointcloud¶

`pointcloud`	Functions for processing pointclouds

Pointcloud Annotation¶

`PointcloudAnnotation`	Class for creating and using PointcloudAnnotation

`PointcloudFigure`	PointcloudFigure object for `PointcloudAnnotation` or `PointcloudEpisodeAnnotation`.

`PointcloudObject`	PointcloudObject object for `PointcloudAnnotation`.

`PointcloudObjectCollection`	Collection with `PointcloudObject` instances.

`PointcloudTag`	PointcloudTag object for `PointcloudAnnotation`.

`PointcloudTagCollection`	Collection with `PointcloudTag` instances.

`PointcloudEpisodeAnnotation`	PointcloudEpisodeAnnotation for point cloud episodes.

`PointcloudEpisodeFrame`	PointcloudEpisodeFrame object for `PointcloudEpisodeAnnotation`.

`PointcloudEpisodeFrameCollection`	Collection with `PointcloudEpisodeFrame` instances.

`PointcloudEpisodeTag`	PointcloudEpisodeTag object for `PointcloudEpisodeAnnotation`.

`PointcloudEpisodeTagCollection`	Collection with `PointcloudEpisodeTag` instances.

Pointcloud Episodes¶

`pointcloud_episodes`	Functions for processing pointcloud episodes

Project¶

Project - Working with Supervisely projects on disk.

`Project`	Project is a parent directory for dataset.
`DatasetDict`	`Datasets` collection of `Project`.
`Dataset`	Dataset is where your labeled and unlabeled images and other data files live.
`OpenMode`	Defines the mode of using the `Project` and `Dataset`.
`ItemPaths`	ItemPaths(img_path, ann_path)
`ItemInfo`	ItemInfo(dataset_name, name, img_path, ann_path)

`PointcloudProject`	PointcloudProject is a parent directory for pointcloud datasets.
`PointcloudDataset`

`ProjectMeta`	General information about ProjectMeta.
`ProjectMetaJsonFields`

`ProjectType`	An enumeration.

`VideoProject`	VideoProject is a parent directory for video dataset.
`VideoDataset`	VideoDataset is where your labeled and unlabeled videos and other data files live.
`VideoItemPaths`	VideoItemPaths(video_path, ann_path)

`VolumeProject`
`VolumeDataset`

Task¶

Task - Constants defining the directories where a plugin should expect the input and output data to be. Also helpers to stream progress data from a running plugin back to the web instance.

`Progress`	Modules operations monitoring and displaying statistics of data processing.

User¶

`UserRoleName`	An enumeration.

Video¶

`video`	Functions for processing videos

Video Annotation¶

`VideoAnnotation`	VideoAnnotation for a single video.

`Frame`	Frame object for `VideoAnnotation`.

`FrameCollection`	Collection with `Frame` instances.

`KeyIdMap`	KeyIdMap object for `VideoAnnotation`.

`VideoFigure`	VideoFigure object for `VideoAnnotation`.

`VideoObject`	VideoObject object for `VideoAnnotation`.

`VideoObjectCollection`	Collection with `VideoObject` instances.

`VideoTag`	VideoTag object for `VideoAnnotation`.

`VideoTagCollection`	Collection with `VideoTag` instances.

Volume¶

`volume`	Functions for processing volumes

Volume Annotation¶

`VolumeAnnotation`	VolumeAnnotation for a single volume.

`VolumeFigure`	VolumeFigure object for `VolumeAnnotation`.

`VolumeObject`	VolumeObject object for `VolumeAnnotation`.

`VolumeObjectCollection`	Collection with `VolumeObject` instances.

`VolumeTag`	VolumeTag object for `VolumeAnnotation`.

`VolumeTagCollection`	Collection with `VolumeTag` instances.

`Plane`	A class representing a plane in medical image data.

`Slice`	A class representing a single slice of a medical image.