Infrastructure
中文 | English Readme
CGraph is a cross-platform Directed Acyclic Graph framework based on pure C++ without any 3rd-party dependencies.
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 provide to improve your project.
Tutorials and contact information are show as follows. Please get in touch with us for free if you need more about this repository.
CGraph
中文名为【色丶图】,是一套无任何第三方依赖的跨平台图流程执行框架。通过GPipeline
(流水线)底层调度,实现了依赖元素依次顺序执行、非依赖元素并发执行的调度功能。
使用者只需继承GNode
(节点)类,实现子类的run()方法,并根据需要设定依赖关系,即可实现任务的图化执行或流水线执行。还可以通过设定各种包含多节点信息的GGroup
(组),自行控制图的条件判断、循环和并发执行逻辑。
项目提供了丰富的Param
(参数)类型,用于不同应用场景下的数据互通。此外,还可以通过添加GAspect
(切面)的方式,实现以上各种元素功能的横向扩展;通过引入GAdapter
(适配器)对单个节点功能进行加强;或者通过添加GEvent
(信号),丰富和优化执行逻辑。
本工程使用纯C++11标准库编写,无任何第三方依赖。兼容MacOS
、Linux
、Windows
和Android
系统,支持通过 CLion
、VSCode
、Xcode
、Visual Studio
、Code::Blocks
、Qt Creator
等多款IDE进行本地编译和二次开发,具体编译方式请参考 CGraph 编译说明
详细功能介绍和用法,请参考 一面之猿网 中的文章内容。相关视频在B站持续更新中,欢迎观看交流和一键三连:
#include "CGraph.h"
class MyNode1 : public CGraph::GNode {
public:
CStatus run() override {
printf("[%s], sleep for 1 second ...\n", this->getName().c_str());
CGRAPH_SLEEP_SECOND(1)
return CStatus();
}
};
class MyNode2 : public CGraph::GNode {
public:
CStatus run() override {
printf("[%s], sleep for 2 second ...\n", this->getName().c_str());
CGRAPH_SLEEP_SECOND(2)
return CStatus();
}
};
#include "MyNode.h"
using namespace CGraph;
int main() {
/* 创建一个流水线,用于设定和执行流图信息 */
GPipelinePtr pipeline = GPipelineFactory::create();
GElementPtr a, b, c, d = nullptr;
/* 注册节点之间的依赖关系 */
pipeline->registerGElement<MyNode1>(&a, {}, "nodeA");
pipeline->registerGElement<MyNode2>(&b, {a}, "nodeB");
pipeline->registerGElement<MyNode1>(&c, {a}, "nodeC");
pipeline->registerGElement<MyNode2>(&d, {b, c}, "nodeD");
/* 执行流图框架 */
pipeline->process();
GPipelineFactory::remove(pipeline);
return 0;
}
如上图所示,图结构执行的时候,首先执行a
节点。a
节点执行完毕后,并行执行b
和c
节点。b
和c
节点全部执行完毕后,再执行d
节点。
[2021.05.04 - v1.0.0 - Chunel]
[2021.05.09 - v1.1.0 - Chunel]
[2021.05.18 - v1.1.1 - Chunel]
name
和session
信息[2021.05.23 - v1.2.0 - Chunel]
[2021.05.29 - v1.3.0 - Chunel]
cluster
(簇)和region
(区域)划分和循环执行功能tutorial
内容,包含多种使用样例[2021.06.14 - v1.4.0 - Chunel]
param
(参数)传递机制group
(组)功能,多节点模块统一继承自group
模块[2021.06.20 - v1.4.1 - Chunel]
condition
(条件)功能[2021.06.24 - v1.5.0 - Chunel]
pipeline
工厂创建方法tutorial
内容[2021.07.07 - v1.5.1 - Chunel]
[2021.07.11 - v1.5.2 - Chunel]
[2021.07.31 - v1.5.3 - Chunel]
[2021.08.29 - v1.6.0 - Chunel]
pipeline
功能,优化底层逻辑tutorial
内容[2021.09.19 - v1.6.1 - Chunel]
Lru
算子、Trie
算子和模板节点功能,优化底层逻辑tutorial
内容[2021.09.29 - v1.7.0 - Chunel]
aspect
(切面)功能,用于横向扩展node
或group
功能tutorial
内容[2021.10.07 - v1.7.1 - Chunel]
aspect
(切面)实现逻辑,提供切面参数功能,提供批量添加切面功能tutorial
内容[2021.11.01 - v1.8.0 - Chunel]
adapter
(适配器)功能,提供singleton
适配器功能pipeline
执行逻辑tutorial
内容[2021.12.18 - v1.8.1 - Chunel]
CStatus
信息[2022.01.02 - v1.8.2 - Chunel]
task group
(任务组)功能[2022.01.23 - v1.8.3 - Chunel]
function
适配器,实现函数式编程功能tutorial
内容[2022.01.31 - v1.8.4 - Chunel]
node
(节点)异步执行的功能[2022.02.03 - v1.8.5 - Chunel]
daemon
(守护)功能,用于定时执行非流图中任务tutorial
内容[2022.04.03 - v1.8.6 - Chunel]
DistanceCalculator
算子,用于实现任意数据类型、任意距离类型的计算tutorial
内容[2022.04.05 - v2.0.0 - Chunel]
domain
(领域)功能,提供Ann
领域抽象模型,开始支持个别专业方向tutorial
内容[2022.05.01 - v2.0.1 - Chunel]
pipeline
注册机制,支持init方法自定义顺序执行[2022.05.29 - v2.1.0 - Chunel]
element
参数写入方法tutorial
内容[2022.10.03 - v2.1.1 - Chunel]
group
执行逻辑[2022.11.03 - v2.2.0 - Chunel]
message
(消息)功能,主要用于完成不同pipeline
之间的数据传递tutorial
内容[2022.12.24 - v2.2.1 - Chunel]
TemplateNode
(模板节点)功能,用于优化参数传参方式tutorial
内容[2022.12.25 - v2.2.2 - yeshenyong]
[2022.12.30 - v2.2.3 - Chunel]
message
发布订阅功能[2023.01.21 - v2.3.0 - Chunel]
event
(事件)功能CGraph Intro.xmind
文件,通过脑图的方式,介绍了CGraph的整体逻辑[2023.01.25 - v2.3.1 - Chunel]
[2023.02.10 - v2.3.2 - Chunel]
[2023.02.12 - v2.3.3 - yeshenyong, Chunel]
[2023.02.22 - v2.3.4 - Chunel]
param
机制和event
(事件)机制[2023.03.25 - v2.4.0 - woodx, Chunel]
pipeline
调度资源管控机制[2023.05.05 - v2.4.1 - Chunel]
pipeline
最大并发度获取方法。感谢 Hanano-Yuuki 提供相关解决方案pipeline
异步执行功能和执行时退出功能[2023.06.17 - v2.4.2 - Chunel]
MultiCondition
(多条件)功能pipeline
暂停执行和恢复执行功能[2023.07.12 - v2.4.3 - Chunel]
CStatus
功能,添加了异常定位信息[2023.09.05 - v2.5.0 - Chunel]
pipeline
的性能分析element
的超时机制some
(部分)功能,优化pipeline
的异步执行方式[2023.09.15 - v2.5.1 - Chunel]
fence
(栅栏)功能coordinator
(协调)功能[2023.11.06 - v2.5.2 - Chunel]
message
(消息)功能,可以设定写入阻塞时的处理方式,减少内存copy次数example
相关内容,针对不同行业,提供一些简单实现[2023.11.15 - v2.5.3 - Chunel]
proto
定义文件mutable
(异变)功能,提供依赖关系注册语法糖[2024.01.05 - v2.5.4 - Chunel]
test
内容,包含性能和功能方面的测试用例event
(事件)机制,支持异步等待功能[2024.07.18 - v2.6.0 - PaPaPig-Melody, Chunel]
pipeline
的拓扑执行的方式element
之间是否有依赖关系的方法[2024.09.07 - v2.6.1 - Chunel]
pipeline
的静态执行的方式,提供微任务机制event
(事件)机制,异步事件可以等待结束pipeline
剪裁功能,用于删除element
之间重复的依赖感谢 Doocs 微信公众号 刊登相关介绍文档,欢迎加入 Doocs 开源社区
感谢《HelloGithub》期刊介绍和推荐:HelloGithub 第70期
Taskflow Group
: awesome-parallel-computing, and we always treat taskflow as a role modelCGraph
项目提出的意见和建议的朋友,在此不一一提及。随时欢迎大家加入,一起共建