Skip to main content

Time Analysis

Phonexia time-analysis is a tool for analysis of time based traits in audio recordings, mainly of how individual channels in stereo recording react to each other. To learn more, visit the technology's home page.

Installation​

Getting the image​

You can get the CPU image by specifying a direct version in the tag (e.g. 1.0.0) or latest for the latest image:

docker pull phonexia/time-analysis:latest

Running the image​

You can start the microservice and list all the supported options by running:

docker run --rm -it phonexia/time-analysis:latest --help

The output should look like this:

time_analysis 1.0.0 


time_analysis [OPTIONS]


OPTIONS:
  -h,     --help              Print this help message and exit 
          --version           Display program version information and exit 
  -m,     --model file REQUIRED (Env:PHX_MODEL_PATH) 
                              Path to a model file. 
  -k,     --license_key string REQUIRED (Env:PHX_LICENSE_KEY) 
                              License key. 
  -a,     --listening_address address [[::]]  (Env:PHX_LISTENING_ADDRESS) 
                              Address on which the server will be listening. Address '[::]' 
                              also accepts IPv4 connections. 
  -p,     --port number [8080]  (Env:PHX_PORT) 
                              Port on which the server will be listening. 
  -l,     --log_level level:{error,warning,info,debug,trace} [info]  (Env:PHX_LOG_LEVEL) 
                              Logging level. Possible values: error, warning, info, debug, 
                              trace. 
          --keepalive_time_s number:[0, max_int] [60]  (Env:PHX_KEEPALIVE_TIME_S) 
                              Time between 2 consecutive keep-alive messages, that are sent if 
                              there is no activity from the client. If set to 0, the default 
                              gRPC configuration (2hr) will be set (note, that this may get the 
                              microservice into unresponsive state). 
          --keepalive_timeout_s number:[1, max int] [20]  (Env:PHX_KEEPALIVE_TIMEOUT_S) 
                              Time to wait for keep alive acknowledgement until the connection 
                              is dropped by the server. 
          --num_instances_per_device NUM:UINT > 0 (Env:PHX_NUM_INSTANCES_PER_DEVICE) 
                              Number of instances per device. Microservice can process requests 
                              concurrently if value is >1.
note

The model and license_key options are required. To obtain the model and license, contact Phonexia.

You can specify the options either via command line arguments or via environmental variables.

Run the container with the mandatory parameters:

docker run --rm -it -v /opt/phx/models:/models -p 8080:8080 phonexia/time-analysis:latest --model /models/time_analysis/generic-1.1.0.model --license_key ${license-key}

The path /opt/phx/models is the location where models sent by Phonexia are stored on the host system. This directory is mounted as a volume to /models inside the Docker container to make the models accessible to the microservice. Replace the /opt/phx/models, generic-1.1.0.model and license-key with the corresponding values.

With this command, the container will start, and the microservice will be listening on port 8080 on localhost.

Microservice communication​

gRPC API​

For communication, our microservices use gRPC, which is a high-performance, open-source Remote Procedure Call (RPC) framework that enables efficient communication between distributed systems using a variety of programming languages. We use an interface definition language to specify a common interface and contracts between components. This is primarily achieved by specifying methods with parameters and return types.

Take a look at our gRPC API documentation. The time-analysis microservice defines a TimeAnalysis service with remote procedure called Analyze. The Analyze procedure accepts an argument (also referred to as "message") called AnalyzeRequest, which contains the multichannel audio as an array of bytes.

This AnalyzeRequest argument is streamed, meaning that it may be received in multiple requests, each containing a part of the audio. Once all requests have been received and processed, the Analyze procedure returns a message called AnalyzeResponse which consists of the resulting analysis.

Connecting to microservice​

There are multiple ways how you can communicate with our microservices.

Phonexia Python client​

The easiest way to get started with testing is to use our simple Python client. To get it, run:

pip install phonexia-time-analysis-client

After the successful installation, run the following command to see the client options:

time_analysis_client --help

Versioning​

We use Semantic Versioning.