Skip to content

【A simple C++ DAG framework】 一个简单好用的、无任何三方依赖的、跨平台的、基于流图的并行计算框架。欢迎star & fork

License

Notifications You must be signed in to change notification settings

bangzhu0357/CGraph

 
 

Repository files navigation

languages os stars forks

CGraph 说明文档

CGraph is a cross-platform DAG(Directed Acyclic Graph) framework based on pure C++ without any 3rd-party.

You, with it, can build your own operators simply, and describe any running schedules as you need, such as dependence, parallelling, aggregation and so on. Some useful tools and plugins are also provided to improve your project.

Tutorials and contact information are shown as follows. Please get in touch with us for free if you need more about this repository.

一. 简介

本工程实现了一套无任何第三方依赖的跨平台图流程计算框架。通过GPipeline(流水线)底层调度,实现了依赖元素依次顺序执行、非依赖元素并发执行的调度功能。

使用者只需继承GNode(节点)类,实现子类的run()方法,并根据需要设定依赖关系,即可实现任务的图化执行。

同时,使用者还可以通过设定各种包含多节点信息的GGroup(组),自行控制图的条件判断、循环和并发执行逻辑。

此外,还可以通过添加GAspect(切面)的方式,实现以上各种元素功能的横向扩展,或是通过引入各种GAdapter(适配器)对单个节点功能进行加强。

CGraph Skeleton

二. 编译说明

  • 本工程支持MacOS、Linux和Windows系统,无任何第三方依赖。推荐使用C++17(默认)或以上版本,向下兼容C++14版本,不支持C++11或以下版本

  • 使用CLion作为IDE的开发者,打开CMakeLists.txt文件作为工程,即可编译通过

  • Linux环境开发者,在命令行模式下,输入以下指令,即可编译通过

    $ git clone https://github.com/ChunelFeng/CGraph.git
    $ cd CGraph
    $ cmake . -Bbuild
    $ cd build
    $ make -j8
  • Windows环境中,使用Visual Studio作为IDE的开发者,clone本工程前请优先设置换行符类型

    $ git config --global core.autocrlf true        # 设置Windows平台支持的CRLF换行符形式
    $ git clone https://github.com/ChunelFeng/CGraph.git
    $ ... ...        # 接下来操作同Linux命令行环境,即可生成相应的*.sln文件
  • 提供基于Ubuntu 20.04.3的Docker镜像。输入以下指令,即可获取并进入

    $ docker pull chunelfeng/cenv                         # 获取docker镜像
    $ docker run -it --name CGraphEnv chunelfeng/cenv     # 开启docker容器,并进入
  • 提供online版本的编译调试环境,点击进入页面:CGraph env online,输入以下指令,即可编译通过,并查看执行结果

    $ ./CGraph-build.sh          # 编译CGraph工程,生成的内容在同级/build/文件夹中
    $ ./build/T00-HelloCGraph    # 运行第一个实例程序,并且在终端输出 Hello, CGraph.

三. 使用Demo

MyNode1.h

#include "../../src/CGraph.h"

class MyNode1 : public CGraph::GNode {
public:
    CStatus run () override {
        CStatus status;
        CGraph::CGRAPH_ECHO("[%s], enter MyNode1 run function. Sleep for 1 second ... ", this->getName().c_str());
        CGRAPH_SLEEP_SECOND(1)
        return status;
    }
};

MyNode2.h

#include "../../src/CGraph.h"

class MyNode2 : public CGraph::GNode {
public:
    CStatus run () override {
        CStatus status;
        CGraph::CGRAPH_ECHO("[%s], enter MyNode2 run function. Sleep for 2 second ... ", this->getName().c_str());
        CGRAPH_SLEEP_SECOND(2)
        return status;
    }
};

main.cpp

#include "MyGNode/MyNode1.h"
#include "MyGNode/MyNode2.h"

using namespace CGraph;

int main() {
    /* 创建一个流水线,用于设定和执行流图信息 */
    GPipelinePtr pipeline = GPipelineFactory::create();
    GElementPtr a, b, c, d = nullptr;

    /* 注册节点,其中MyNode1和MyNode2必须为GNode的子类,否则无法通过编译 */
    CStatus status = pipeline->registerGElement<MyNode1>(&a, {}, "nodeA");    // 将名为nodeA,无执行依赖的node信息,注册入pipeline中
    status += pipeline->registerGElement<MyNode2>(&b, {a}, "nodeB");    // 将名为nodeB,依赖a执行的node信息,注册入pipeline中
    status += pipeline->registerGElement<MyNode1>(&c, {a}, "nodeC");
    status += pipeline->registerGElement<MyNode2>(&d, {b, c}, "nodeD");    // 将名为nodeD,依赖{b,c}执行的node信息,注册入pipeline中
    if (!status.isOK()) {
        return;    // 对以上所有CGraph接口的返回值做判定
    }

    /* 执行流图框架 */
    status = pipeline->process();
    GPipelineFactory::remove(pipeline);

    return 0;
}

CGraph Demo
如上图所示,图结构执行的时候,首先执行a节点。a节点执行完毕后,并行执行bc节点。bc节点全部执行完毕后,再执行d节点。

四. 推荐阅读

五. 关联项目

  • GraphANNS : Graph-based Approximate Nearest Neighbor Search Working off CGraph

附录-1. 版本信息

[2022.04.05 - v2.0.0 - Chunel]

  • 提供Domain(领域)功能,提供Ann领域抽象模型,开始支持个别专业方向
  • 提供hold执行机制,支持根据运行时条件,判断是否需要重新执行当前内容,直到满足条件为止
  • 更新tutorial内容

[2022.05.01 - v2.0.1 - Chunel]

  • 优化pipeline注册机制,支持init方法自定义顺序执行
  • 提供一键编译脚本

[2022.05.29 - v2.1.0 - Chunel]

  • 提供element参数写入方法
  • 提供针对C++14版本的支持,个别功能有裁剪
  • 更新tutorial内容

更多版本变更信息,请参考 ChangeLog.md 文件


附录-2. 感谢


附录-3. 联系方式

CGraph Author

About

【A simple C++ DAG framework】 一个简单好用的、无任何三方依赖的、跨平台的、基于流图的并行计算框架。欢迎star & fork

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 92.6%
  • C 5.8%
  • CMake 1.1%
  • Other 0.5%