13. Web application function¶
This chapter describes the operation when using the Web application.
13.1. Web service use function entrance¶
As a service entrance, "Use Web Service" is displayed in the menu on the left side and in the usage options on the group details screen.
"Web service usage" is displayed in the user information field of the menu displayed on the left side of the screen.
Click this link to move to the web service use reception screen.
13.1.2. Group detail screen¶
Web service usage is added to the usage options on the group details screen.
Click the setting button to move to the Web service use reception screen.
13.2. Web service use reception screen configuration¶
This section describes the Web service usage reception screen configuration.
The Web usage reception screen consists of two parts: a usage registration interface and a list of registered jobs.
|1.||Usage registration interface||We accept the use of Web services. You can set the resource type and execution time when using|
|2.||List of registered jobs||A list of registered jobs is displayed. You can check the status of each job and perform operations such as canceling.|
13.3. Web service reception interface¶
This section describes the Web service use reception interface.
|1.||Web application||A drop-down list for selecting available applications.|
|2.||Queue for interactive use only||Use web services with a queue for interactive use only. The default usage time is 2 hours, but the settings can be changed.|
|3.||Use of paid services||Select when executing a Web application that uses a group point. You can select from two types: "usual node use (shared)" and "reserved node use (occupied)".
#If you use a reserved node, you will not be charged points for executing this application.
|4.||Trial use||Web application execution using the "trial usage frame" of the tsubame-users group. The usage time is 10 minutes (fixed).|
|5.||Node reservation fails||Specify the action to be taken when the Web application execution node request fails.|
|6.||Start-up||The Web service will start to be used under the entered conditions.|
13.3.1. About resource types¶
Select computer resources. The selectable resource items differ depending on the normal node usage and reserved node usage.
The available resource types are shown in the table below.
|Resource type:Complex name||f_node[F]||h_node[H]||q_node[Q]||s_gpu[G]||s_core[C1]||q_core[C4]|
|Physical CPU cores||28||14||7||2||1||4|
|Available on node reservation||○||○||○||×||×||×|
13.3.2. Execution time¶
Enter the character string "hour: minute: second". When only "hour: minute" is entered, "hour: minute: 00" is complemented.
13.3.3. AR ID¶
Enter the ARID of the reserved node that executes this Web application.
This is a required input when using the reserved node.
It is necessary to make a node reservation from the portal and obtain the ARID in advance.
13.3.4. 4 Acceptance dialog¶
The content displayed in the dialog when the start button is pressed changes as follows depending on the input content.
Except for the place where the input value is described, the system will automatically judge and display it.
|Resources used||Reserved node ID||Resource Type||Utilization time||Number of payment points|
|Interactive queue||Interactive queue||--||--||Input value||--|
|Paid(Normal node)||share||--||Input value||Input value||Deposit points|
|paid(reserve node)||Occupation||Input value||Input value||Input value||0|
|Trial use||share||--||Input value||00:10:00||--|
Fee-based service use and normal nodes
Fee-based service use and reserved nodes
13.4. Use web service¶
When a job is started by the web service execution function, an email with a URL to use the web application is sent to the email address registered in the portal.
The URL in the email can be used only once.
In addition, by clicking the [View] button on the Job List screen below, you can display the Web application in a separate window. If you want to display the web application again after using the URL in the email, use this option.
An example of Jupyter Lab
13.5. Web service job operations¶
This section describes the list of registered jobs.
|1.||Update button||Update the contents of the registered job list.|
|2.||Page selection menu (top)||Switches the page of the registered job list.|
|3.||List of registered jobs||A list of registered jobs is displayed. The background color and button display vary depending on the status.|
|State||The preparation status after registration is displayed.|
|Operation||Displays the available operation buttons according to the contents of the status column.|
|Group name||Displays the group name where the job was executed. The group name is hidden during the trial period (group name: tsubame-users).|
|ARID||Displays the AR ID at the time of reservation execution.|
|JOBID||Displays the job ID.|
|CPU (core)||Displays the number of physical CPU cores according to the resource type.|
|GPU||Displays the number of GPUs according to the resource type.|
|TIME (h)||Displays the job execution time.|
|Registration||Displays the date and time when the job was registered.|
|Start||Displays the date and time when the job started. If the job has not started, leave it blank.|
|End||Estimated end time is displayed in gray after the job starts, and when it is completed, the last end time is displayed.|
|POINT||Displays the points used. "-" Is displayed for non-paid use. While the job is being executed, it is displayed with () to indicate that it is a temporary holding point.|
The operation column changes as follows, depending on the state of the job.
|Preparing||Cancel||Preparing for execution. Cancel the job before execution.|
|Running||Display||Open and transfer the operation screen of the Web service in a new window.|
|End||Cancel the running job.|
|Stopping||-||The job is stopping.|
|End||-||It is a finished job.|
|Error||-||Job ended in error.
If you move the mouse cursor over the "Error" string, more information will be displayed as a tooltip.
We may ask you to confirm this information when you make an inquiry.
13.5.1. Canceling or terminating job¶
The job is automatically terminated by performing the termination operation in the web application.
If you want to cancel a job in "Preparing" after registration, or if you want to terminate a job in "Running" without going through the web application, you can select "Cancel" or "Exit" in the operation column, the following dialog will be displayed.
You can cancel or terminate the job by confirming the content and selecting "OK".
13.6. Jupyter screen display¶
For Jupyter Lab-specific explanations, please refer to the Jupyter Lab User's Guide.