ColossalAI/docs/source/en/basics/command_line_tool.md
Hongxin Liu b5f9e37c70
[legacy] clean up legacy code (#4743)
* [legacy] remove outdated codes of pipeline (#4692)

* [legacy] remove cli of benchmark and update optim (#4690)

* [legacy] remove cli of benchmark and update optim

* [doc] fix cli doc test

* [legacy] fix engine clip grad norm

* [legacy] remove outdated colo tensor (#4694)

* [legacy] remove outdated colo tensor

* [test] fix test import

* [legacy] move outdated zero to legacy (#4696)

* [legacy] clean up utils (#4700)

* [legacy] clean up utils

* [example] update examples

* [legacy] clean up amp

* [legacy] fix amp module

* [legacy] clean up gpc (#4742)

* [legacy] clean up context

* [legacy] clean core, constants and global vars

* [legacy] refactor initialize

* [example] fix examples ci

* [example] fix examples ci

* [legacy] fix tests

* [example] fix gpt example

* [example] fix examples ci

* [devops] fix ci installation

* [example] fix examples ci
2023-09-18 16:31:06 +08:00

1.0 KiB

Command Line Tool

Author: Shenggui Li

Prerequisite:

Introduction

Colossal-AI provides command-line utilities for the user. The current command line tools support the following features.

  • verify Colossal-AI build
  • launch distributed jobs
  • tensor parallel micro-benchmarking

Check Installation

To verify whether your Colossal-AI is built correctly, you can use the command colossalai check -i. This command will inform you information regarding the version compatibility and cuda extension.

Check Installation Demo

Launcher

To launch distributed jobs on single or multiple nodes, the command colossalai run can be used for process launching. You may refer to Launch Colossal-AI for more details.