Package: deepomatic-rpc-protobuf
Table of contentsDeepomatic Remote Procedure CallInstallationUsageGetting startedInstanciate client and queuesSend recognition requestStream and cleanupAdvancedShortcutsImage input examplesBugsDeepomatic Remote Procedure CallDeepomaticRemote Procedure Call.This remote procedure call has been made to help you interacting with our on-premises inference service.
You might also want to use our command line interfacedeepomatic-cli.InstallationOnlinepip3installdeepomatic-rpcOfflineOn a machine with internet access you will need to download the package and its dependencies with the command below:mkdirdeepomatic-rpc# --platform force to get the packages compatibles with all OSpip3download--platformany--only-binary=:all:-d./deepomatic-rpcdeepomatic-rpcThen save thedeepomatic-rpcdirectory on the storage device of your choice.Now retrieve this directory on the offline machine and install the package:pip3install--no-index--find-links./deepomatic-rpc./deepomatic-rpc/deepomatic_rpc-*-py3-none-any.whlUsageGetting startedInstanciate client and queuesfromdeepomatic.rpc.clientimportClient# Replace placeholder variables with yourscommand_queue_name='my_command_queue'recognition_version_id=123amqp_url='amqp://myuser:mypassword@localhost:5672/myvhost'# Instanciate clientclient=Client(amqp_url)# Do the following for each stream# Declare lasting command queuecommand_queue=client.new_queue(command_queue_name)# Declare response queue and consumer to get responses# consumer is linked to the response_queue# If queue_name parameter is provided, will declare a durable queue# Otherwise it is an uniq temporary queue.response_queue,consumer=client.new_consuming_queue()# Don't forget to cleanup when you are done sending requests !Send recognition requestfromdeepomatic.rpcimportv07_ImageInputfromdeepomatic.rpc.responseimportwaitfromdeepomatic.rpc.helpers.v07_protoimportcreate_images_input_mix,create_recognition_command_mix# Create a recognition command mixcommand_mix=create_recognition_command_mix(recognition_version_id,max_predictions=100,show_discarded=False)# Create one image inputimage_input=v07_ImageInput(source='https://static.wamiz.fr/images/animaux/chats/large/bengal.jpg'.encode())# Wrap it inside a generic input mixinput_mix=create_images_input_mix([image_input])# Send the requestcorrelation_id=client.command(command_queue_name,response_queue.name,command_mix,input_mix)# Wait for response, `timeout=float('inf')` or `timeout=-1` for infinite wait, `timeout=None` for non blockingresponse=consumer.get(correlation_id,timeout=5)# get_labelled_output() is a shortcut that give you the corresponding predictions depending on the command mix you used# and raise a ServerError in case of error on the worker side. It should cover most cases but if it doesn't fit your needs, see the Response class. You might want to handle result and errors by yourself using `response.to_result_buffer()`.labels=response.get_labelled_output()predicted=labels.predicted[0]# Predicted is ordered by scoreprint("Predicted label{}with score{}".format(predicted.label_name,predicted.score))# if show_discarded was True, you might want to read `labels.discarded` to see which labels have a low confidence.Stream and cleanupWhen you are done with a stream you should cleanup your consuming queues.If your program stops right after, the consumer get cancelled and the queue will automatically be removed after 2 hours of inactivity (only if the queue is a uniq temporary queue).If your program is a long running job, after 2 hours of inactivity the queue might be removed and the consumer cancelled by the broker, but the client might consider redeclaring both in case of a broker error.Thus callingclient.remove_consuming_queue()remove the queue and makes sure the consumer is cancelled and not redeclared later:client.remove_consuming_queue(response_queue,consumer)You might also want to remove a queue without consumer using:client.remove_queue(queue)Also instead of usingnew_consuming_queue()with no queue_name parameter andremove_consuming_queue()you might want to use the contextmanager version:withclient.tmp_consuming_queue()as(response_queue,consumer):# this creates a temporary queue alive for the rest of this scope# do your inference requestsIf you don't care about the response queue and consumer, we provide a high level classRPCStream.
By default it saves all correlation_ids so that you can callget_next_response()to get responses in the same order that you pushed the requests:fromdeepomatic.rpc.helpers.protoimportcreate_v07_images_commandserialized_buffer=create_v07_images_command([image_input],command_mix)withclient.new_stream(command_queue_name)asstream:# it internally saves the correlation_id so that it can retrieve responses in order# You need to call as many time get_next_response() as send_binary(), or the internal correlation_ids list will keep growing upstream.send_binary(serialized_buffer)response=stream.get_next_response(timeout=1)Also you might want to handle response order by yourself, in this case you can create the stream in the following way:# with keep_response_order=False, the stream will not buffer correlation_idswithclient.new_stream(command_queue_name,keep_response_order=False):correlation_id=stream.send_binary(serialized_buffer)# directly access the stream's consumer to retrieve a specific responseresponse=stream.consumer.get(correlation_id,timeout=1)IMPORTANT: If you don't use the with statement, youwillhave to callstream.close()at the end to clean consumer and response queue.AdvancedShortcutsYou can avoid callingcreate_images_input_mixand directly sending the image_input list via the methodclient.v07_images_commandwhich will call internallycreate_images_input_mix:correlation_id=client.v07_images_command(command_queue_name,response_queue.name,[image_input],command_mix)Create a workflow command mix. The recognition_version_id is deduced but the command queue name must match the recognition in the workflows.json.
Note that it doesn't allow to specifyshow_discardedormax_predictions:fromdeepomatic.rpc.helpers.v07_protoimportcreate_workflow_command_mixcommand_mix=create_workflow_command_mix()Create an inference command mix; the response will be a raw tensor :fromdeepomatic.rpc.helpers.v07_protoimportcreate_inference_command_mixoutput_tensors=['prod']command_mix=create_inference_command_mix(output_tensors)Wait multiples correlation ids at once:fromdeepomatic.rpc.responseimportwait_responses# Wait for responses, `timeout=float('inf')` or `timeout=-1` for infinite waitresponses,pending=wait_responses(consumer,correlation_ids,timeout=10)print(responses)# will print [(0, response), (1, response), (2, response)]# 0, 1, 2 are the position in correlation_ids list in case you want to retrieve their original correlation_id# the list is sorted by positions to keep the same order as the correlation_ids list# if no timeout reached len(response) == len(correlation_ids)print(pending)# should be empty if timeout has not been reached# otherwise should print a list of correlation_id position that didn't get a response (the list is sorted)# If print [3, 5], then correlations_ids[3] and correlation_id[5] didn't get a response on timeImage input examplesCreate an image input with a bounding box:fromdeepomatic.rpcimportv07_ImageInputfromdeepomatic.rpcimportBBox# Coordinates between 0 and 1bbox=BBox(xmin=0.3,xmax=0.8,ymin=0.1,ymax=0.9)image_input=v07_ImageInput(source='https://static.wamiz.fr/images/animaux/chats/large/bengal.jpg'.encode(),bbox=bbox)Create an image input with a polygon selection:fromdeepomatic.rpcimportv07_ImageInputfromdeepomatic.rpcimportPoint# Coordinates between 0 and 1, minimum 3 points neededpolygon=[Point(x=0.1,y=0.1),Point(x=0.9,y=0.1),Point(x=0.5,y=0.9)]image_input=v07_ImageInput(source='https://static.wamiz.fr/images/animaux/chats/large/bengal.jpg'.encode(),polygon=polygon)Create an image input from a file on the disk:fromdeepomatic.rpcimportv07_ImageInputfromdeepomatic.rpc.helpers.protoimportbinary_source_from_img_filebinary_content=binary_source_from_img_file(filename)# Also works if you give a fileobjimage_input=v07_ImageInput(source=binary_content)BugsPlease send bug reports tosupport@deepomatic.com