sigmaflow 0.0.1__tar.gz

sigmaflow-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sigmaflow-0.0.1/PKG-INFO

@@ -0,0 +1,276 @@
+Metadata-Version: 2.4
+Name: sigmaflow
+Version: 0.0.1
+Summary: SigmaFlow is a Python package designed to optimize the performance of task-flow related to LLMs or MLLMs
+Home-page: https://github.com/maokangkun/SigmaFlow
+Author: maokangkun
+Author-email: maokangkun@pjlab.prg.cn
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+Dynamic: summary
+
+<div align="center">
+  <img src="./assets/banner.png" alt="banner" />
+
+  <a href="https://sigmaflow.gitbook.io/sigmaflow-docs"><img src="https://img.shields.io/static/v1?message=Docs&logo=gitbook&logoColor=ffffff&label=%20&labelColor=5c5c5c&color=3F89A1"></a>
+  <a href="#"><img src="https://img.shields.io/badge/Open_Source-❤️-FDA599?"/></a>
+  <img src="https://komarev.com/ghpvc/?username=maokangkun&label=Views&color=0e75b6&style=flat" alt="访问量统计" />
+  [![license](https://img.shields.io/github/license/maokangkun/SigmaFlow.svg)](https://github.com/maokangkun/SigmaFlow/tree/main/LICENSE)
+  [![issue resolution](https://img.shields.io/github/issues-closed-raw/maokangkun/SigmaFlow)](https://github.com/maokangkun/SigmaFlow/issues)
+  [![open issues](https://img.shields.io/github/issues-raw/maokangkun/SigmaFlow)](https://github.com/maokangkun/SigmaFlow/issues)
+
+  <p align="center">
+    👋 join us on <a href="https://linluhe.github.io/group_qrcode.html" target="_blank">WeChat</a>
+  </p>
+</div>
+
+# SigmaFlow
+SigmaFlow is a Python package designed to optimize the performance of task-flow related to LLMs or MLLMs.
+![comfyUI demo](./assets/comfyUI.png)
+
+```mermaid
+graph LR
+    %% ========================
+    %% Nodes definition section
+    %% ========================
+    计算BMI[/"计算BMI"/]
+    是否确诊{"是否确诊"}
+    推断最有可能疾病["推断最有可能疾病"]
+    身高(["身高"])
+    年龄(["年龄"])
+    提取症状["提取症状"]
+    患者信息(["患者信息"])
+    疾病列表(["疾病列表"])
+    获取出生日期["获取出生日期"]
+    治疗建议(["治疗建议"])
+    计算年龄[/"计算年龄"/]
+    体重(["体重"])
+    诊断["诊断"]
+    治疗推荐["治疗推荐"]
+    获取身高体重["获取身高体重"]
+    出生日期(["出生日期"])
+    exit[["exit"]]
+    症状(["症状"])
+    疾病(["疾病"])
+    BMI(["BMI"])
+    搜索疾病列表("搜索疾病列表")
+
+    %% ========================
+    %% Links definition section
+    %% ========================
+    症状 --> 每个症状
+    出生日期 ==> 计算年龄 ==> 年龄
+    治疗建议 ==o|total: 6.26s| exit
+    患者信息 ==> 提取症状 ==>|1.02s| 症状
+    患者信息 ==> 获取出生日期 ==>|1.05s| 出生日期
+    症状 ==> 搜索疾病列表 ==>|1.02s| 疾病列表
+    患者信息 ==> 诊断 ==>|1.01s| 疾病
+    身高 & 体重 ==> 计算BMI ==> BMI
+    患者信息 ==> 获取身高体重 ==>|1.06s| 身高 & 体重
+    疾病 ==>|1.02s| 是否确诊
+    患者信息 & 疾病列表 ==> 推断最有可能疾病 ==>|1.02s| 疾病
+    是否确诊 ==>|无法确定| 提取症状 & 获取出生日期 & 获取身高体重
+    患者信息 & 疾病 & 年龄 & BMI ==> 治疗推荐 ==>|1.02s| 治疗建议
+
+    %% ================
+    %% Subgraph section
+    %% ================
+    subgraph 每个症状
+        搜索疾病列表
+    end
+
+    %% ========================
+    %% Style definition section
+    %% ========================
+    classDef LLMNODE fill:#ECE4E2,color:black
+    class 获取出生日期,诊断,治疗推荐,提取症状,获取身高体重,推断最有可能疾病 LLMNODE
+    classDef DATA fill:#9BCFB8,color:black
+    class 疾病,症状,出生日期,BMI,体重,年龄,治疗建议,患者信息,身高,疾病列表 DATA
+    classDef BRANCHNODE fill:#445760,color:white
+    class 是否确诊 BRANCHNODE
+    classDef CODENODE fill:#FFFFAD,color:black
+    class 计算BMI,计算年龄 CODENODE
+    classDef LOOPNODE fill:none,stroke:#CC8A4D,stroke-dasharray:5 5,stroke-width:2px
+    class 每个症状 LOOPNODE
+    classDef RAGNODE fill:#FE929F,color:black
+    class 搜索疾病列表 RAGNODE
+    classDef EXITNODE fill:#3D3E3F,color:white
+    class exit EXITNODE
+    classDef INPUTDATA fill:#D64747,color:black
+    class 患者信息 INPUTDATA
+    linkStyle 0 fill:none,stroke:#CC8A4D,stroke-dasharray:5 5,stroke-width:2px
+```
+
+```mermaid
+gantt
+title Task Timeline
+dateFormat  x
+axisFormat  %M:%S.%L
+section pid_00
+诊断: 0, 1023ms
+获取身高体重: 2046, 1035ms
+每个症状: 3083, 12ms
+搜索疾病列表: 3095, 1024ms
+搜索疾病列表: 4119, 1023ms
+section pid_01
+获取出生日期: 2045, 1029ms
+计算BMI: 3076, 11ms
+治疗推荐: 3088, 1027ms
+搜索疾病列表: 4115, 1025ms
+推断最有可能疾病: 5141, 1025ms
+section pid_02
+提取症状: 2045, 1043ms
+搜索疾病列表: 3089, 1022ms
+搜索疾病列表: 4112, 1021ms
+section pid_03
+是否确诊: 1020, 1035ms
+计算年龄: 3071, 25ms
+搜索疾病列表: 3096, 1022ms
+搜索疾病列表: 4118, 1023ms
+```
+
+## Introduction
+SigmaFlow is a Python package designed to optimize the performance of task-flow related to Large Language Models (LLMs) or Multimodal Large Language Models (MLLMs). It ensures efficient parallel execution of task-flow while maintaining dependency constraints, significantly enhancing the overall performance.
+
+SigmaFlow 是一个 Python 包，旨在优化与大模型 (LLMs or MLLMs) 相关任务流的性能。在满足依赖关系的前提下，确保任务流的高效并行执行，从而显著提高整体性能。
+
+## Features
+- Dependency Management: Handles task dependencies efficiently, ensuring correct execution order.
+
+  依赖管理：高效处理任务依赖关系，确保正确的执行顺序。
+- Parallel Execution: Maximizes parallelism to improve performance.
+
+  并行执行：最大化并行性以提高性能。
+- Loop Handling: Supports tasks with loop structures.
+
+  循环处理：支持带有循环结构的任务。
+- Easy Integration: Simple and intuitive API for easy integration with existing projects.
+
+  易于集成：简单直观的 API，便于与现有项目集成。
+
+## Installation
+You can install SigmaFlow via pip:
+
+你可以通过 pip 安装 SigmaFlow：
+```bash
+pip install SigmaFlow
+```
+
+## Usage
+Here is a basic example to get you started:
+
+下面是一个基本示例，帮助你快速入门：
+
+<details>
+<summary>Example Code</summary>
+
+```python
+from SigmaFlow import SigmaFlow, Prompt
+
+# set custom prompt
+example_prompt = Prompt("""
+...
+{inp1}
+xxx
+""", keys=['{inp1}'])
+
+# set api
+def llm_api(inp):
+    ...
+    return out
+
+def rag_api(inp):
+    ...
+    return out
+
+# set input data
+data = {
+    'inp': 'test input text ...',
+}
+
+# set pipeline
+demo_pipe = {
+    'process_input': {
+        'prompt': example_prompt,
+        'format': {'out1': list, 'out2': str}, # check return json format
+        'inp': ['inp'],
+        'out': ['out1', 'out2'],
+        'next': ['rag1', 'loop_A'], # specify the next pipeline
+    },
+    'rag1': {
+        'rag_backend': rag_api2, # specific api can be set for the current pipe via 'rag_backend' or 'llm_backend'.
+        'inp': ['out2'],
+        'out': 'out8',
+    },
+    'loop_A': { # here is iterating over a list 'out1'
+        'inp': 'out1',
+        'pipe_in_loop': ['rag2', 'llm_process', 'rag3', 'rag4', 'llm_process2', 'llm_process3'],
+        'next': ['exit'], # 'exit' is specific pipe mean to end
+    },
+    'rag2': {
+        'inp': ['out1'],
+        'out': 'out3',
+    },
+    'llm_process2': {
+        'prompt': llm_process2_prompt,
+        'format': {'xxx': str, "xxx": str},
+        'inp': ['inp', 'out4', 'out8'],
+        'out': 'final_out1',
+    },
+    ...
+}
+
+# running pipeline
+pipeline = SigmaFlow(demo_pipe, llm_api, rag_api)
+result, info = pipeline.run(data, core_num=4, save_pref=True)
+```
+</details>
+
+Logs are stored in the `logs` folder. If `save_pref` is `true`, you can see the relevant performance report.
+
+日志存储在`logs`文件夹下，如果`save_pref`为`true`，你可以看到相关的性能报告。
+
+For a complete example, please refer to the [example](./example/) directory.
+
+完整示例请参考example目录。
+
+## Documentation
+For detailed documentation, please visit our official documentation page.
+
+有关详细文档，请访问我们的官方文档页面。
+
+## Contributing
+We welcome contributions from the community. Please read our contributing guide to get started.
+
+我们欢迎来自社区的贡献。请阅读我们的贡献指南开始。
+
+## License
+SigmaFlow is licensed under the Apache License Version 2.0. See the [LICENSE](./LICENSE) file for more details.
+
+SigmaFlow 采用 Apache License Version 2.0 许可证。有关详细信息，请参阅[许可证](./LICENSE)文件。
+
+## Acknowledgements
+Special thanks to all contributors and the open-source community for their support.
+
+特别感谢所有贡献者和开源社区的支持。
+
+## Contact
+For any questions or issues, please open an issue on our [GitHub repository](https://github.com/maokangkun/SigmaFlow).
+
+如有任何问题或意见，请在我们的[GitHub 仓库](https://github.com/maokangkun/SigmaFlow)提交 issue。
+
+<div align="center">
+  <a href="https://star-history.com/#maokangkun/SigmaFlow&Date"><img src="https://api.star-history.com/svg?repos=maokangkun/SigmaFlow&type=Date" alt="Star History Chart" /></a>
+</div>