fabricatio 0.3.14.dev7__tar.gz → 0.3.14.dev8__tar.gz

{fabricatio-0.3.14.dev7 → fabricatio-0.3.14.dev8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.3.14.dev7
+Version: 0.3.14.dev8
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3.12

{fabricatio-0.3.14.dev7 → fabricatio-0.3.14.dev8}/examples/write_article/write_article.py

@@ -5,7 +5,8 @@ from pathlib import Path
 from typing import Optional
 
 import typer
-from fabricatio import Event, Role, WorkFlow, logger
+from fabricatio import Event, WorkFlow, logger
+from fabricatio import Role as RoleBase
 from fabricatio.actions.article import (
     ExtractOutlineFromRaw,
     GenerateArticleProposal,
@@ -18,21 +19,27 @@ from fabricatio.fs import safe_text_read
 from fabricatio.models.extra.article_main import Article
 from fabricatio.models.extra.article_outline import ArticleOutline
 from fabricatio.models.task import Task
+from fabricatio.models.usages import LLMUsage
 from fabricatio.utils import ok
 from typer import Typer
 
 # from pydantic import HttpUrl
 
+
+class Role(RoleBase, LLMUsage):
+    """Role class for article writing."""
+
+
 Role(
     name="Undergraduate Researcher",
     description="Write an outline for an article in typst format.",
-    llm_model="openai/qwen3-235b-a22b",
-    # llm_api_endpoint=HttpUrl("https://dashscope.aliyuncs.com/compatible-mode/v1"),
+    llm_model="openai/qwen-plus",
+    llm_api_endpoint="https://dashscope.aliyuncs.com/compatible-mode/v1",
     llm_stream=True,
     llm_max_tokens=8191,
     llm_rpm=600,
     llm_tpm=900000,
-    llm_timeout=600,
+    llm_timeout=10,
     registry={
         Event.quick_instantiate(ns := "article"): WorkFlow(
             name="Generate Article",

{fabricatio-0.3.14.dev7 → fabricatio-0.3.14.dev8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fabricatio"
-version = "0.3.14-dev7"
+version = "0.3.14-dev8"
 description = "A LLM multi-agent framework."
 readme = "README.md"
 license = { file = "LICENSE" }

{fabricatio-0.3.14.dev7 → fabricatio-0.3.14.dev8}/python/fabricatio/actions/article_rag.py

@@ -1,11 +1,11 @@
 """A module for writing articles using RAG (Retrieval-Augmented Generation) capabilities."""
 
 from asyncio import gather
-
 from pathlib import Path
-from pydantic import Field, PositiveInt
 from typing import ClassVar, List, Optional
 
+from pydantic import Field, PositiveInt
+
 from fabricatio.capabilities.advanced_rag import AdvancedRAG
 from fabricatio.capabilities.censor import Censor
 from fabricatio.capabilities.extract import Extract
@@ -75,11 +75,11 @@ class WriteArticleContentRAG(Action, Extract, AdvancedRAG):
     tei_endpoint: Optional[str] = None
 
     async def _execute(
-            self,
-            article_outline: ArticleOutline,
-            collection_name: Optional[str] = None,
-            supervisor: Optional[bool] = None,
-            **cxt,
+        self,
+        article_outline: ArticleOutline,
+        collection_name: Optional[str] = None,
+        supervisor: Optional[bool] = None,
+        **cxt,
     ) -> Article:
         article = Article.from_outline(article_outline).update_ref(article_outline)
         self.target_collection = collection_name or self.safe_target_collection
@@ -100,12 +100,12 @@ class WriteArticleContentRAG(Action, Extract, AdvancedRAG):
         "questionary", "`questionary` is required for supervisor mode, please install it by `fabricatio[qa]`"
     )
     async def _supervisor_inner(
-            self,
-            article: Article,
-            article_outline: ArticleOutline,
-            chap: ArticleChapter,
-            sec: ArticleSection,
-            subsec: ArticleSubsection,
+        self,
+        article: Article,
+        article_outline: ArticleOutline,
+        chap: ArticleChapter,
+        sec: ArticleSection,
+        subsec: ArticleSubsection,
     ) -> ArticleSubsection:
         from questionary import confirm, text
         from rich import print as r_print
@@ -133,12 +133,12 @@ class WriteArticleContentRAG(Action, Extract, AdvancedRAG):
         return await self.extract_new_subsec(subsec, raw_paras, cm)
 
     async def _inner(
-            self,
-            article: Article,
-            article_outline: ArticleOutline,
-            chap: ArticleChapter,
-            sec: ArticleSection,
-            subsec: ArticleSubsection,
+        self,
+        article: Article,
+        article_outline: ArticleOutline,
+        chap: ArticleChapter,
+        sec: ArticleSection,
+        subsec: ArticleSubsection,
     ) -> ArticleSubsection:
         cm = CitationManager()
 
@@ -154,7 +154,7 @@ class WriteArticleContentRAG(Action, Extract, AdvancedRAG):
         return await self.extract_new_subsec(subsec, raw_paras, cm)
 
     async def extract_new_subsec(
-            self, subsec: ArticleSubsection, raw_paras: str, cm: CitationManager
+        self, subsec: ArticleSubsection, raw_paras: str, cm: CitationManager
     ) -> ArticleSubsection:
         """Extract the new subsec."""
         new_subsec = ok(
@@ -177,14 +177,14 @@ class WriteArticleContentRAG(Action, Extract, AdvancedRAG):
         return subsec
 
     async def write_raw(
-            self,
-            article: Article,
-            article_outline: ArticleOutline,
-            chap: ArticleChapter,
-            sec: ArticleSection,
-            subsec: ArticleSubsection,
-            cm: CitationManager,
-            extra_instruction: str = "",
+        self,
+        article: Article,
+        article_outline: ArticleOutline,
+        chap: ArticleChapter,
+        sec: ArticleSection,
+        subsec: ArticleSubsection,
+        cm: CitationManager,
+        extra_instruction: str = "",
     ) -> str:
         """Write the raw paragraphs of the subsec."""
         return await self.aask(
@@ -200,14 +200,14 @@ class WriteArticleContentRAG(Action, Extract, AdvancedRAG):
         )
 
     async def search_database(
-            self,
-            article: Article,
-            article_outline: ArticleOutline,
-            chap: ArticleChapter,
-            sec: ArticleSection,
-            subsec: ArticleSubsection,
-            cm: CitationManager,
-            extra_instruction: str = "",
+        self,
+        article: Article,
+        article_outline: ArticleOutline,
+        chap: ArticleChapter,
+        sec: ArticleSection,
+        subsec: ArticleSubsection,
+        cm: CitationManager,
+        extra_instruction: str = "",
     ) -> None:
         """Search database for related references."""
         search_req = (
@@ -312,12 +312,12 @@ class TweakArticleRAG(Action, RAG, Censor):
     """The limit of references to be retrieved"""
 
     async def _execute(
-            self,
-            article: Article,
-            collection_name: str = "article_essence",
-            twk_rag_ruleset: Optional[RuleSet] = None,
-            parallel: bool = False,
-            **cxt,
+        self,
+        article: Article,
+        collection_name: str = "article_essence",
+        twk_rag_ruleset: Optional[RuleSet] = None,
+        parallel: bool = False,
+        **cxt,
     ) -> Article:
         """Write an article based on the provided outline.
 
@@ -372,10 +372,10 @@ class TweakArticleRAG(Action, RAG, Censor):
             subsec,
             ruleset=ruleset,
             reference=f"{'\n\n'.join(d.display() for d in await self.aretrieve(refind_q, document_model=ArticleEssence, max_accepted=self.ref_limit))}\n\n"
-                      f"You can use Reference above to rewrite the `{subsec.__class__.__name__}`.\n"
-                      f"You should Always use `{subsec.language}` as written language, "
-                      f"which is the original language of the `{subsec.title}`. "
-                      f"since rewrite a `{subsec.__class__.__name__}` in a different language is usually a bad choice",
+            f"You can use Reference above to rewrite the `{subsec.__class__.__name__}`.\n"
+            f"You should Always use `{subsec.language}` as written language, "
+            f"which is the original language of the `{subsec.title}`. "
+            f"since rewrite a `{subsec.__class__.__name__}` in a different language is usually a bad choice",
         )
 
 
@@ -390,12 +390,12 @@ class ChunkArticle(Action):
     """The maximum overlapping rate between chunks."""
 
     async def _execute(
-            self,
-            article_path: str | Path,
-            bib_manager: BibManager,
-            max_chunk_size: Optional[int] = None,
-            max_overlapping_rate: Optional[float] = None,
-            **_,
+        self,
+        article_path: str | Path,
+        bib_manager: BibManager,
+        max_chunk_size: Optional[int] = None,
+        max_overlapping_rate: Optional[float] = None,
+        **_,
     ) -> List[ArticleChunk]:
         return ArticleChunk.from_file(
             article_path,

{fabricatio-0.3.14.dev7 → fabricatio-0.3.14.dev8}/python/fabricatio/decorators.py

@@ -235,6 +235,7 @@ def logging_exec_time[**P, R](
         @wraps(func)
         async def _async_wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
             start_time = time()
+            logger.debug(f"Starting execution of {func.__name__}")
             result = await func(*args, **kwargs)
             logger.debug(f"Execution time of `{func.__name__}`: {time() - start_time:.2f} s")
             return result
@@ -244,6 +245,7 @@ def logging_exec_time[**P, R](
     @wraps(func)
     def _wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
         start_time = time()
+        logger.debug(f"Starting execution of {func.__name__}")
         result = func(*args, **kwargs)
         logger.debug(f"Execution time of {func.__name__}: {(time() - start_time) * 1000:.2f} ms")
         return result

{fabricatio-0.3.14.dev7 → fabricatio-0.3.14.dev8}/python/fabricatio/models/extra/aricle_rag.py

@@ -1,13 +1,9 @@
 """A Module containing the article rag models."""
 
-from itertools import groupby
-
 import re
 from dataclasses import dataclass, field
-from more_itertools.more import first
-from more_itertools.recipes import flatten, unique
+from itertools import groupby
 from pathlib import Path
-from pydantic import Field
 from typing import ClassVar, Dict, List, Optional, Self, Unpack
 
 from fabricatio.fs import safe_text_read
@@ -17,6 +13,9 @@ from fabricatio.models.generic import AsPrompt
 from fabricatio.models.kwargs_types import ChunkKwargs
 from fabricatio.rust import BibManager, blake3_hash, split_into_chunks
 from fabricatio.utils import ok, wrapp_in_block
+from more_itertools.more import first
+from more_itertools.recipes import flatten, unique
+from pydantic import Field
 
 
 class ArticleChunk(MilvusDataBase):

{fabricatio-0.3.14.dev7 → fabricatio-0.3.14.dev8}/python/fabricatio/models/extra/article_base.py

@@ -3,7 +3,6 @@
 from abc import ABC
 from enum import StrEnum
 from pathlib import Path
-from pydantic import Field
 from typing import ClassVar, Generator, List, Optional, Self, Tuple, Type
 
 from fabricatio.capabilities.persist import PersistentAble
@@ -24,6 +23,7 @@ from fabricatio.models.generic import (
 )
 from fabricatio.rust import extract_body, replace_thesis_body, split_out_metadata, to_metadata, word_count
 from fabricatio.utils import fallback_kwargs, ok
+from pydantic import Field
 
 ARTICLE_WRAPPER = "// =-=-=-=-=-=-=-=-=-="
 
@@ -275,7 +275,7 @@ class ArticleBase[T: ChapterBase](FinalizedDumpAble, AsPrompt, FromTypstCode, To
         )
 
     def iter_dfs_rev(
-            self,
+        self,
     ) -> Generator[ArticleOutlineBase, None, None]:
         """Performs a depth-first search (DFS) through the article structure in reverse order.
 

{fabricatio-0.3.14.dev7 → fabricatio-0.3.14.dev8}/python/fabricatio/models/extra/article_main.py

@@ -1,6 +1,5 @@
 """ArticleBase and ArticleSubsection classes for managing hierarchical document components."""
 
-from pydantic import Field, NonNegativeInt
 from typing import ClassVar, Dict, Generator, List, Self, Tuple, Type, override
 
 from fabricatio.capabilities.persist import PersistentAble
@@ -25,6 +24,7 @@ from fabricatio.rust import (
     split_out_metadata,
     word_count,
 )
+from pydantic import Field, NonNegativeInt
 
 PARAGRAPH_SEP = "// - - -"
 
@@ -81,8 +81,8 @@ class ArticleSubsection(SubSectionBase):
         if len(self.paragraphs) == 0:
             summary += f"`{self.__class__.__name__}` titled `{self.title}` have no paragraphs, You should add some!\n"
         if (
-                abs((wc := self.word_count) - self.expected_word_count) / self.expected_word_count
-                > self._max_word_count_deviation
+            abs((wc := self.word_count) - self.expected_word_count) / self.expected_word_count
+            > self._max_word_count_deviation
         ):
             summary += f"`{self.__class__.__name__}` titled `{self.title}` have {wc} words, expected {self.expected_word_count} words!"
 

{fabricatio-0.3.14.dev7 → fabricatio-0.3.14.dev8}/python/fabricatio/models/role.py

@@ -1,7 +1,7 @@
 """Module that contains the Role class for managing workflows and their event registrations."""
 
 from functools import partial
-from typing import Any, Dict, Self
+from typing import Any, Callable, Dict, Self, Type
 
 from fabricatio.emitter import env
 from fabricatio.journal import logger
@@ -68,28 +68,32 @@ class Role(WithBriefing):
             workflow.inject_personality(self.briefing)
         return self
 
-    def _configure_scoped_config(self, workflow: WorkFlow) -> None:
-        """Configure scoped configuration for workflow and its actions."""
-        if not is_scoped_config(self.__class__):
+    def _propagate_config(
+        self,
+        workflow: WorkFlow,
+        has_capability: Callable[[Type], bool],
+        config_method_name: str,
+        capability_description: str,
+    ) -> None:
+        """Propagates configuration to workflow and its actions if they have a given capability."""
+        if not has_capability(self.__class__):
             return
 
-        fallback_target = self
-        if is_scoped_config(workflow):
-            workflow.fallback_to(self)
-            fallback_target = workflow
+        config_source_for_actions = self
+        if has_capability(workflow.__class__):
+            logger.debug(
+                f"Configuring {capability_description} inherited from `{self.name}` for workflow: `{workflow.name}`"
+            )
+            getattr(workflow, config_method_name)(self)
+            config_source_for_actions = workflow
 
-        for action in (a for a in workflow.iter_actions() if is_scoped_config(a)):
-            action.fallback_to(fallback_target)
+        for action in (act for act in workflow.iter_actions() if has_capability(act.__class__)):
+            getattr(action, config_method_name)(config_source_for_actions)
+
+    def _configure_scoped_config(self, workflow: WorkFlow) -> None:
+        """Configure scoped configuration for workflow and its actions."""
+        self._propagate_config(workflow, is_scoped_config, "fallback_to", "scoped config")
 
     def _configure_toolbox_usage(self, workflow: WorkFlow) -> None:
         """Configure toolbox usage for workflow and its actions."""
-        if not is_toolbox_usage(self.__class__):
-            return
-
-        supply_target = self
-        if is_toolbox_usage(workflow):
-            workflow.supply_tools_from(self)
-            supply_target = workflow
-
-        for action in (a for a in workflow.iter_actions() if is_toolbox_usage(a)):
-            action.supply_tools_from(supply_target)
+        self._propagate_config(workflow, is_toolbox_usage, "supply_tools_from", "toolbox usage")