ms-swift/docs/source_en/GetStarted/Web-UI.md

Web-UI

Currently, SWIFT supports interface-based training and inference, with parameter support similar to script training. After installing SWIFT, use the following command:

swift web-ui --lang zh
# or en
swift web-ui --lang en

to start the interface for training and inference.

SWIFT web-ui is a high-level wrapper for the command line. In other words, tasks such as training and deployment initiated through the interface will start an independent process in the system via the command line. Pseudo-code is similar to:

import os
os.system('swift sft --model xxx --dataset xxx')

This provides several features for the web-ui:

1. Each hyperparameter description in the web-ui is prefixed with --xxx, consistent with the command line arguments.
2. The web-ui can concurrently start multiple training/deployment tasks on a multi-GPU machine.
3. After the web-ui service is closed, the background services continue to run. This prevents the training processes from being affected when the web-ui is shut down. If you need to terminate background services, simply select the corresponding task and click the kill service button in the Runtime tab on the interface.
4. After restarting the web-ui, if you need to display the running services, click Recover Runtime Tasks in the Runtime tab.
5. The training interface supports displaying runtime logs. After selecting a specific task, manually click Show Runtime Status. During training, the runtime status can display training charts, including basic metrics such as training loss, training accuracy, and learning rate. In the human alignment task interface, the charts display key metrics like margin and logps.
6. Training through the web-ui does not support PPO, as the process is more complex. It is recommended to use the shell script in the examples directory to run it directly.

If you need to use share mode, please add the --share true parameter. Note: Do not use this parameter in environments such as dsw or notebooks.

Additionally, ms-swift supports interface inference mode (i.e., Space deployment):

swift app --model '<model>' --studio_title My-Awesome-Space --stream true
# or
swift app --model '<model>' --adapters '<adapter>' --studio_title My-Awesome-Space --stream true

This will launch an application with only the inference page, which will deploy the model upon startup and provide it for subsequent use.