Skip to content

Commit

Permalink
Merge branch 'master' into improve_neighbor_allreduce
Browse files Browse the repository at this point in the history
  • Loading branch information
Hanbin Hu committed Mar 26, 2021
2 parents d7a9310 + 7644f4a commit 2fe9621
Show file tree
Hide file tree
Showing 3 changed files with 113 additions and 3 deletions.
55 changes: 55 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Continuous Integration

on: [push]

jobs:
ubuntu-unit-test:

runs-on: ubuntu-18.04
strategy:
matrix:
mpi-vendor: ['openmpi', 'mpich']
python-version: [3.7, 3.8]

steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install MPI
run: ./scripts/install_mpi.sh ${{ matrix.mpi-vendor }}
- name: Install BlueFog
run: |
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
git submodule update --init --recursive
python -m pip install -e .
- name: Unit Test
run: make test_torch_basic test_torch_ops

macos-unit-test:

runs-on: macos-10.15
strategy:
matrix:
mpi-vendor: ['openmpi', 'mpich']
python-version: [3.7, 3.8]

steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install MPI
run: ./scripts/install_mpi.sh ${{ matrix.mpi-vendor }}
- name: Install BlueFog
run: |
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
git submodule update --init --recursive
python -m pip install -e .
- name: Unit Test
run: NUM_PROC=2 make test_torch_basic test_torch_ops test_torch_win_ops

34 changes: 34 additions & 0 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Document CI

on:
release:
types: [create, edited, prereleased, published]

jobs:
github-page:

runs-on: ubuntu-18.04

steps:
- uses: actions/checkout@v2
- name: Set up Python 3.7
uses: actions/setup-python@v2
with:
python-version: 3.7
- name: Install OpenMPI
run: |
sudo apt-get install -y -q openmpi-bin libopenmpi-dev
- name: Install BlueFog
run: |
git submodule update --init --recursive
python -m pip install -e .
- name: Build Document
run: |
python -m pip install matplotlib sphinx sphinx_rtd_theme
cd docs && make html
touch _build/html/.nojekyll
- name: Deploy Github Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html
27 changes: 24 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
BlueFog
=======

.. image:: https://github.com/Bluefog-Lib/bluefog/actions/workflows/ci.yml/badge.svg
:target: https://github.com/Bluefog-Lib/bluefog/actions/workflows/ci.yml/badge.svg

.. image:: https://travis-ci.com/Bluefog-Lib/bluefog.svg?branch=master
:target: https://travis-ci.com/Bluefog-Lib/bluefog

.. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
:target: https://img.shields.io/badge/License-Apache%202.0-blue.svg
:alt: License

.. image:: https://zenodo.org/badge/225537951.svg
:target: https://zenodo.org/badge/latestdoi/225537951

.. image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
:target: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat

Expand Down Expand Up @@ -143,11 +149,26 @@ Checkout our `API explanation page <https://bluefog-lib.github.io/bluefog/bluefo
The Bluefog source code was based off `Horovod <https://github.com/horovod/horovod>`_ repository. Hence, BlueFog shared lots of common features from Horovod such as `timeline <https://bluefog-lib.github.io/bluefog/timeline.html>`_, tensor-fusion, etc. Here, we want to express our gratitude to the Horovod team.

Materials
--------
---------
*Faster Learning over Networks and BlueFog*, BlueFog Team, invited talk at MLA, 2020 `[slides] <https://github.com/Bluefog-Lib/bluefog/blob/master/resources/Faster_Learning_over_Networks_and_BlueFog.pdf>`_

*BlueFog: Make Decentralized Algorithms Practical for Optimization and Deep Learning*, BlueFog Team, To Appear in 2020

*BlueFog: Make Decentralized Algorithms Practical for Optimization and Deep Learning*, BlueFog Team, To Appear in 2021

Cite
----
Bluefog is uploaded to Zenodo. An equivalent BibTex format reference is below for all the versions:

.. code-block::
@software{bluefog2021_4616052,
author = {BlueFog team},
title = {BlueFog},
month = Mar.,
year = 2021,
publisher = {Zenodo},
doi = {10.5281/zenodo.4616052},
url = {https://doi.org/10.5281/zenodo.4616052}
}
.. _AWS: https://aws.amazon.com/about-aws/whats-new/2018/12/introducing-amazon-ec2-p3dn-instances-our-most-powerful-gpu-instance-yet/
.. _examples: https://github.com/Bluefog-Lib/bluefog/tree/master/examples

0 comments on commit 2fe9621

Please sign in to comment.