UCS algorithm wrapper service

Update log

2024-05-31 v.0.1.1: alg node with stream and batch mode in script mode

Requirements

Python 3.8.x+
Flask

How to use

Please refer to demo.py

Packaging

python -m build

Principles & practice

1. Alg

An Alg is the wrapper of a specific algorithm. There are 2 working mode:

[1] Stream mode

The stream mode is used to process real-time data stream. The Alg will be initialized once and keep running until the service is stopped. The Alg will process data in real-time and return the result in real-time.

Input sources should contain at least one streams, and may contain some meta data, e.g. global file, hyperparameters, etc. Input sources should be in the following format:

{
  "sources":
  [
    "rtsp://url:port",
    "tcp://"
  ],
  "meta": {
    "meta1": "value1",
    "meta2": "value2"
  }
}

Alg in stream mode is suggested to be configured with a MQ output destination or a TSDB

[2] Batch mode

The batch mode refers to the classical discrete task submission. It takes the input of AlgTask wraps the task information as:

2. AlgTask

An AlgTask wraps the algorithm task information in either stream mode or batch mode.

{
  "task_id": "task_id",
  "task_ts": "timestamp in milliseconds",
  "sources": [
  "http://",
  "rtsp://"],
  "meta_data": {
    "meta1": "value1",
    "meta2": "value2"
  }
}

3. AlgResult

Results from alg.infer_batch() or alg.infer_stream()should be in following format:

{
    "task_id": "task_id",
    "alg_task": "wraps of alg_task",
    "result_ts": "timestamp in milliseconds",
    "vals": {"val1":"result values container"},
    "explain": "result explained in plain text"
}

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

lingfliu / ucs_alg_node