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

Open Beginner friendly

#6,197 opened on Feb 18, 2025 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 2/5
Estimated time: 1-3 hours
Newbie friendliness: 76/100

Issue type: Documentation
Clarity: Mostly clear
Activity status: Active
Tech stack: python
Domain: distributed-systems, documentation

Research direction

Start with colossalai/shardformer/README.md and compare its ShardConfig documentation with the tensor_parallel_mode definition mentioned in the issue. Update the documentation to cover 1D, 2D, 2.5D, and 3D tensor parallelism, then verify that the documented options match ShardConfig.

Written by the indexing model from the issue text.

Description

documentation

📚 The doc issue

Hi @FrankLeeeee , @ver217 please update the https://github.com/hpcaitech/ColossalAI/blob/main/colossalai/shardformer/README.md file

# tensor_parallel_mode: Literal['1d', '2d', '2.5d', '3d'] this line is commented in ShardConfig but documentation is not updated Its hard to use 2D,2.5D, 3D tensor parallelism

Dominant language: Python
Stars: 41.4k
Forks: 4.5k
PR merge metrics: No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.

Similar issues

[BUG] GkeTpuCluster queries metadata.google.internal for MEGASCALE_SLICE_ID even when TPU_SKIP_MDS_QUERY is set Open

Difficulty 2/5 1-3 hours Newbie friendliness 88/100

jax-ml/jax#40854 · Opened Sep 22, 2026
[pcied] Honour PCIE_DETACH_INFO on platforms that are not smartswitches Open

Difficulty 2/5 1-3 hours Newbie friendliness 82/100

sonic-net/sonic-platform-daemons#900 · Opened Sep 21, 2026
MCP client has no httpx timeout, so the event stream fails after 5 seconds Open

Difficulty 2/5 1-3 hours Newbie friendliness 78/100

Azure/azure-functions-agents-runtime#228 · Opened Sep 21, 2026
feat(mcp): friendlier error when `run_cloud_sync` is called on a disabled connection Open

enhancement

Difficulty 2/5 1-3 hours Newbie friendliness 72/100

airbytehq/PyAirbyte#1205 · Opened Sep 21, 2026
pn7160: reader goes permanently deaf — post-read IRQ-low check fails reads that succeeded Open

Difficulty 2/5 1-3 hours Newbie friendliness 74/100

esphome/esphome#19452 · Opened Sep 21, 2026

More Python issues