Skip to content

Commit c85b18f

Browse files
lekurileLeetJoe
authored andcommitted
Add DS-Chat CI badge and documentation (deepspeedai#697)
This PR adds the DS-Chat CI badge and documentation to the main and DS-Chat READMEs.
1 parent 001494d commit c85b18f

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ Model compression examples.
1616
## 5. Benchmarks
1717
All benchmarks that use the DeepSpeed library are maintained in this folder.
1818

19+
# Build Pipeline Status
20+
| Description | Status |
21+
| ----------- | ------ |
22+
| Integrations | [![nv-ds-chat](https://github.com/microsoft/DeepSpeed/actions/workflows/nv-ds-chat.yml/badge.svg?branch=master)](https://github.com/microsoft/DeepSpeed/actions/workflows/nv-ds-chat.yml) |
1923

2024
# Contributing
2125

applications/DeepSpeed-Chat/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ A fast, affordable, scalable and open system framework for enabling end-to-end R
4848
- [🐼 Serving Your Model: Plug-in and Test!](#-serving-plug-in-your-final-model-trained-by-deepspeed-chat-and-test-it-out)
4949
- [🔥 Training Performance Evaluation 🔥](#-training-performance-evaluation-)
5050
- [😽 Supported Models 😽](#-supported-models-)
51+
- [🔬 Build Pipeline Status 🔬](#-build-pipeline-status-)
5152
- [⚓ Documentation and Tutorial ⚓](#-documentation-and-tutorial-)
5253
- [🌱 DeepSpeed Chat's Roadmap 🌱](#-deepspeed-chats-roadmap-)
5354
- [💬 DeepSpeed Chat and DeepSpeed Community 💬](#-deepspeed-chat-and-deepspeed-community-)
@@ -387,6 +388,33 @@ model family | size range
387388

388389
* All performance and accuracy tests have been performed using the OPT model family only. For other models, please see our training_scripts folder on how to change model families.
389390

391+
392+
## 🔬 Build Pipeline Status 🔬
393+
394+
| Description | Status |
395+
| ----------- | ------ |
396+
| Integrations | [![nv-ds-chat](https://github.com/microsoft/DeepSpeed/actions/workflows/nv-ds-chat.yml/badge.svg?branch=master)](https://github.com/microsoft/DeepSpeed/actions/workflows/nv-ds-chat.yml) |
397+
398+
A DeepSpeed CI workflow runs the DeepSpeed-Chat Step 3 pipeline nightly across the following test configurations:
399+
400+
Models
401+
```
402+
Actor: facebook/opt-125m
403+
Critic: facebook/opt-125m (trained in DS-Chat Step 2)
404+
```
405+
406+
Parameters comprising test matrix
407+
```
408+
Zero Stage: 2, 3
409+
Hybrid Engine: True, False
410+
Offload: True, False
411+
LoRA: True, False
412+
```
413+
414+
Each configuration (16 total) runs through a limited number of Step 3 non-overflow training steps (i.e. steps where neither actor nor critic overflow) and saves the actor/critic models.
415+
Assertions are used to check if the training pipeline executed correctly and if the actor and critic models were saved properly.
416+
417+
390418
## ⚓ Documentation and Tutorial ⚓
391419

392420
For more APIs, example scripts, and evaluation results, please refer to

0 commit comments

Comments
 (0)