fabricatio 0.2.10.dev1__tar.gz → 0.2.11__tar.gz

{fabricatio-0.2.10.dev1 → fabricatio-0.2.11}/.gitignore

@@ -166,3 +166,4 @@ cython_debug/
 extra/scripts/*
 output/
 .vscode/
+templates/customed

{fabricatio-0.2.10.dev1 → fabricatio-0.2.11}/Cargo.lock

@@ -17,6 +17,15 @@ version = "2.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "512761e0bb2578dd7380c6baaa0f4ce03e84f95e960231d1dec8bf4d7d6e2627"
 
+[[package]]
+name = "aho-corasick"
+version = "1.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e60d3430d3a69478ad0993f19238d2df97c507009a52b3c10addcd7f6bcb916"
+dependencies = [
+ "memchr",
+]
+
 [[package]]
 name = "anstream"
 version = "0.6.18"
@@ -451,7 +460,9 @@ dependencies = [
  "pyo3",
  "pythonize",
  "rayon",
+ "regex",
  "serde_json",
+ "tex2typst-rs",
  "unicode-segmentation",
  "walkdir",
  "whichlang",
@@ -1198,6 +1209,48 @@ dependencies = [
  "sha2",
 ]
 
+[[package]]
+name = "phf"
+version = "0.11.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fd6780a80ae0c52cc120a26a1a42c1ae51b247a253e4e06113d23d2c2edd078"
+dependencies = [
+ "phf_macros",
+ "phf_shared",
+]
+
+[[package]]
+name = "phf_generator"
+version = "0.11.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3c80231409c20246a13fddb31776fb942c38553c51e871f8cbd687a4cfb5843d"
+dependencies = [
+ "phf_shared",
+ "rand",
+]
+
+[[package]]
+name = "phf_macros"
+version = "0.11.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f84ac04429c13a7ff43785d75ad27569f2951ce0ffd30a3321230db2fc727216"
+dependencies = [
+ "phf_generator",
+ "phf_shared",
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "phf_shared"
+version = "0.11.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "67eabc2ef2a60eb7faa00097bd1ffdb5bd28e62bf39990626a582201b7a754e5"
+dependencies = [
+ "siphasher",
+]
+
 [[package]]
 name = "pin-project-lite"
 version = "0.2.16"
@@ -1319,6 +1372,21 @@ version = "5.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "74765f6d916ee2faa39bc8e68e4f3ed8949b48cccdac59983d287a7cb71ce9c5"
 
+[[package]]
+name = "rand"
+version = "0.8.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "34af8d1a0e25924bc5b7c43c079c942339d8f0a8b57c39049bef581b46327404"
+dependencies = [
+ "rand_core",
+]
+
+[[package]]
+name = "rand_core"
+version = "0.6.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c"
+
 [[package]]
 name = "rayon"
 version = "1.10.0"
@@ -1359,6 +1427,35 @@ dependencies = [
  "thiserror",
 ]
 
+[[package]]
+name = "regex"
+version = "1.11.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b544ef1b4eac5dc2db33ea63606ae9ffcfac26c1416a2806ae0bf5f56b201191"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-automata",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-automata"
+version = "0.4.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "809e8dc61f6de73b46c85f4c96486310fe304c434cfa43669d7b40f711150908"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-syntax"
+version = "0.8.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2b15c43186be67a4fd63bee50d0303afffcef381492ebe2c5d87f324e1b8815c"
+
 [[package]]
 name = "reqwest"
 version = "0.12.15"
@@ -1590,6 +1687,12 @@ version = "1.3.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
 
+[[package]]
+name = "siphasher"
+version = "1.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "56199f7ddabf13fe5074ce809e7d3f42b42ae711800501b5b16ea82ad029c39d"
+
 [[package]]
 name = "slab"
 version = "0.4.9"
@@ -1737,6 +1840,16 @@ dependencies = [
  "windows-sys 0.59.0",
 ]
 
+[[package]]
+name = "tex2typst-rs"
+version = "0.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3b0b6b6ad0966ace50ba5e817e4f48d759857c015f5936d4976232df786d432d"
+dependencies = [
+ "phf",
+ "regex",
+]
+
 [[package]]
 name = "thiserror"
 version = "2.0.12"

{fabricatio-0.2.10.dev1 → fabricatio-0.2.11}/Cargo.toml

@@ -13,7 +13,9 @@ nucleo-matcher = "0.3.1"
 pyo3 = { version = "0.23.4", features = ["extension-module"] }
 pythonize = "0.23.0"
 rayon = "1.10.0"
+regex = "1.11.1"
 serde_json = "1.0.138"
+tex2typst-rs = "0.4.1"
 unicode-segmentation = "1.12.0"
 walkdir = "2.5.0"
 whichlang = "0.1.1"

{fabricatio-0.2.10.dev1 → fabricatio-0.2.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.2.10.dev1
+Version: 0.2.11
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3.12
@@ -14,23 +14,26 @@ Requires-Dist: asyncstdlib>=3.13.0
 Requires-Dist: json-repair>=0.39.1
 Requires-Dist: litellm>=1.60.0
 Requires-Dist: loguru>=0.7.3
-Requires-Dist: magika>=0.5.1
 Requires-Dist: more-itertools>=10.6.0
-Requires-Dist: orjson>=3.10.15
 Requires-Dist: pydantic>=2.10.6
 Requires-Dist: pydantic-settings>=2.7.1
 Requires-Dist: pymitter>=1.0.0
-Requires-Dist: questionary>=2.1.0
-Requires-Dist: regex>=2024.11.6
 Requires-Dist: rich>=13.9.4
+Requires-Dist: ujson>=5.10.0
+Requires-Dist: fabricatio[calc,ftd,plot,qa,rag,cli] ; extra == 'full'
 Requires-Dist: pymilvus>=2.5.4 ; extra == 'rag'
-Requires-Dist: fabricatio[calc,plot,rag] ; extra == 'full'
 Requires-Dist: sympy>=1.13.3 ; extra == 'calc'
 Requires-Dist: matplotlib>=3.10.1 ; extra == 'plot'
-Provides-Extra: rag
+Requires-Dist: questionary>=2.1.0 ; extra == 'qa'
+Requires-Dist: magika>=0.6.1 ; extra == 'ftd'
+Requires-Dist: typer-slim[standard]>=0.15.2 ; extra == 'cli'
 Provides-Extra: full
+Provides-Extra: rag
 Provides-Extra: calc
 Provides-Extra: plot
+Provides-Extra: qa
+Provides-Extra: ftd
+Provides-Extra: cli
 License-File: LICENSE
 Summary: A LLM multi-agent framework.
 Keywords: ai,agents,multi-agent,llm,pyo3
@@ -47,7 +50,8 @@ Project-URL: Issues, https://github.com/Whth/fabricatio/issues
 
 ## Overview
 
-Fabricatio is a streamlined Python library for building LLM applications using an event-based agent structure. It leverages Rust for performance-critical tasks, Handlebars for templating, and PyO3 for Python bindings.
+Fabricatio is a streamlined Python library for building LLM applications using an event-based agent structure. It
+leverages Rust for performance-critical tasks, Handlebars for templating, and PyO3 for Python bindings.
 
 ## Features
 
@@ -87,6 +91,7 @@ import asyncio
 from fabricatio import Action, Role, Task, logger, WorkFlow
 from typing import Any
 
+
 class Hello(Action):
     name: str = "hello"
     output_key: str = "task_output"
@@ -96,6 +101,7 @@ class Hello(Action):
         logger.info("executing talk action")
         return ret
 
+
 async def main() -> None:
     role = Role(
         name="talker",
@@ -107,6 +113,7 @@ async def main() -> None:
     result = await task.delegate()
     logger.success(f"Result: {result}")
 
+
 if __name__ == "__main__":
     asyncio.run(main())
 ```
@@ -114,6 +121,7 @@ if __name__ == "__main__":
 ### Examples
 
 For various usage scenarios, refer to the following examples:
+
 - Simple Chat
 - Retrieval-Augmented Generation (RAG)
 - Article Extraction
@@ -161,6 +169,7 @@ max_tokens = 8192
 ## Contributing
 
 Contributions are welcome! Follow these steps:
+
 1. Fork the repository.
 2. Create your feature branch (`git checkout -b feature/new-feature`).
 3. Commit your changes (`git commit -am 'Add new feature'`).
@@ -174,6 +183,8 @@ Fabricatio is licensed under the MIT License. See [LICENSE](LICENSE) for details
 ## Acknowledgments
 
 Special thanks to the contributors and maintainers of:
+
 - [PyO3](https://github.com/PyO3/pyo3)
 - [Maturin](https://github.com/PyO3/maturin)
 - [Handlebars.rs](https://github.com/sunng87/handlebars-rust)
+

{fabricatio-0.2.10.dev1 → fabricatio-0.2.11}/README.md

@@ -4,7 +4,8 @@
 
 ## Overview
 
-Fabricatio is a streamlined Python library for building LLM applications using an event-based agent structure. It leverages Rust for performance-critical tasks, Handlebars for templating, and PyO3 for Python bindings.
+Fabricatio is a streamlined Python library for building LLM applications using an event-based agent structure. It
+leverages Rust for performance-critical tasks, Handlebars for templating, and PyO3 for Python bindings.
 
 ## Features
 
@@ -44,6 +45,7 @@ import asyncio
 from fabricatio import Action, Role, Task, logger, WorkFlow
 from typing import Any
 
+
 class Hello(Action):
     name: str = "hello"
     output_key: str = "task_output"
@@ -53,6 +55,7 @@ class Hello(Action):
         logger.info("executing talk action")
         return ret
 
+
 async def main() -> None:
     role = Role(
         name="talker",
@@ -64,6 +67,7 @@ async def main() -> None:
     result = await task.delegate()
     logger.success(f"Result: {result}")
 
+
 if __name__ == "__main__":
     asyncio.run(main())
 ```
@@ -71,6 +75,7 @@ if __name__ == "__main__":
 ### Examples
 
 For various usage scenarios, refer to the following examples:
+
 - Simple Chat
 - Retrieval-Augmented Generation (RAG)
 - Article Extraction
@@ -118,6 +123,7 @@ max_tokens = 8192
 ## Contributing
 
 Contributions are welcome! Follow these steps:
+
 1. Fork the repository.
 2. Create your feature branch (`git checkout -b feature/new-feature`).
 3. Commit your changes (`git commit -am 'Add new feature'`).
@@ -131,6 +137,7 @@ Fabricatio is licensed under the MIT License. See [LICENSE](LICENSE) for details
 ## Acknowledgments
 
 Special thanks to the contributors and maintainers of:
+
 - [PyO3](https://github.com/PyO3/pyo3)
 - [Maturin](https://github.com/PyO3/maturin)
-- [Handlebars.rs](https://github.com/sunng87/handlebars-rust)
+- [Handlebars.rs](https://github.com/sunng87/handlebars-rust)

{fabricatio-0.2.10.dev1 → fabricatio-0.2.11}/examples/extract_and_inject/chunk_article.py

@@ -14,8 +14,6 @@ async def main() -> None:
     Role(
         name="Researcher",
         description="chunk the article",
-        llm_rpm=50,
-        llm_tpm=100000,
         registry={
             Event.quick_instantiate(e := "Chunk"): WorkFlow(
                 name="Chunk",
@@ -26,8 +24,9 @@ async def main() -> None:
             ).update_init_context(
                 article_path=gather_files("bare_md", "md"),
                 bib_manager=BibManager(path="ref.bib"),
-                max_chunk_size=500,
+                max_chunk_size=600,
                 max_overlapping_rate=0.3,
+                override_inject=True,
             ),
         },
     )

{fabricatio-0.2.10.dev1 → fabricatio-0.2.11}/examples/make_a_rating/rating.py

@@ -3,7 +3,7 @@
 import asyncio
 from typing import Dict, List, Set, Unpack
 
-import orjson
+import ujson
 from fabricatio import Action, JsonCapture, Role, WorkFlow, logger
 from fabricatio.capabilities.rating import Rating
 from fabricatio.models.events import Event
@@ -33,9 +33,9 @@ class WhatToRate(Action):
     async def _execute(self, task_input: Task, rate_topic: str, **cxt: Unpack) -> List[str]:
         def _validate(resp: str) -> List[str] | None:
             if (
-                (cap := JsonCapture.convert_with(resp, orjson.loads)) is not None
-                and isinstance(cap, list)
-                and all(isinstance(i, str) for i in cap)
+                    (cap := JsonCapture.convert_with(resp, ujson.loads)) is not None
+                    and isinstance(cap, list)
+                    and all(isinstance(i, str) for i in cap)
             ):
                 return cap
             return None

fabricatio-0.2.11/examples/propose_task/.gitignore

@@ -0,0 +1,2 @@
+task_output
+briefing.txt

fabricatio-0.2.11/examples/propose_task/propose.py

@@ -0,0 +1,49 @@
+"""Example of proposing a task to a role."""
+
+import asyncio
+from typing import Any
+
+from fabricatio import Action, Event, Role, Task, WorkFlow, logger
+from fabricatio.actions.output import PersistentAll
+from fabricatio.capabilities.propose import Propose
+from fabricatio.fs import safe_text_read
+from fabricatio.models.extra.article_outline import ArticleOutline
+from fabricatio.utils import ok
+
+
+class ProposeObj(Action, Propose):
+    """Action that says hello to the world."""
+
+    output_key: str = "task_output"
+
+    async def _execute(self, briefing: str, **_) -> Any:
+        return await self.propose(
+            ArticleOutline,
+            f"{briefing}\n\n\n\n\nAccording to the above plaintext article outline, "
+            f"I need you to create an `ArticleOutline` obj against it."
+            f"Note the heading shall not contain any heading numbers.",
+        )
+
+async def main() -> None:
+    """Main function."""
+    Role(
+        name="talker",
+        description="talker role",
+        llm_model="openai/qwq-plus",
+        llm_max_tokens=8190,
+        llm_stream=True,
+        llm_temperature=0.6,
+        registry={
+            Event.quick_instantiate("talk"): WorkFlow(
+                name="talk", steps=(ProposeObj, PersistentAll(persist_dir="persis"))
+            ).update_init_context(briefing=safe_text_read("briefing.txt"))
+        },
+    )
+
+    task: Task[ArticleOutline] = Task(name="write outline")
+    article_outline = ok(await task.delegate("talk"))
+    logger.success(f"article_outline:\n{article_outline.display()}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

fabricatio-0.2.11/examples/write_article/.gitignore

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

fabricatio-0.2.11/examples/write_article/post_process.py

@@ -0,0 +1,12 @@
+"""Fix the article."""
+
+from fabricatio.models.extra.article_main import Article
+
+a = Article.from_persistent(
+    r"persistent\to_dump\Article_20250408_103051_51d822.json")
+a.convert_tex()
+
+
+from fabricatio.fs.curd import dump_text
+
+dump_text("corrected.typ",a.finalized_dump())

fabricatio-0.2.11/examples/write_article/write_article.py

@@ -0,0 +1,189 @@
+"""Example of using the library."""
+
+import asyncio
+from pathlib import Path
+
+import typer
+from fabricatio import Event, Role, WorkFlow, logger
+from fabricatio.actions.article import ExtractOutlineFromRaw, GenerateArticleProposal, GenerateInitialOutline
+from fabricatio.actions.article_rag import ArticleConsultRAG, WriteArticleContentRAG
+from fabricatio.actions.output import DumpFinalizedOutput, PersistentAll
+from fabricatio.models.extra.article_outline import ArticleOutline
+from fabricatio.models.task import Task
+from fabricatio.utils import ok
+from typer import Typer
+
+Role(
+    name="Undergraduate Researcher",
+    description="Write an outline for an article in typst format.",
+    llm_model="openai/qwen-plus",
+    llm_temperature=0.6,
+    llm_max_tokens=8191,
+    llm_rpm=600,
+    llm_tpm=1000000,
+    registry={
+        Event.quick_instantiate(ns := "article"): WorkFlow(
+            name="Generate Article",
+            description="Generate an article. dump the outline to the given path. in typst format.",
+            steps=(
+                GenerateArticleProposal,
+                GenerateInitialOutline(output_key="article_outline"),
+                PersistentAll,
+                (
+                    a := WriteArticleContentRAG(
+                        output_key="to_dump",
+                        ref_limit=40,
+                        llm_model="openai/qwen-max",
+                        target_collection="article_chunks_700",
+                        extractor_model="openai/qwen-max",
+                        query_model="openai/deepseek-r1-250120",
+                    )
+                ),
+                DumpFinalizedOutput(output_key="task_output"),
+                PersistentAll,
+            ),
+        ),
+        Event.quick_instantiate(ns2 := "complete"): WorkFlow(
+            name="Generate Article",
+            description="Generate an article with given raw article outline. dump the outline to the given path. in typst format.",
+            steps=(
+                ExtractOutlineFromRaw(output_key="article_outline"),
+                PersistentAll,
+                a,
+                DumpFinalizedOutput(output_key="task_output"),
+                PersistentAll,
+            ),
+        ),
+        Event.quick_instantiate(ns3 := "finish"): WorkFlow(
+            name="Finish Article",
+            description="Finish an article with given article outline. dump the outline to the given path. in typst format.",
+            steps=(
+                a,
+                DumpFinalizedOutput(output_key="task_output"),
+                PersistentAll,
+            ),
+        ),
+        Event.quick_instantiate(ns4 := "consult"): WorkFlow(
+            name="Consult Article",
+            description="Consult an article with given article outline. dump the outline to the given path. in typst format.",
+            steps=(ArticleConsultRAG(ref_q_model="openai/qwen-max").to_task_output(),),
+        ),
+    },
+)
+
+
+app = Typer()
+
+
+@app.command()
+def consult(
+    collection_name: str = typer.Option("article_chunks", "-c", "--collection-name", help="Name of the collection."),
+) -> None:
+    """Consult an article based on a given article outline."""
+    _ = asyncio.run(
+        Task(name="Answer Question")
+        .update_init_context(
+            collection_name=collection_name,
+        )
+        .delegate(ns4)
+    )
+
+    logger.info("Finished")
+
+
+@app.command()
+def finish(
+    article_outline_path: Path = typer.Argument(  # noqa: B008
+        help="Path to the article outline raw file."
+    ),
+    dump_path: Path = typer.Option(Path("out.typ"), "-d", "--dump-path", help="Path to dump the final output."),  # noqa: B008
+    persist_dir: Path = typer.Option(  # noqa: B008
+        Path("persistent"), "-p", "--persist-dir", help="Directory to persist the output."
+    ),
+    collection_name: str = typer.Option("article_chunks", "-c", "--collection-name", help="Name of the collection."),
+    supervisor: bool = typer.Option(False, "-s", "--supervisor", help="Whether to use the supervisor mode."),
+) -> None:
+    """Finish an article based on a given article outline."""
+    path = ok(
+        asyncio.run(
+            Task(name="write an article")
+            .update_init_context(
+                article_outline=ArticleOutline.from_persistent(article_outline_path),
+                dump_path=dump_path,
+                persist_dir=persist_dir,
+                collection_name=collection_name,
+                supervisor=supervisor,
+            )
+            .delegate(ns3)
+        ),
+        "Failed to generate an article ",
+    )
+    logger.success(f"The outline is saved in:\n{path}")
+
+
+@app.command()
+def completion(
+    article_outline_raw_path: Path = typer.Option(  # noqa: B008
+        Path("article_outline_raw.txt"), "-a", "--article-outline-raw", help="Path to the article outline raw file."
+    ),
+    dump_path: Path = typer.Option(Path("out.typ"), "-d", "--dump-path", help="Path to dump the final output."),  # noqa: B008
+    persist_dir: Path = typer.Option(  # noqa: B008
+        Path("persistent"), "-p", "--persist-dir", help="Directory to persist the output."
+    ),
+    collection_name: str = typer.Option("article_chunks", "-c", "--collection-name", help="Name of the collection."),
+    supervisor: bool = typer.Option(False, "-s", "--supervisor", help="Whether to use the supervisor mode."),
+) -> None:
+    """Write an article based on a raw article outline."""
+    path = ok(
+        asyncio.run(
+            Task(name="write an article")
+            .update_init_context(
+                article_outline_raw_path=article_outline_raw_path,
+                dump_path=dump_path,
+                persist_dir=persist_dir,
+                collection_name=collection_name,
+                supervisor=supervisor,
+            )
+            .delegate(ns2)
+        ),
+        "Failed to generate an article ",
+    )
+    logger.success(f"The outline is saved in:\n{path}")
+
+
+@app.command()
+def write(
+    article_briefing: Path = typer.Option(  # noqa: B008
+        Path("article_briefing.txt"), "-a", "--article-briefing", help="Path to the article briefing file."
+    ),
+    dump_path: Path = typer.Option(Path("out.typ"), "-d", "--dump-path", help="Path to dump the final output."),  # noqa: B008
+    persist_dir: Path = typer.Option(  # noqa: B008
+        Path("persistent"), "-p", "--persist-dir", help="Directory to persist the output."
+    ),
+    collection_name: str = typer.Option("article_chunks", "-c", "--collection-name", help="Name of the collection."),
+    supervisor: bool = typer.Option(False, "-s", "--supervisor", help="Whether to use the supervisor mode."),
+) -> None:
+    """Write an article based on a briefing.
+
+    This function generates an article outline and content based on the provided briefing.
+    The outline and content are then dumped to the specified path and persisted in the given directory.
+    """
+    path = ok(
+        asyncio.run(
+            Task(name="write an article")
+            .update_init_context(
+                article_briefing=article_briefing.read_text(),
+                dump_path=dump_path,
+                persist_dir=persist_dir,
+                collection_name=collection_name,
+                supervisor=supervisor,
+            )
+            .delegate(ns)
+        ),
+        "Failed to generate an article ",
+    )
+    logger.success(f"The outline is saved in:\n{path}")
+
+
+if __name__ == "__main__":
+    app()