Skip to content

[DOC]: Update the documentation of ShardConfig for 1D, 2D, 2.5D, 3D tensor parallelism #6278

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
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
6 changes: 6 additions & 0 deletions colossalai/shardformer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,12 @@ Following are the description `ShardConfig`'s arguments:

- `extra_kwargs`: A dict to store extra kwargs for ShardFormer.

- - `tensor_parallel_mode`: A choice of parallel modes for tensor operations. Supported modes are:
- `'1d'`: 1D tensor parallelism
- `'2d'`: 2D tensor parallelism
- `'2.5d'`: 2.5D tensor parallelism
- `'3d'`: 3D tensor parallelism

### Write your own policy

If you have a custom model, you can also use Shardformer to parallelize it by writing your own sharding policy. More information about the sharding policy can be found in [API Design](#-api-design).
Expand Down