fabricatio 0.2.11.dev2__tar.gz → 0.2.12__tar.gz

{fabricatio-0.2.11.dev2 → fabricatio-0.2.12}/.gitignore

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

{fabricatio-0.2.11.dev2 → fabricatio-0.2.12}/Cargo.lock

@@ -76,6 +76,12 @@ dependencies = [
  "windows-sys 0.59.0",
 ]
 
+[[package]]
+name = "anyhow"
+version = "1.0.98"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e16d2d3311acee920a9eb8d33b8cbc1787ce4a264e85f964c2404b969bdcd487"
+
 [[package]]
 name = "arrayref"
 version = "0.3.9"
@@ -462,6 +468,7 @@ dependencies = [
  "rayon",
  "regex",
  "serde_json",
+ "serde_yml",
  "tex2typst-rs",
  "unicode-segmentation",
  "walkdir",
@@ -980,6 +987,16 @@ dependencies = [
  "redox_syscall",
 ]
 
+[[package]]
+name = "libyml"
+version = "0.0.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3302702afa434ffa30847a83305f0a69d6abd74293b6554c18ec85c7ef30c980"
+dependencies = [
+ "anyhow",
+ "version_check",
+]
+
 [[package]]
 name = "linux-raw-sys"
 version = "0.9.3"
@@ -1670,6 +1687,21 @@ dependencies = [
  "serde",
 ]
 
+[[package]]
+name = "serde_yml"
+version = "0.0.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "59e2dd588bf1597a252c3b920e0143eb99b0f76e4e082f4c92ce34fbc9e71ddd"
+dependencies = [
+ "indexmap",
+ "itoa",
+ "libyml",
+ "memchr",
+ "ryu",
+ "serde",
+ "version_check",
+]
+
 [[package]]
 name = "sha2"
 version = "0.10.8"

{fabricatio-0.2.11.dev2 → fabricatio-0.2.12}/Cargo.toml

@@ -15,6 +15,7 @@ pythonize = "0.23.0"
 rayon = "1.10.0"
 regex = "1.11.1"
 serde_json = "1.0.138"
+serde_yml = "0.0.12"
 tex2typst-rs = "0.4.1"
 unicode-segmentation = "1.12.0"
 walkdir = "2.5.0"

{fabricatio-0.2.11.dev2 → fabricatio-0.2.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.2.11.dev2
+Version: 0.2.12
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3.12
@@ -20,18 +20,20 @@ Requires-Dist: pydantic-settings>=2.7.1
 Requires-Dist: pymitter>=1.0.0
 Requires-Dist: rich>=13.9.4
 Requires-Dist: ujson>=5.10.0
-Requires-Dist: fabricatio[calc,ftd,plot,qa,rag] ; extra == 'full'
+Requires-Dist: fabricatio[calc,ftd,plot,qa,rag,cli] ; extra == 'full'
 Requires-Dist: pymilvus>=2.5.4 ; extra == 'rag'
 Requires-Dist: sympy>=1.13.3 ; extra == 'calc'
 Requires-Dist: matplotlib>=3.10.1 ; extra == 'plot'
 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

fabricatio-0.2.12/examples/write_article/.gitignore

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

fabricatio-0.2.12/examples/write_article/write_article.py

@@ -0,0 +1,197 @@
+"""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, RenderedDump
+from fabricatio.models.extra.article_outline import ArticleOutline
+from fabricatio.models.task import Task
+from fabricatio.utils import ok
+from typer import Typer
+
+# from pydantic import HttpUrl
+
+Role(
+    name="Undergraduate Researcher",
+    description="Write an outline for an article in typst format.",
+    llm_model="openai/deepseek-v3-250324",
+    llm_temperature=0.45,
+    # llm_api_endpoint=HttpUrl("https://dashscope.aliyuncs.com/compatible-mode/v1"),
+    llm_top_p=0.95,
+    llm_max_tokens=8191,
+    llm_rpm=600,
+    llm_tpm=900000,
+    llm_timeout=600,
+    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=18,
+                        threshold=0.58,
+                        result_per_query=2,
+                        extractor_model={"model": "openai/qwen-max"},
+                        query_model={"model": "openai/qwen-turbo", "temperature": 0.3, "top_p": 0.85},
+                    )
+                ),
+                PersistentAll,
+                DumpFinalizedOutput(dump_path="median.typ"),
+                RenderedDump(template_name="article").to_task_output(),
+            ),
+        ),
+        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,
+                PersistentAll,
+                DumpFinalizedOutput(dump_path="median.typ"),
+                RenderedDump(template_name="article").to_task_output(),
+            ),
+        ),
+        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,
+                PersistentAll,
+                DumpFinalizedOutput(dump_path="median.typ"),
+                RenderedDump(template_name="article").to_task_output(),
+            ),
+        ),
+        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={"model":"openai/qwen-turbo"}).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()

{fabricatio-0.2.11.dev2 → fabricatio-0.2.12}/examples/write_outline/write_outline.py

@@ -3,6 +3,8 @@
 import asyncio
 
 from fabricatio import Event, Role, logger
+from fabricatio.models.task import Task
+from fabricatio.utils import ok
 from fabricatio.workflows.articles import WriteOutlineCorrectedWorkFlow
 
 
@@ -14,10 +16,11 @@ async def main() -> None:
         registry={Event.quick_instantiate(ns := "article"): WriteOutlineCorrectedWorkFlow},
     )
 
-    proposed_task = await role.propose_task(
+    proposed_task = await role.propose(
+        Task,
         "You need to read the `./article_briefing.txt` file and write an outline for the article in typst format. The outline should be saved in the `./out.typ` file.",
     )
-    path = await proposed_task.delegate(ns)
+    path = await ok(proposed_task).delegate(ns)
     logger.success(f"The outline is saved in:\n{path}")
 
 

{fabricatio-0.2.11.dev2 → fabricatio-0.2.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fabricatio"
-version = "0.2.11-dev2"
+version = "0.2.12"
 description = "A LLM multi-agent framework."
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -74,7 +74,7 @@ dev = [
 
 [project.optional-dependencies]
 full = [
-    "fabricatio[calc,ftd,plot,qa,rag]",
+    "fabricatio[calc,ftd,plot,qa,rag,cli]",
 ]
 rag = [
     "pymilvus>=2.5.4",
@@ -92,6 +92,9 @@ qa = [
 ftd = [
     "magika>=0.6.1",
 ]
+cli = [
+    "typer-slim[standard]>=0.15.2",
+]
 
 [tool.ruff]
 include = ["pyproject.toml", "python/fabricatio/*.py", "python/fabricatio/*.pyi", "examples/*.py"]
@@ -134,7 +137,8 @@ ignore = [
     "PYI063",
     "PYI021",
     "ASYNC109",
-    "RUF001"
+    "RUF001",
+    "PYI019"
 ]
 [tool.ruff.lint.pydocstyle]
 convention = "google"

{fabricatio-0.2.11.dev2 → fabricatio-0.2.12}/python/fabricatio/actions/article.py

@@ -149,10 +149,10 @@ class GenerateInitialOutline(Action, Extract):
     async def _execute(
         self,
         article_proposal: ArticleProposal,
+        supervisor: Optional[bool] = None,
         **_,
     ) -> Optional[ArticleOutline]:
-        raw_outline = await self.aask(
-            f"{(article_proposal.as_prompt())}\n"
+        req = (
             f"Design each chapter of a proper and academic and ready for release manner.\n"
             f"You Must make sure every chapter have sections, and every section have subsections.\n"
             f"Make the chapter and sections and subsections bing divided into a specific enough article component.\n"
@@ -160,14 +160,16 @@ class GenerateInitialOutline(Action, Extract):
             f"Note that you SHALL use `{article_proposal.language}` as written language",
         )
 
-        if self.supervisor:
+        raw_outline = await self.aask(f"{(article_proposal.as_prompt())}\n{req}")
+
+        if supervisor or (supervisor is None and self.supervisor):
             from questionary import confirm, text
 
             r_print(raw_outline)
             while not await confirm("Accept this version and continue?", default=True).ask_async():
                 imp = await text("Enter the improvement:").ask_async()
                 raw_outline = await self.aask(
-                    f"{article_proposal.as_prompt()}\n{wrapp_in_block(raw_outline, 'Previous ArticleOutline')}\n{imp}"
+                    f"{article_proposal.as_prompt()}\n{wrapp_in_block(raw_outline, 'Previous ArticleOutline')}\n{req}\n{wrapp_in_block(imp, title='Improvement')}"
                 )
                 r_print(raw_outline)
 
@@ -177,6 +179,20 @@ class GenerateInitialOutline(Action, Extract):
         ).update_ref(article_proposal)
 
 
+class ExtractOutlineFromRaw(Action, Extract):
+    """Extract the outline from the raw outline."""
+
+    output_key: str = "article_outline_from_raw"
+
+    async def _execute(self, article_outline_raw_path: str | Path, **cxt) -> ArticleOutline:
+        logger.info(f"Extracting outline from raw: {Path(article_outline_raw_path).as_posix()}")
+
+        return ok(
+            await self.extract(ArticleOutline, safe_text_read(article_outline_raw_path)),
+            "Could not extract the outline from raw.",
+        )
+
+
 class FixIntrospectedErrors(Action, Censor):
     """Fix introspected errors in the article outline."""