fabricatio 0.2.8.dev4__tar.gz → 0.2.9__tar.gz

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9}/Cargo.lock

@@ -452,7 +452,9 @@ dependencies = [
  "pythonize",
  "rayon",
  "serde_json",
+ "unicode-segmentation",
  "walkdir",
+ "whichlang",
 ]
 
 [[package]]
@@ -2099,6 +2101,12 @@ dependencies = [
  "wasm-bindgen",
 ]
 
+[[package]]
+name = "whichlang"
+version = "0.1.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0b9aa3ad29c3d08283ac6b769e3ec15ad1ddb88af7d2e9bc402c574973b937e7"
+
 [[package]]
 name = "winapi-util"
 version = "0.1.9"

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9}/Cargo.toml

@@ -14,7 +14,9 @@ pyo3 = { version = "0.23.4", features = ["extension-module"] }
 pythonize = "0.23.0"
 rayon = "1.10.0"
 serde_json = "1.0.138"
+unicode-segmentation = "1.12.0"
 walkdir = "2.5.0"
+whichlang = "0.1.1"
 
 [workspace]
 

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.2.8.dev4
+Version: 0.2.9
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3.12

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9}/examples/make_a_rating/rating.py

@@ -5,11 +5,12 @@ from typing import Dict, List, Set, Unpack
 
 import orjson
 from fabricatio import Action, JsonCapture, Role, WorkFlow, logger
+from fabricatio.capabilities.rating import Rating
 from fabricatio.models.events import Event
 from fabricatio.models.task import Task
 
 
-class Rate(Action):
+class Rate(Action, Rating):
     """Rate the task."""
 
     output_key: str = "task_output"
@@ -49,7 +50,7 @@ class WhatToRate(Action):
         )
 
 
-class MakeCriteria(Action):
+class MakeCriteria(Action, Rating):
     """Make criteria for rating."""
 
     output_key: str = "criteria"
@@ -60,7 +61,7 @@ class MakeCriteria(Action):
         return set(criteria)
 
 
-class MakeCompositeScore(Action):
+class MakeCompositeScore(Action, Rating):
     """Make a composite score."""
 
     output_key: str = "task_output"
@@ -72,6 +73,15 @@ class MakeCompositeScore(Action):
         )
 
 
+class Best(Action, Rating):
+    """Select the best."""
+
+    output_key: str = "task_output"
+
+    async def _execute(self, rate_topic: str, to_rate: List[str], **cxt: Unpack) -> str:
+        return (await self.best(to_rate, topic=rate_topic)).pop(0)
+
+
 async def main() -> None:
     """Main function."""
     role = Role(
@@ -100,23 +110,32 @@ async def main() -> None:
                     "rate_topic": "if the food is 'good'",
                 },
             ),
+            Event.quick_instantiate("best"): WorkFlow(
+                name="choose the best",
+                steps=(WhatToRate, Best),
+                extra_init_context={"rate_topic": "if the food is 'good'"},
+            ),
         },
     )
     task = await role.propose_task(
         "rate these food, so that i can decide what to eat today. choco cake, strawberry icecream, giga burger, cup of coffee, rotten bread from the trash bin, and a salty of fruit salad",
     )
-    rating = await task.move_to("rate_food").delegate()
+    rating = await task.delegate("rate_food")
 
     logger.success(f"Result: \n{rating}")
 
-    generated_criteria = await task.move_to("make_criteria_for_food").delegate()
+    generated_criteria = await task.delegate("make_criteria_for_food")
 
     logger.success(f"Generated Criteria: \n{generated_criteria}")
 
-    composite_score = await task.move_to("make_composite_score").delegate()
+    composite_score = await task.delegate("make_composite_score")
 
     logger.success(f"Composite Score: \n{composite_score}")
 
+    best = await task.delegate("best")
+
+    logger.success(f"Best: \n{best}")
+
 
 if __name__ == "__main__":
     asyncio.run(main())

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9}/examples/make_diary/diary.py

