# blinkplus

**Repository Path**: xccl-yun/blinkplus

## Basic Information

- **Project Name**: blinkplus
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-05
- **Last Updated**: 2024-12-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# BLINK+

## Link to final report
> Including test settings, bandwidth result, etc

[link to gdrive](https://drive.google.com/file/d/1beK4ZheRnRLD1RnavPb68ObhMmx7KY5j/view?usp=sharing)


## File structure overview
```shell
src/            # Blink+ implementation
include/        # Blnk+ header file
test_bandwidth/ # Bandwidth benchmark test, include bandwidth test for nccl and bandwidth test for Blink+
visualization/  # Visualize experiment result
graphs/         # .xml files that Blink+ use
```


## Install

* Build nccl package v2.7.8

Blink+ relies on NCCL v2.7.8. We have prepared a NCCL package v2.7.8 with some bug fix [link](https://github.com/UCBerkeley-Spring2022-CS267-project/blinkplus-nccl-base)

```shell
git clone https://github.com/UCBerkeley-Spring2022-CS267-project/blinkplus-nccl-base.git
cd blinkplus-nccl-base
```

and then follow the INSTALL.md file here [link](https://github.com/UCBerkeley-Spring2022-CS267-project/blinkplus-nccl-base/blob/blinkplus_base_v2.7.8/INSTALL.md) to install NCCL

* Build blink+ library and benchmark
```shell
mkdir build
cd build
cmake .. -DCMAKE_CUDA_COMPILER=/usr/local/cuda-11.5/bin/nvcc -DCMAKE_BUILD_TYPE=Release
make -j 10
sudo make install
```


* Export graph path

```shell
export BLINKPLUS_GRAPH_FILE_CHAIN_01=`pwd`/graphs/user01/chain01.xml
export BLINKPLUS_GRAPH_FILE_CHAIN_021=`pwd`/graphs/user01/chain021.xml
export BLINKPLUS_GRAPH_FILE_CHAIN_031=`pwd`/graphs/user01/chain031.xml
export BLINKPLUS_GRAPH_FILE_CHAIN_0321=`pwd`/graphs/user01/chain0321.xml

export BLINKPLUS_GRAPH_FILE_CHAIN_12=`pwd`/graphs/user12/chain12.xml
export BLINKPLUS_GRAPH_FILE_CHAIN_102=`pwd`/graphs/user12/chain102.xml
export BLINKPLUS_GRAPH_FILE_CHAIN_132=`pwd`/graphs/user12/chain132.xml

export BLINKPLUS_GRAPH_FILE_CHAIN_013=`pwd`/graphs/user03/chain013.xml
export BLINKPLUS_GRAPH_FILE_CHAIN_023=`pwd`/graphs/user03/chain023.xml

export BLINKPLUS_GRAPH_FILE_CHAIN_203=`pwd`/graphs/user23/chain203.xml
export BLINKPLUS_GRAPH_FILE_CHAIN_213=`pwd`/graphs/user23/chain213.xml
export BLINKPLUS_GRAPH_FILE_CHAIN_2103=`pwd`/graphs/user23/chain2103.xml

export BLINKPLUS_GRAPH_FILE_CHAIN_032=`pwd`/graphs/user02/chain032.xml
export BLINKPLUS_GRAPH_FILE_CHAIN_012=`pwd`/graphs/user02/chain012.xml

export BLINKPLUS_GRAPH_FILE_CHAIN_103=`pwd`/graphs/user13/chain103.xml
export BLINKPLUS_GRAPH_FILE_CHAIN_123=`pwd`/graphs/user13/chain123.xml
```


## Experiment
```shell
cd test_bandwidth
bash blinkplus_optimal_broadcast_timing.sh
bash blinkplus_optimal_allreduce_timing.sh

bash nccl_allreduce_timing.sh
bash nccl_broadcast_timing.sh
```

## Visualization
Run the notebook 
```shell
visualization/test_bandwidth.ipynb
```


## Acknowlege

This project is part of the final project for Xiao Song, Yefan Zhou, and Yibai Meng's Spring 2022 [CS267](https://sites.google.com/lbl.gov/cs267-spr2022) course at UC Berkeley. 

Thanks for the help from our GSI [Guanhua Wang](https://people.eecs.berkeley.edu/~guanhua/)'s project idea and help. 

Thanks for the help from NCCL's author [Sylvain Jeaugey](https://github.com/sjeaugey) on his help on answering our github issue questions.