Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove "Task Response Aggregation Route" #168

Merged
merged 2 commits into from
Jun 8, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions docs/docs/Workflow-Manager-Architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,18 +144,14 @@ Once the job is completed, this route converts the aggregated track and detectio

## Detection Response Route

The **Detection Response Route** is the re-entry point to the WFM. It unmarshals the protobuf responses from components and converts them into the Track and Detection objects used within the WFM. It then optionally performs each of the following actions: track merging, detection padding, detecting moving objects, and artifact extraction. It stores the track and detection data in the Redis database and optionally uploads artifacts to an object storage server.

## Task Response Aggregation Route <small><i>(Not Shown)</i></small>

The **Task Response Aggregation Route** is one of the exit points for the Detection Response Route. It waits until all of the sub-job responses have been retrieved for the current stage (task) of the pipeline, then it invokes the Job Router Route to see if any additional processing needs to be done.
The **Detection Response Route** is the re-entry point to the WFM. It unmarshals the protobuf responses from components and converts them into the Track and Detection objects used within the WFM. It then optionally performs each of the following actions: track merging, detection padding, detecting moving objects, and artifact extraction. It stores the track and detection data in the Redis database and optionally uploads artifacts to an object storage server. Then, it invokes the Job Router Route to see if any additional processing needs to be done.

## Markup Response Route <small><i>(Not Shown)</i></small>

Markup files are copies of the initial media with any detections visually highlighted in the frame. The **Markup Response Route** optionally uploads the markup files generated by the Markup component to an object storage server and persists the locations of these markup files in the SQL database.

## Other Routes <small><i>(Not Shown)</i></small>

Additionally, there is a **Detection Cancellation Route** for cancelling detection requests sent to components, and a **Markup Cancellation Route** for cancelling requests sent to the Markup component.
Additionally, there is a **Detection Cancellation Route** for cancelling detection requests sent to components, and a **Markup Cancellation Route** for cancelling requests sent to the Markup component.

Also, there is a **DLQ Route** for handling messages that appear in the ActiveMQ Dead Letter Queue (DLQ), which usually indicates a component failure or inability to deliver a message. In these cases, the job is terminated with an error condition.
8 changes: 2 additions & 6 deletions docs/site/Workflow-Manager-Architecture/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -206,8 +206,6 @@

<li><a class="toctree-l4" href="#detection-response-route">Detection Response Route</a></li>

<li><a class="toctree-l4" href="#task-response-aggregation-route-not-shown">Task Response Aggregation Route (Not Shown)</a></li>

<li><a class="toctree-l4" href="#markup-response-route-not-shown">Markup Response Route (Not Shown)</a></li>

<li><a class="toctree-l4" href="#other-routes-not-shown">Other Routes (Not Shown)</a></li>
Expand Down Expand Up @@ -419,13 +417,11 @@ <h2 id="job-router-route">Job Router Route</h2>
<p>This route may be invoked multiple times as future routes redirect back to the Job Router so that the job can be processed by the next component in the pipeline.</p>
<p>Once the job is completed, this route converts the aggregated track and detection data in Redis into a JSON output format. It then clears out all data in Redis for the job, updates the final job status in the SQL database, optionally uploads the JSON output object to an object storage server, and optionally makes a callback to the endpoint listed in the job request.</p>
<h2 id="detection-response-route">Detection Response Route</h2>
<p>The <strong>Detection Response Route</strong> is the re-entry point to the WFM. It unmarshals the protobuf responses from components and converts them into the Track and Detection objects used within the WFM. It then optionally performs each of the following actions: track merging, detection padding, detecting moving objects, and artifact extraction. It stores the track and detection data in the Redis database and optionally uploads artifacts to an object storage server.</p>
<h2 id="task-response-aggregation-route-not-shown">Task Response Aggregation Route <small><i>(Not Shown)</i></small></h2>
<p>The <strong>Task Response Aggregation Route</strong> is one of the exit points for the Detection Response Route. It waits until all of the sub-job responses have been retrieved for the current stage (task) of the pipeline, then it invokes the Job Router Route to see if any additional processing needs to be done.</p>
<p>The <strong>Detection Response Route</strong> is the re-entry point to the WFM. It unmarshals the protobuf responses from components and converts them into the Track and Detection objects used within the WFM. It then optionally performs each of the following actions: track merging, detection padding, detecting moving objects, and artifact extraction. It stores the track and detection data in the Redis database and optionally uploads artifacts to an object storage server. Then, it invokes the Job Router Route to see if any additional processing needs to be done.</p>
<h2 id="markup-response-route-not-shown">Markup Response Route <small><i>(Not Shown)</i></small></h2>
<p>Markup files are copies of the initial media with any detections visually highlighted in the frame. The <strong>Markup Response Route</strong> optionally uploads the markup files generated by the Markup component to an object storage server and persists the locations of these markup files in the SQL database.</p>
<h2 id="other-routes-not-shown">Other Routes <small><i>(Not Shown)</i></small></h2>
<p>Additionally, there is a <strong>Detection Cancellation Route</strong> for cancelling detection requests sent to components, and a <strong>Markup Cancellation Route</strong> for cancelling requests sent to the Markup component. </p>
<p>Additionally, there is a <strong>Detection Cancellation Route</strong> for cancelling detection requests sent to components, and a <strong>Markup Cancellation Route</strong> for cancelling requests sent to the Markup component.</p>
<p>Also, there is a <strong>DLQ Route</strong> for handling messages that appear in the ActiveMQ Dead Letter Queue (DLQ), which usually indicates a component failure or inability to deliver a message. In these cases, the job is terminated with an error condition.</p>

</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -380,5 +380,5 @@ <h1 id="overview">Overview</h1>

<!--
MkDocs version : 0.17.5
Build Date UTC : 2023-05-10 01:08:58
Build Date UTC : 2023-05-26 17:51:52
-->
Loading