@@ -4,7 +4,7 @@ import asyncio
 from datetime import datetime
 from typing import Optional, Set, Unpack
 
-from fabricatio import Action, Event, Role, Task, WorkFlow, fs_toolbox, logger
+from fabricatio import Action, Event, Role, Task, WorkFlow, logger, toolboxes
 from fabricatio.fs.readers import safe_json_read
 from fabricatio.models.tool import ToolBox
 from pydantic import Field
@@ -48,7 +48,7 @@ class WriteDiary(Action):
 class DumpText(Action):
     """Dump the text to a file."""
 
-    toolboxes: Set[ToolBox] = Field(default_factory=lambda: {fs_toolbox})
+    toolboxes: Set[ToolBox] = Field(default_factory=lambda: {toolboxes.fs_toolbox})
     output_key: str = "task_output"
 
     async def _execute(self, task_input: Task, dump_text: str, **_: Unpack) -> Optional[str]:

fabricatio-0.2.9/examples/reviewer/censor.py

@@ -0,0 +1,32 @@
+"""Example of review usage."""
+
+import asyncio
+
+from fabricatio import Role, logger
+from fabricatio.capabilities.censor import Censor
+
+
+class Coder(Role, Censor):
+    """Reviewer role."""
+
+
+async def main() -> None:
+    """Main function."""
+    role = Coder(
+        name="Bob",
+        description="A role that reviews the code.",
+    )
+
+    code = await role.aask(
+        "write a cli app using rust with clap which can generate a basic manifest of a standard rust project, output code only,no extra explanation"
+    )
+
+    ruleset = await role.draft_ruleset("should not use clap to write cli.", rule_count=1)
+    logger.success(f"Code: \n{code}")
+    code = await role.censor_string(code, ruleset)
+
+    logger.success(f"Code: \n{code}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9}/examples/reviewer/review.py

@@ -3,11 +3,15 @@
 import asyncio
 
 from fabricatio import Role, logger
+from fabricatio.capabilities.review import Review
 
 
+class Reviewer(Role, Review):
+    """Reviewer role."""
+
 async def main() -> None:
     """Main function."""
-    role = Role(
+    role = Reviewer(
         name="Reviewer",
         description="A role that reviews the code.",
     )

fabricatio-0.2.9/examples/rules/draft_ruleset.py

@@ -0,0 +1,59 @@
+"""Example of using the library."""
+
+import asyncio
+from typing import TYPE_CHECKING
+
+from fabricatio import Event, Role, WorkFlow, logger
+from fabricatio.actions.output import PersistentAll
+from fabricatio.actions.rules import DraftRuleSet
+from fabricatio.models.task import Task
+from fabricatio.utils import ok
+
+if TYPE_CHECKING:
+    from fabricatio.models.extra.rule import RuleSet
+
+
+async def main() -> None:
+    """Main function."""
+    Role(
+        name="Undergraduate Researcher",
+        llm_model="openai/qwen-plus",
+        llm_rpm=1000,
+        llm_tpm=3000000,
+        llm_max_tokens=8190,
+        registry={
+            Event.quick_instantiate(ns := "article"): WorkFlow(
+                name="write ruleset",
+                description="Generate a draft ruleset for article.",
+                steps=(
+                    DraftRuleSet(
+                        ruleset_requirement="1.when try to use an article as reference cited in our article, you should obey the format like `(author1, author2 et al., YYYY)#cite(<bibtex_cite_key>)`\n"
+                        "2.we use typst to generate numeric citation. For example, for an article whose `bibtex_key` is `YanWindEnergy2018`, you can create a numeric citation by typing `#cite(<YanWindEnergy2018>)`(note that `bibtex_key` with `<` and `>` wrapped is needed), those notations could automatically be processed and output by compiler as a numeric citation like `[1]` in the upper right corner of text.\n"
+                        "3.in addition, since `#cite()` can ONLY cite ONE article at once, we need use multiple `#cite()` notations to cite multiple articles, for example, there are three articles whose `bibtex_key` are `YanWindEnergy2018`, `YanWindEnergy2019`, `YanWindEnergy2020, you can cite them three as numeric citation by typing `#cite(<YanWindEnergy2018>)#cite(<YanWindEnergy2019>)#cite(<YanWindEnergy2020>)` those notations could automatically be processed and output by compiler as a numeric citation like `[1,2,3]` in the upper right corner of text.\n"
+                        "4.to cover more references, we usually cite more than one articles that have similar opinions in a single sentence if possible.\n"
+                        "5.when using `#cite()` notation, you must be aware of the cite key should be wrapped by `<` and `>`, compiler wont let it pass compilation otherwise.",
+                        rule_count=5,
+                        output_key="en_ruleset"
+                    ),
+                    DraftRuleSet(
+                        ruleset_requirement="1. 当在文章中引用其他文章作为参考文献时, 应遵循`(作者1, 作者2等, 年份)#cite(<bibtex_cite_key>)`的格式进行标注。\n"
+                        "2. 我们使用Typst生成数字引用格式。例如, 对于BibTeX键为`YanWindEnergy2018`的文献, 可通过输入`#cite(<YanWindEnergy2018>)`创建数字引用(注意:BibTeX键必须用尖括号`<`和`>`包裹)。这些标记会被编译器自动处理并输出为右上角的数字引用格式, 例如文本旁的[1]。\n"
+                        "3. 此外, 由于`#cite()`每次只能引用单一文献, 需通过叠加多个`#cite()`标记实现多文献引用。例如, 若需引用三个BibTeX键分别为`YanWindEnergy2018`、`YanWindEnergy2019`和`YanWindEnergy2020`的文献, 应输入`#cite(<YanWindEnergy2018>)#cite(<YanWindEnergy2019>)#cite(<YanWindEnergy2020>)`, 编译后将呈现为[1,2,3]的右上角数字引用格式。\n"
+                        "4. 为增加参考文献的覆盖率, 我们通常建议在可能的情况下, 将多个观点相似的文献合并引用于同一句子中。"
+                        "5. 使用`#cite()`时需注意:BibTeX键必须用尖括号`<`和`>`包裹, 否则编译器将拒绝通过编译。",
+                        rule_count=5,
+                        output_key="zh_ruleset"
+                    ),
+                    PersistentAll(persist_dir="persistent"),
+                ),
+            )
+        },
+    )
+
+    proposed_task: Task[RuleSet] = Task(name="write an ruleset")
+    ruleset = ok(await proposed_task.delegate(ns), "Failed to generate ruleset")
+    logger.success(f"The rule is: \n{ruleset.display()}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9}/examples/task_handle/handle_task.py

@@ -3,7 +3,7 @@
 import asyncio
 from typing import Any, Set, Unpack
 
-from fabricatio import Action, Event, PythonCapture, Role, Task, ToolBox, WorkFlow, fs_toolbox, logger
+from fabricatio import Action, Event, PythonCapture, Role, Task, ToolBox, WorkFlow, logger, toolboxes
 from pydantic import Field
 
 
@@ -23,7 +23,7 @@ class WriteCode(Action):
 class DumpText(Action):
     """Dump the text to a file."""
 
-    toolboxes: Set[ToolBox] = Field(default_factory=lambda: {fs_toolbox})
+    toolboxes: Set[ToolBox] = Field(default_factory=lambda: {toolboxes.fs_toolbox})
     output_key: str = "task_output"
 
     async def _execute(self, task_input: Task, dump_text: str, **_: Unpack) -> Any:

fabricatio-0.2.9/examples/write_article/.gitignore

@@ -0,0 +1,3 @@
+article_briefing.txt
+out.typ
+persistent*

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9}/examples/write_article/write_article.py

@@ -50,7 +50,7 @@ async def main() -> None:
                 article_briefing=Path("./article_briefing.txt").read_text(),
                 dump_path="out.typ",
                 persist_dir="persistent",
-                collection_name="article_essence"
+                collection_name="article_essence_0324"
             )
         },
     )

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9}/examples/write_outline/write_outline.py

