NeuralNetworkApi¶

class NeuralNetworkApi[source]¶

Bases: supervisely.api.module_api.CloneableModuleApi, supervisely.api.module_api.RemoveableModuleApi

Methods

`clone`
`clone_by_shared_link`
`clone_from_explore`
`create_from_checkpoint`
`download`
`download_to_dir`
`download_to_tar`
`exists`	Checks if an entity with the given parent_id and name exists
`generate_hash`
`get_deploy_tasks`
`get_free_name`	Generates a free name for an entity with the given parent_id and name.
`get_info_by_id`
`get_info_by_name`	Get information about an entity by its name from the Supervisely server.
`get_list`
`get_list_all_pages`	Get list of all or limited quantity entities from the Supervisely server.
`get_list_all_pages_generator`	This generator function retrieves a list of all or a limited quantity of entities from the Supervisely server, yielding batches of entities as they are retrieved
`get_or_clone_from_explore`
`get_output_meta`
`get_training_metrics`
`inference`
`inference_remote_image`
`info_sequence`
`info_tuple_name`
`remove`	Remove an entity with the specified ID from the Supervisely server.
`remove_batch`	Remove entities with given IDs from the Supervisely server.
`upload`

Attributes

`MAX_WAIT_ATTEMPTS`	Maximum number of attempts that will be made to wait for a certain condition to be met.
`WAIT_ATTEMPT_TIMEOUT_SEC`	Number of seconds for intervals between attempts.

InfoType¶: alias of supervisely.api.module_api.ModelInfo

clone(id, dst_workspace_id, dst_name)¶

clone_by_shared_link(shared_link, dst_workspace_id, dst_name)¶

clone_from_explore(explore_path, dst_workspace_id, dst_name)¶

create_from_checkpoint(task_id, checkpoint_id, model_name, change_name_if_conflict=True)[source]¶

download(id)[source]¶

download_to_dir(workspace_id, name, directory, progress_cb=None)[source]¶

download_to_tar(workspace_id, name, tar_path, progress_cb=None)[source]¶

exists(parent_id, name)¶

Checks if an entity with the given parent_id and name exists

Parameters

parent_id : int: ID of the parent entity.
name : str: Name of the entity.

Returns

Returns True if entity exists, and False if not

Return type

bool

Usage example

import supervisely as sly

# You can connect to API directly
address = 'https://app.supervise.ly/'
token = 'Your Supervisely API Token'
api = sly.Api(address, token)

# Or you can use API from environment
os.environ['SERVER_ADDRESS'] = 'https://app.supervise.ly'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
api = sly.Api.from_env()


name = "IMG_0315.jpeg"
dataset_id = 55832
exists = api.image.exists(dataset_id, name)
print(exists) # True

get_deploy_tasks(model_id)[source]¶

get_free_name(parent_id, name)¶

Generates a free name for an entity with the given parent_id and name. Adds an increasing suffix to original name until a unique name is found.

Parameters

parent_id : int: ID of the parent entity.
name : str: Name of the entity.

Returns

Returns free name.

Return type

str

Usage example

import supervisely as sly

# You can connect to API directly
address = 'https://app.supervise.ly/'
token = 'Your Supervisely API Token'
api = sly.Api(address, token)

# Or you can use API from environment
os.environ['SERVER_ADDRESS'] = 'https://app.supervise.ly'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
api = sly.Api.from_env()


name = "IMG_0315.jpeg"
dataset_id = 55832
free_name = api.image.get_free_name(dataset_id, name)
print(free_name) # IMG_0315_001.jpeg

get_info_by_id(id)[source]¶

get_info_by_name(parent_id, name)¶

Get information about an entity by its name from the Supervisely server.

Parameters

parent_id : int: ID of the parent entity.
name : str: Name of the entity for which the information is being retrieved

Usage example

import supervisely as sly

# You can connect to API directly
address = 'https://app.supervise.ly/'
token = 'Your Supervisely API Token'
api = sly.Api(address, token)

# Or you can use API from environment
os.environ['SERVER_ADDRESS'] = 'https://app.supervise.ly'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
api = sly.Api.from_env()


dataset_id = 55832
name = "IMG_0315.jpeg"
info = api.image.get_info_by_name(dataset_id, name)
print(info)
# Output: ImageInfo(id=19369643, name='IMG_0315.jpeg', ...)

get_list(workspace_id, filters=None)[source]¶

get_list_all_pages(method, data, progress_cb=None, convert_json_info_cb=None, limit=None, return_first_response=False)¶

Get list of all or limited quantity entities from the Supervisely server.

Parameters

method : str: Request method name
data : dict: Dictionary with request body info
progress_cb : Progress, optional: Function for tracking download progress.
convert_json_info_cb : Callable, optional: Function for convert json info
limit : int, optional: Number of entity to retrieve
return_first_response : bool, optional: Specify if return first response

get_list_all_pages_generator(method, data, progress_cb=None, convert_json_info_cb=None, limit=None, return_first_response=False)¶

This generator function retrieves a list of all or a limited quantity of entities from the Supervisely server, yielding batches of entities as they are retrieved

Parameters

method : str: Request method name
data : dict: Dictionary with request body info
progress_cb : Progress, optional: Function for tracking download progress.
convert_json_info_cb : Callable, optional: Function for convert json info
limit : int, optional: Number of entity to retrieve
return_first_response : bool, optional: Specify if return first response

get_or_clone_from_explore(explore_path, dst_workspace_id, dst_name)¶

get_output_meta(id, input_meta=None, inference_mode=None)[source]¶

get_training_metrics(model_id)[source]¶

inference(id, img, ann=None, meta=None, mode=None, ext=None)[source]¶

inference_remote_image(id, image_hash, ann=None, meta=None, mode=None)[source]¶

static info_sequence()[source]¶

static info_tuple_name()[source]¶

remove(id)¶

Remove an entity with the specified ID from the Supervisely server.

Parameters

id : int: Entity ID in Supervisely

remove_batch(ids, progress_cb=None)¶

Remove entities with given IDs from the Supervisely server.

Parameters

ids : List[int]: IDs of entities in Supervisely.
progress_cb : Callable: Function for control remove progress.

upload(hash, archive_path, progress_cb=None)[source]¶