Skip to content

Commit

Permalink
update doc link
Browse files Browse the repository at this point in the history
  • Loading branch information
Binyang2014 committed Jan 16, 2025
1 parent a9bd223 commit 0f3f433
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![Latest Release](https://img.shields.io/github/release/microsoft/mscclpp.svg)](https://github.com/microsoft/mscclpp/releases/latest)
[![License](https://img.shields.io/github/license/microsoft/mscclpp.svg)](LICENSE)
[![CodeQL](https://github.com/microsoft/mscclpp/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/microsoft/mscclpp/actions/workflows/codeql-analysis.yml)
[![Docs Build](https://github.com/microsoft/mscclpp/actions/workflows/doc-build.yaml/badge.svg)](https://microsoft.github.io/mscclpp/)

| Pipelines | Build Status |
|--------------------------|-------------------|
Expand All @@ -12,7 +13,7 @@

A GPU-driven communication stack for scalable AI applications.

See [Quick Start](docs/getting-started/quickstart.md) to quickly get started.
See [Quick Start](https://microsoft.github.io/mscclpp/getting-started/quickstart.html) to quickly get started.

## Overview

Expand Down
4 changes: 2 additions & 2 deletions docs/design/mscclpp-dsl.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# MSCCLPP DSL
## MSCCLPPLang Intruduction
## MSCCLPPLang Introduction
MSCCLPPLang is a Python moudule for writing high-performance commnunication algorithms. It is designed to be easy to use and efficient, while providing a high-level interface for writing communication algorithms. MSCCLPPLang program will be compiled to json based execution plan, which can be executed by MSCCLPP executor.

## How to use MSCCLPPLang
Expand Down Expand Up @@ -67,7 +67,7 @@ c = chunk(0, Buffer.input, 0, 2)
```

#### Operation
The operation can only be applied to the chunks. We provide a set of communicatoin operations for the users to use. For example, the `put` operation is used to send the data from one GPU to another GPU. The `get` operation is used to receive the data from another GPU.
The operation can only be applied to the chunks. We provide a set of communications operations for the users to use. For example, the `put` operation is used to send the data from one GPU to another GPU. The `get` operation is used to receive the data from another GPU.

***Please notice***: MSCCLPPLang only provides one-sided communication operations. The user needs to make sure that the data is ready to be sent or received before calling the communication operations. Also we provides `wait/signal` operations to synchronize the communication across GPUs.

Expand Down

0 comments on commit 0f3f433

Please sign in to comment.