@@ -2,7 +2,8 @@
 
 import asyncio
 
-from fabricatio import Event, Role, WriteOutlineWorkFlow, logger
+from fabricatio import Event, Role, logger
+from fabricatio.workflows.articles import WriteOutlineCorrectedWorkFlow
 
 
 async def main() -> None:
@@ -10,7 +11,7 @@ async def main() -> None:
     role = Role(
         name="Undergraduate Researcher",
         description="Write an outline for an article in typst format.",
-        registry={Event.quick_instantiate(ns := "article"): WriteOutlineWorkFlow},
+        registry={Event.quick_instantiate(ns := "article"): WriteOutlineCorrectedWorkFlow},
     )
 
     proposed_task = await role.propose_task(

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9}/examples/write_outline/write_outline_corrected.py

@@ -3,7 +3,7 @@
 import asyncio
 
 from fabricatio import Event, Role, WorkFlow, logger
-from fabricatio.actions.article import CorrectOutline, CorrectProposal, GenerateArticleProposal, GenerateOutline
+from fabricatio.actions.article import GenerateArticleProposal, GenerateInitialOutline
 from fabricatio.actions.output import DumpFinalizedOutput
 
 
@@ -20,13 +20,7 @@ async def main() -> None:
                 description="Generate an outline for an article. dump the outline to the given path. in typst format.",
                 steps=(
                     GenerateArticleProposal(llm_model="deepseek/deepseek-reasoner", llm_temperature=1.3),
-                    CorrectProposal(
-                        output_key="article_proposal",
-                        llm_model="deepseek/deepseek-reasoner",
-                        llm_temperature=1.3,
-                    ),
-                    GenerateOutline(llm_model="deepseek/deepseek-chat", llm_temperature=1.4, llm_top_p=0.5),
-                    CorrectOutline(output_key="to_dump", llm_temperature=1.4, llm_top_p=0.45),
+                    GenerateInitialOutline(llm_model="deepseek/deepseek-chat", llm_temperature=1.4, llm_top_p=0.5),
                     DumpFinalizedOutput(output_key="task_output"),
                 ),
             )

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fabricatio"
-version = "0.2.8-dev4"
+version = "0.2.9"
 description = "A LLM multi-agent framework."
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -57,7 +57,7 @@ build-backend = "maturin"
 
 [tool.maturin]
 python-source = "python"
