Skip to content

Commit acd38c5

Browse files
committed
More update
Signed-off-by: M Q <mingmelvinq@nvidia.com>
1 parent a6036a4 commit acd38c5

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

platforms/aidoc/README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ This example uses a subset of the callback message attributes, covering only the
99
The high-level design of this REST service involves a few key components:
1010

1111
1. **MONAI Deploy Application**: The core AI logic is encapsulated in a standard MONAI Deploy application (e.g., `AISpleenSegApp`), which is built and tested as a regular containerized workload.
12-
2. **RESTful Service**: A lightweight RESTful application, built using Flask, acts as the front-end. It exposes endpoints to start and check the status of a processing job.
12+
2. **REST Service**: A lightweight REST application, built using Flask, acts as the front-end. It exposes endpoints to start and check the status of a processing job.
1313
3. **Request Handling**:
14-
- When the RESTful service receives a request to process data, it handles only one request at a time, as per the API specification.
14+
- When the REST service receives a request to process data, it handles only one request at a time, as per the API specification.
1515
- It creates an instance of the MONAI Deploy application.
1616
- It sets the necessary environment variables for the input and output folders.
1717
- Crucially, it delegates the execution of the MONAI Deploy application to a separate background thread to avoid blocking the web server.
@@ -34,7 +34,7 @@ C4Component
3434
3535
Person(client, "External Client", "e.g., Aidoc Platform")
3636
37-
Container_Boundary(rest_service_container, "RESTful Service") {
37+
Container_Boundary(rest_service_container, "REST Service") {
3838
Component(flask, "Flask App", "Python, Flask", "Handles HTTP requests, manages processing threads, and sends callbacks.")
3939
}
4040
@@ -61,20 +61,20 @@ This diagram illustrates the sequence of interactions for a processing job, incl
6161
```mermaid
6262
sequenceDiagram
6363
actor Client
64-
participant RESTful Service
64+
participant REST Service
6565
participant "MONAI Deploy App Thread" as AppThread
6666
participant AISpleenSegApp
6767
68-
Client->>+RESTful Service: POST /process (payload)
69-
RESTful Service-->>-Client: HTTP 202 Accepted
70-
RESTful Service->>+AppThread: Spawn thread(run_processing)
68+
Client->>+REST Service: POST /process (payload)
69+
REST Service-->>-Client: HTTP 202 Accepted
70+
REST Service->>+AppThread: Spawn thread(run_processing)
7171
7272
opt While processing is busy
73-
Client->>+RESTful Service: POST /process (payload)
74-
RESTful Service-->>-Client: HTTP 409 Conflict
73+
Client->>+REST Service: POST /process (payload)
74+
REST Service-->>-Client: HTTP 409 Conflict
7575
76-
Client->>+RESTful Service: GET /status
77-
RESTful Service-->>-Client: HTTP 200 OK ("status": "BUSY")
76+
Client->>+REST Service: GET /status
77+
REST Service-->>-Client: HTTP 200 OK ("status": "BUSY")
7878
end
7979
8080
AppThread->>+AISpleenSegApp: Create instance(status_callback)
@@ -89,11 +89,11 @@ sequenceDiagram
8989
AppThread->>+Client: POST callback_url (Final Results)
9090
Client-->>-AppThread: HTTP 200 OK
9191
92-
Note over RESTful Service: Processing status set to IDLE.
92+
Note over REST Service: Processing status set to IDLE.
9393
deactivate AppThread
9494
95-
Client->>+RESTful Service: GET /status
96-
RESTful Service-->>-Client: HTTP 200 OK ("status": "IDLE")
95+
Client->>+REST Service: GET /status
96+
REST Service-->>-Client: HTTP 200 OK ("status": "IDLE")
9797
```
9898

9999
## How to Run
@@ -149,7 +149,7 @@ a callback endpoint to receives message content at the specified port.
149149
Open another console window and change directory to the same as this file.
150150

151151
Set the environment vars so that the test script can get the input DCM and write the callback contents.
152-
Also, once the Restful app completes each processing, the Spleen Seg app's output will also be saved in
152+
Also, once the REST app completes each processing, the Spleen Seg app's output will also be saved in
153153
the output folder specified below (the script passes the output folder via the Rest API).
154154
155155
```

0 commit comments

Comments
 (0)