temporal-network/README.md

# Video Alignment with Temporal Network

*author: David Wang*


<br />



## Description

This operator can compare two ordered sequences, then detect the range which features from each sequence are computationally similar in order.
<br />


## Code Example


```python
placeholder
```


<br />



## Factory Constructor

Create the operator via the following factory method

***clip(model_name, modality)***
***temporal_network(tn_max_step, tn_top_k, max_path, min_sim, min_length, max_iou)***


**Parameters:**

​   ***tn_max_step:*** *str*

​   Max step range in TN.

​   ***tn_top_k:*** *str*

​   Top k frame similarity selection in TN. 

​   ***max_path:*** *str*

​   Max loop for multiply segments detection. 

​   ***min_sim:*** *str*

​   Min average similarity score for each aligned segment. 

​   ***min_length:*** *str*

​   Min segment length. 

​   ***max_iout:*** *str*

​   Max iou for filtering overlap segments (bbox). 

<br />



## Interface

A Temporal Network operator takes two numpy.ndarray(shape(N,D) N: number of features. D: dimension of features) and get the duplicated ranges and scores.


**Parameters:**

​	***src_video_vec data:*** *numpy.ndarray*

​  Source video feature vectors.

​  ***dst_video_vec:*** *numpy.ndarray*

​  Destination video feature vectors.


**Returns:** *List[List[Int]], List[float] *

​   The returned aligned range and similarity score.