-module-name = "fabricatio._rust"
+module-name = "fabricatio.rust"
 data = "extra"
 [dependency-groups]
 dev = [

{fabricatio-0.2.8.dev4 → fabricatio-0.2.9}/python/fabricatio/__init__.py

@@ -1,10 +1,6 @@
 """Fabricatio is a Python library for building llm app using event-based agent structure."""
 
-from importlib.util import find_spec
-
-from fabricatio import actions, toolboxes, workflows
-from fabricatio._rust import BibManager
-from fabricatio._rust_instances import TEMPLATE_MANAGER
+from fabricatio import actions, capabilities, toolboxes, workflows
 from fabricatio.core import env
 from fabricatio.journal import logger
 from fabricatio.models import extra
@@ -14,6 +10,8 @@ from fabricatio.models.role import Role
 from fabricatio.models.task import Task
 from fabricatio.models.tool import ToolBox
 from fabricatio.parser import Capture, GenericCapture, JsonCapture, PythonCapture
+from fabricatio.rust import BibManager
+from fabricatio.rust_instances import TEMPLATE_MANAGER
 
 __all__ = [
     "TEMPLATE_MANAGER",
@@ -29,15 +27,10 @@ __all__ = [
     "ToolBox",
     "WorkFlow",
     "actions",
+    "capabilities",
     "env",
     "extra",
     "logger",
     "toolboxes",
     "workflows",
 ]
-
-
-if find_spec("pymilvus"):
-    from fabricatio.capabilities.rag import RAG
-
-    __all__ += ["RAG"]

fabricatio-0.2.9/python/fabricatio/actions/__init__.py

@@ -0,0 +1 @@
+"""A module containing some builtin actins."""