monailabel.client.client module

class monailabel.client.client.MONAILabelClient(server_url, tmpdir=None, client_id=None)

Bases: object

Basic MONAILabel Client to invoke infer/train APIs over http/https

Parameters

• server_url – Server URL for MONAILabel (e.g. http://127.0.0.1:8000)

• tmpdir – Temp directory to save temporary files. If None then it uses tempfile.tempdir

• client_id – Client ID that will be added for all basic requests

__init__(server_url, tmpdir=None, client_id=None)

Parameters

• server_url – Server URL for MONAILabel (e.g. http://127.0.0.1:8000)

• tmpdir – Temp directory to save temporary files. If None then it uses tempfile.tempdir

• client_id – Client ID that will be added for all basic requests

auth_enabled()

Check if Auth is enabled

Return type

bool

auth_token(username, password)

Fetch Auth Token. Currently only basic authentication is supported.

Parameters

• username – UserName for basic authentication

• password – Password for basic authentication

auth_valid_token()

Return type

bool

create_session(image_in, params=None)

Create New Session

Parameters

• image_in – filepath for image to be sent to server as part of session creation

• params – additional JSON params as part of session reqeust

Returns

json response which contains session id and other details

datastore()

download_label(label_id, tag)

get_server_url()

Return server url

Returns

the url for monailabel server

get_session(session_id)

Get Session

Parameters

session_id – Session Id

Returns

json response which contains more details about the session

infer(model, image_id, params, label_in=None, file=None, session_id=None)

Run Infer

Parameters

• model – Name of Model

• image_id – Image Id

• params – Additional configs/json params as part of Infer request

• label_in – File path for label mask which is needed to run Inference (e.g. In case of Scribbles)

• file – File path for Image (use raw image instead of image_id)

• session_id – Session ID (use existing session id instead of image_id)

Returns

response_file (label mask), response_body (json result/output params)

info()

Invoke /info/ request over MONAILabel Server

Returns

json response

next_sample(strategy, params)

Get Next sample

Parameters

• strategy – Name of strategy to be used for fetching next sample

• params – Additional JSON params as part of strategy request

Returns

json response which contains information about next image selected for annotation

remove_session(session_id)

Remove any existing Session

Parameters

session_id – Session Id

Returns

json response

save_label(image_id, label_in, tag='', params=None)

Save/Submit Label

Parameters

• image_id – Image Id for which label needs to saved/submitted

• label_in – Label File path which shall be saved/submitted

• tag – Save label against tag in datastore

• params – Additional JSON params for the request

Returns

json response

set_server_url(server_url)

Set url for monailabel server

Parameters

server_url – server url for monailabel

train_start(model, params)

Run Train Task

Parameters

• model – Name of Model

• params – Additional configs/json params as part of Train request

Returns

json response

train_status(check_if_running=False)

Check Train Task Status

Parameters

check_if_running – Fast mode. Only check if training is Running

Returns

boolean if check_if_running is enabled; else json response that contains of full details

train_stop()

Stop any running Train Task(s)

Returns

json response

update_auth(token)

upload_image(image_in, image_id=None, params=None)

Upload New Image to MONAILabel Datastore

Parameters

• image_in – Image File Path

• image_id – Force Image ID; If not provided then Server it auto generate new Image ID

• params – Additional JSON params

Returns

json response which contains image id and other details

wsi_infer(model, image_id, body=None, output='dsa', session_id=None)

Run WSI Infer in case of Pathology App

Parameters

• model – Name of Model

• image_id – Image Id

• body – Additional configs/json params as part of Infer request

• output – Output File format (dsa|asap|json)

• session_id – Session ID (use existing session id instead of image_id)

Returns

response_file (None), response_body

exception monailabel.client.client.MONAILabelClientException(error, msg, status_code=None, response=None)

Bases: Exception

MONAILabel Client Exception

Parameters

• error – Error code represented by MONAILabelError

• msg – Error message

• status_code – HTTP Response code

• response – HTTP Response

__init__(error, msg, status_code=None, response=None)

Parameters

• error – Error code represented by MONAILabelError

• msg – Error message

• status_code – HTTP Response code

• response – HTTP Response

error

msg

class monailabel.client.client.MONAILabelError

Bases: object

Type of Inference Model

SERVER_ERROR -           Server Error

SESSION_EXPIRED -        Session Expired

UNKNOWN -                Unknown Error

SERVER_ERROR = 1

SESSION_EXPIRED = 2

UNKNOWN = 3

class monailabel.client.client.MONAILabelUtils

Bases: object

static encode_multipart_formdata(fields, files)

static get_content_type(filename)

static get_filename(content_disposition)

static http_method(method, server_url, selector, body=None, headers=None, content_type=None)

static http_multipart(method, server_url, selector, fields, files, headers={})

static http_upload(method, server_url, selector, fields, files, headers=None)

static parse_multipart(fp, headers)

static save_result(files, tmpdir)

static send_response(conn, content_type='application/json')

static urllib_quote_plus(s)

monailabel.client.client.bytes_to_str(b)

previous

monailabel.client package

next

monailabel.datastore package