fabricatio 0.2.7.dev5__cp312-cp312-win_amd64.whl → 0.2.8.dev1__cp312-cp312-win_amd64.whl

fabricatio/models/extra/article_outline.py

@@ -1,45 +1,28 @@
 """A module containing the ArticleOutline class, which represents the outline of an academic paper."""
 
-from typing import Generator, List, Optional, Self, Tuple, Union, override
+from typing import Dict
 
-import regex
 from fabricatio.models.extra.article_base import (
     ArticleBase,
-    ArticleOutlineBase,
     ChapterBase,
     SectionBase,
     SubSectionBase,
 )
 from fabricatio.models.extra.article_proposal import ArticleProposal
 from fabricatio.models.generic import CensoredAble, Display, PersistentAble, WithRef
-from fabricatio.models.utils import ok
 
 
-class ArticleSubsectionOutline(ArticleOutlineBase, SubSectionBase):
+class ArticleSubsectionOutline(SubSectionBase):
     """Atomic research component specification for academic paper generation."""
 
 
-
-class ArticleSectionOutline(ArticleOutlineBase, SectionBase[ArticleSubsectionOutline]):
+class ArticleSectionOutline(SectionBase[ArticleSubsectionOutline]):
     """A slightly more detailed research component specification for academic paper generation, Must contain subsections."""
 
 
-    def update_from_inner(self, other: Self) -> Self:
-        """Updates the current instance with the attributes of another instance."""
-        super().update_from_inner(other)
-        super(ArticleOutlineBase, self).update_from_inner(other)
-        return self
-
-
-class ArticleChapterOutline(ArticleOutlineBase, ChapterBase[ArticleSectionOutline]):
+class ArticleChapterOutline(ChapterBase[ArticleSectionOutline]):
     """Macro-structural unit implementing standard academic paper organization. Must contain sections."""
 
-    def update_from_inner(self, other: Self) -> Self:
-        """Updates the current instance with the attributes of another instance."""
-        super().update_from_inner(other)
-        super(ArticleOutlineBase, self).update_from_inner(other)
-        return self
-
 
 class ArticleOutline(
     Display,
@@ -48,140 +31,11 @@ class ArticleOutline(
     PersistentAble,
     ArticleBase[ArticleChapterOutline],
 ):
-    """A class representing the outline of an academic paper."""
-
-    abstract: str
-    """The abstract is a concise summary of the academic paper's main findings."""
-
-    prospect: str
-    """Consolidated research statement with four pillars:
-    1. Problem Identification: Current limitations
-    2. Methodological Response: Technical approach
-    3. Empirical Validation: Evaluation strategy
-    4. Scholarly Impact: Field contributions
-    """
-
-    title: str
-    """Title of the academic paper."""
-
-    language: str
-    """Written language of the article. SHALL be aligned to the language of the article proposal provided."""
-
-    def finalized_dump(self) -> str:
-        """Generates standardized hierarchical markup for academic publishing systems.
-
-        Implements ACL 2024 outline conventions with four-level structure:
-        = Chapter Title (Level 1)
-        == Section Title (Level 2)
-        === Subsection Title (Level 3)
-        ==== Subsubsection Title (Level 4)
-
-        Returns:
-            str: Strictly formatted outline with academic sectioning
+    """Outline of an academic paper, containing chapters, sections, subsections."""
 
-        Example:
-            = Methodology
-            == Neural Architecture Search Framework
-            === Differentiable Search Space
-            ==== Constrained Optimization Parameters
-            === Implementation Details
-            == Evaluation Protocol
-        """
-        lines: List[str] = []
-        for i, chapter in enumerate(self.chapters, 1):
-            lines.append(f"= Chapter {i}: {chapter.title}")
-            for j, section in enumerate(chapter.sections, 1):
-                lines.append(f"== {i}.{j} {section.title}")
-                for k, subsection in enumerate(section.subsections, 1):
-                    lines.append(f"=== {i}.{j}.{k} {subsection.title}")
-        return "\n".join(lines)
-
-    @override
-    def iter_dfs(
-        self,
-    ) -> Generator[ArticleChapterOutline | ArticleSectionOutline | ArticleSubsectionOutline, None, None]: 
-        return super().iter_dfs()
-    def find_illegal(self) -> Optional[Tuple[ArticleOutlineBase, str]]:
-        """Finds the first illegal component in the outline.
-
-        Returns:
-            Tuple[ArticleOutlineBase, str]: A tuple containing the illegal component and an error message.
-        """
-        summary = ""
-        for component in self.iter_dfs():
-            for ref in component.depend_on:
-                if not ref.deref(self):
-                    summary += f"Invalid internal reference in {component.__class__.__name__} titled `{component.title}` at `depend_on` field, because the referred {ref.referring_type} is not exists within the article, see the original obj dump: {ref.model_dump()}\n"
-            for ref in component.support_to:
-                if not ref.deref(self):
-                    summary += f"Invalid internal reference in {component.__class__.__name__} titled `{component.title}` at `support_to` field, because the referred {ref.referring_type} is not exists within the article, see the original obj dump: {ref.model_dump()}\n"
-            summary += component.introspect()
-            if summary:
-                return component, summary
-        return None
-
-    @classmethod
-    def from_typst_code(
-        cls, typst_code: str, title: str = "", article_language: str = "en", prospect: str = "", abstract: str = ""
-    ) -> "ArticleOutline":
-        """Parses a Typst code string and creates an ArticleOutline instance."""
-        self = cls(language=article_language, prospect=prospect, abstract=abstract, chapters=[], title=title)
-        stack = [self]  # 根节点为ArticleOutline实例
-
-        for line in typst_code.splitlines():
-            parsed = cls._parse_line(line)
-            if not parsed:
-                continue
-            level, title = parsed
-            cls._adjust_stack(stack, level)
-            parent = stack[-1]
-            component = cls._create_component(level, title)
-            cls._add_to_parent(parent, component, level)
-            stack.append(component)
-
-        return self
-
-    @classmethod
-    def _parse_line(cls, line: str) -> Optional[Tuple[int, str]]:
-        stripped = line.strip()
-        if not stripped.startswith("="):
-            return None
-        match = regex.match(r"^(\=+)(.*)", stripped)
-        if not match:
-            return None
-        eqs, title_part = match.groups()
-        return len(eqs), title_part.strip()
-
-    @classmethod
-    def _adjust_stack(cls, stack: List[object], target_level: int) -> None:
-        while len(stack) > target_level:
-            stack.pop()
-
-    @classmethod
-    def _create_component(cls, level: int, title: str) -> ArticleOutlineBase:
-        default_kwargs = {
-            "writing_aim": [],
-            "depend_on": [],
-            "support_to": [],
-            "description": [],
+    def _as_prompt_inner(self) -> Dict[str, str]:
+        return {
+            "Original Article Briefing": self.referenced.referenced,
+            "Original Article Proposal": self.referenced.display(),
+            "Original Article Outline": self.display(),
         }
-        component_map = {
-            1: lambda: ArticleChapterOutline(title=title, sections=[], **default_kwargs),
-            2: lambda: ArticleSectionOutline(title=title, subsections=[], **default_kwargs),
-            3: lambda: ArticleSubsectionOutline(title=title, **default_kwargs),
-        }
-        return ok(component_map.get(level, lambda: None)(), "Invalid level")
-
-    @classmethod
-    def _add_to_parent(
-        cls,
-        parent: Union["ArticleOutline", ArticleChapterOutline, ArticleSectionOutline],
-        component: ArticleOutlineBase,
-        level: int,
-    ) -> None:
-        if level == 1 and isinstance(component, ArticleChapterOutline):
-            parent.chapters.append(component)
-        elif level == 2 and isinstance(component, ArticleSectionOutline):  # noqa: PLR2004
-            parent.sections.append(component)
-        elif level == 3 and isinstance(component, ArticleSubsectionOutline):  # noqa: PLR2004
-            parent.subsections.append(component)

fabricatio/models/extra/article_proposal.py

@@ -11,25 +11,23 @@ class ArticleProposal(CensoredAble, Display, WithRef[str], AsPrompt, PersistentA
     Guides LLM in generating comprehensive research proposals with clearly defined components.
     """
 
+    language: str
+    """The language in which the article is written. This should align with the language specified in the article briefing."""
+
+    title: str
+    """The title of the academic paper, formatted in Title Case."""
+
+    focused_problem: List[str]
+    """A list of specific research problems or questions that the paper aims to address."""
+
     technical_approaches: List[str]
-    """Technical approaches"""
+    """A list of technical approaches or methodologies used to solve the research problems."""
 
     research_methods: List[str]
-    """Methodological components (list of techniques/tools).
-    Example: ['Differentiable architecture search', 'Transformer-based search space', 'Multi-lingual perplexity evaluation']"""
+    """A list of methodological components, including techniques and tools utilized in the research."""
 
     research_aim: List[str]
-    """Primary research objectives (list of 2-4 measurable goals).
-    Example: ['Develop parameter-efficient NAS framework', 'Establish cross-lingual architecture transfer metrics']"""
-
-    focused_problem: List[str]
-    """Specific research problem(s) or question(s) addressed (list of 1-3 concise statements).
-    Example: ['NAS computational overhead in low-resource settings', 'Architecture transferability across language pairs']"""
-
-    title: str
-    """Paper title in academic style (Title Case, 8-15 words). Example: 'Exploring Neural Architecture Search for Low-Resource Machine Translation'"""
-    language: str
-    """Written language of the article. SHALL be aligned to the language of the article briefing provided."""
+    """A list of primary research objectives that the paper seeks to achieve."""
 
     def _as_prompt_inner(self) -> Dict[str, str]:
         return {"ArticleBriefing": self.referenced, "ArticleProposal": self.display()}

fabricatio/models/generic.py

@@ -1,6 +1,6 @@
 """This module defines generic classes for models in the Fabricatio library."""
 
-from abc import abstractmethod
+from abc import ABC, abstractmethod
 from pathlib import Path
 from typing import Any, Callable, Dict, Iterable, List, Optional, Self, Union, final, overload
 
@@ -108,7 +108,7 @@ class PersistentAble(Base):
     """Class that provides a method to persist the object."""
 
     def persist(self, path: str | Path) -> Self:
-        """Persist the object to a file.
+        """Persist the object to a file or directory.
 
         Args:
             path (str | Path): The path to save the object.
@@ -117,7 +117,7 @@ class PersistentAble(Base):
             Self: The current instance of the object.
         """
         p = Path(path)
-        out = self.model_dump_json()
+        out = self.model_dump_json(indent=1)
         if p.is_dir():
             p.joinpath(f"{self.__class__.__name__}_{blake3_hash(out.encode())[:6]}.json").write_text(
                 out, encoding="utf-8"
@@ -125,6 +125,7 @@ class PersistentAble(Base):
             return self
         p.mkdir(exist_ok=True, parents=True)
         p.write_text(out, encoding="utf-8")
+        logger.info(f"Persisted {self} to {p.as_posix()}")
         return self
 
     def from_persistent(self, path: str | Path) -> Self:
@@ -228,20 +229,11 @@ class WithBriefing(Named, Described):
                 raise TypeError(f"{system_msg_like} is not a dict or str")
 
 
-class ReverseGenerate(GenerateJsonSchema):
+class UnsortGenerate(GenerateJsonSchema):
     """Class that provides a reverse JSON schema of the model."""
 
-    def _sort_recursive(self, value: Any, parent_key: str | None = None) -> Any:
-        if isinstance(value, dict):
-            sorted_dict: dict[str, JsonSchemaValue] = {}
-            # Reverse all keys regardless of parent_key
-            keys = reversed(value.keys())
-            for key in keys:
-                sorted_dict[key] = self._sort_recursive(value[key], parent_key=key)
-            return sorted_dict
-        if isinstance(value, list):
-            # Reverse list order and process each item
-            return [self._sort_recursive(item, parent_key) for item in reversed(value)]
+    def sort(self, value: JsonSchemaValue, parent_key: str | None = None) -> JsonSchemaValue:
+        """Not sort."""
         return value
 
 
@@ -256,7 +248,7 @@ class WithFormatedJsonSchema(Base):
             str: The JSON schema of the model in a formatted string.
         """
         return orjson.dumps(
-            cls.model_json_schema(schema_generator=ReverseGenerate),
+            cls.model_json_schema(schema_generator=UnsortGenerate),
             option=orjson.OPT_INDENT_2,
         ).decode()
 
@@ -316,6 +308,10 @@ class ProposedAble(CreateJsonObjPrompt, InstantiateFromString):
     """Class that provides a method to propose a JSON object based on the requirement."""
 
 
+class ProposedUpdateAble(PersistentAble, UpdateFrom, ABC):
+    """Make the obj can be updated from the proposed obj in place."""
+
+
 class FinalizedDumpAble(Base):
     """Class that provides a method to finalize the dump of the object."""
 

fabricatio/models/usages.py

@@ -1,5 +1,6 @@
 """This module contains classes that manage the usage of language models and tools in tasks."""
 
+import traceback
 from asyncio import gather
 from typing import Callable, Dict, Iterable, List, Optional, Self, Sequence, Set, Type, Union, Unpack, overload
 
@@ -38,6 +39,8 @@ ROUTER = Router(
     allowed_fails=configs.routing.allowed_fails,
     retry_after=configs.routing.retry_after,
     cooldown_time=configs.routing.cooldown_time,
+    cache_responses=configs.cache.enabled,
+    cache_kwargs=configs.cache.params,
 )
 
 
@@ -135,7 +138,7 @@ class LLMUsage(ScopedConfig):
             List[Choices | StreamingChoices]: A list of choices or streaming choices from the model response.
         """
         resp = await self.aquery(
-            messages=Messages().add_system_message(system_message).add_user_message(question),
+            messages=Messages().add_system_message(system_message).add_user_message(question).as_list(),
             n=n,
             **kwargs,
         )
@@ -324,6 +327,7 @@ class LLMUsage(ScopedConfig):
                     continue
                 except Exception as e:  # noqa: BLE001
                     logger.error(f"Error during validation: \n{e}")
+                    logger.debug(traceback.format_exc())
                     break
                 if not kwargs.get("no_cache"):
                     kwargs["no_cache"] = True

{fabricatio-0.2.7.dev5.dist-info → fabricatio-0.2.8.dev1.dist-info}/METADATA

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

{fabricatio-0.2.7.dev5.dist-info → fabricatio-0.2.8.dev1.dist-info}/RECORD

@@ -1,15 +1,16 @@
-fabricatio-0.2.7.dev5.dist-info/METADATA,sha256=ANxpgCb6nTOneCJ-RdQ7ejNoefGzRdKyfQIvwVfCJiU,5259
-fabricatio-0.2.7.dev5.dist-info/WHEEL,sha256=jABKVkLC9kJr8mi_er5jOqpiQUjARSLXDUIIxDqsS50,96
-fabricatio-0.2.7.dev5.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
-fabricatio/actions/article.py,sha256=cv1pyGOvgMVMaHJqVDKY6h5_u1XtVw3lzJCDFqx4aoc,8073
+fabricatio-0.2.8.dev1.dist-info/METADATA,sha256=doJ4_NB0Ild3P3v79TzSYye8wttaYrTaoieNesBqxgw,5259
+fabricatio-0.2.8.dev1.dist-info/WHEEL,sha256=jABKVkLC9kJr8mi_er5jOqpiQUjARSLXDUIIxDqsS50,96
+fabricatio-0.2.8.dev1.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
+fabricatio/actions/article.py,sha256=l1WzphK_yR-l8KdmX6cb95vhETntrJEvMgVLBTULwJU,12074
 fabricatio/actions/article_rag.py,sha256=PiOFxI6VTmLXm3BK-01g_KH1mTE9uOtnA-CwUjt16AU,1456
-fabricatio/actions/output.py,sha256=K7xsBH8MjXRH6JOy3ZO94KCQzX2jNrwPPK_rRXVkS0E,1161
+fabricatio/actions/output.py,sha256=eHI4EH5n1nOt6MqQ00b7UWTjIqO8FerNakem_45d5qk,2315
 fabricatio/actions/rag.py,sha256=QBdzEM8MloM_ahx5pTBZAETm9_631lTe_0ih_he_Iuo,2759
-fabricatio/capabilities/correct.py,sha256=8GOU2VBPUakjG-r59SqsCgCD0QHX-l__IynCLO-ib8Q,6482
+fabricatio/capabilities/advanced_judge.py,sha256=selB0Gwf1F4gGJlwBiRo6gI4KOUROgh3WnzO3mZFEls,706
+fabricatio/capabilities/correct.py,sha256=2093ggHkY8vQW8fl7VwXC8u39oW1xsfjxDjGoQ5puOA,7269
 fabricatio/capabilities/propose.py,sha256=y3kge5g6bb8HYuV8e9h4MdqOMTlsfAIZpqE_cagWPTY,1593
 fabricatio/capabilities/rag.py,sha256=XVvfH6rcog-moj1WCgwtR-l0-NdbFR6-fMQFLG7_asY,17690
-fabricatio/capabilities/rating.py,sha256=yEPqL5_DqVMj_AH9cMvKsHdMnSbvm8dN6PaKHLsJUPQ,14904
-fabricatio/capabilities/review.py,sha256=uc4WV9Xu-4rXAXZ-k-32HXAgm4WMLbDRfiZdRP7Nepg,11384
+fabricatio/capabilities/rating.py,sha256=j7ABxVyEnXwdKIPOIP_ysP4WP7PR1FcwjmYTkSZsVcw,14900
+fabricatio/capabilities/review.py,sha256=1VBP9lNeqrTs-Whu2StpaPL2aDSrFybce8TfPJKIMjE,11376
 fabricatio/capabilities/task.py,sha256=vtS0YOe639vN8iTrkP2WK0AJVCr5N_JAaJuvRGyY2Fg,4639
 fabricatio/config.py,sha256=hUv5XMzOkEw8cQjsVHTpPPix52IKwmxjBsZM6Px3xZI,16915
 fabricatio/core.py,sha256=VQ_JKgUGIy2gZ8xsTBZCdr_IP7wC5aPg0_bsOmjQ588,6458
@@ -18,19 +19,20 @@ fabricatio/fs/curd.py,sha256=N6l2MncjrFfnXBRtteRouXp5Rjy8EAKC_i29_G-zz98,4618
 fabricatio/fs/readers.py,sha256=EZKN_AZdrp8DggJECP53QHw3uHeSDf-AwCAA_V7fNKU,1202
 fabricatio/fs/__init__.py,sha256=PCf0s_9KDjVfNw7AfPoJzGt3jMq4gJOfbcT4pb0D0ZY,588
 fabricatio/journal.py,sha256=stnEP88aUBA_GmU9gfTF2EZI8FS2OyMLGaMSTgK4QgA,476
-fabricatio/models/action.py,sha256=UlflniS__MMrUXglu_U3PDFAtKEjVsKEix17AT9oP3M,8769
+fabricatio/models/action.py,sha256=Rt3a9JWVhaoo7AatStzb9Gl45MKRcSeLWcOHJFCqNNM,8883
 fabricatio/models/events.py,sha256=QvlnS8FEELg6KNabcJMeh2GV_y0ZBzKOPphcteKYWYU,4183
-fabricatio/models/extra/article_base.py,sha256=Y4ZdC1yabs7jCNKwc-P8GpAJShGJx7EcLyhXuJ194Fo,11469
-fabricatio/models/extra/article_essence.py,sha256=DUESuK4CGgkRvIMoJCv4l8MNp5MawRYoNOtLCrFRPXY,9229
-fabricatio/models/extra/article_main.py,sha256=l6HO3PajaesEET6Evd2A7OOpHRelGYr4y88JyoPmP3Y,8498
-fabricatio/models/extra/article_outline.py,sha256=VV6RUY7VzKwqCXoykDi-vL2nqHouOuo1Q3hLdCdNDpQ,7740
-fabricatio/models/extra/article_proposal.py,sha256=p0NPzqg9x6t65DZqdF52Z1P0JwP6kwo2_eP-NsXgifU,1720
-fabricatio/models/generic.py,sha256=yEpP4cvvmB0sDbs36pIl2KYFsnNRKq7V0m3HqoSQc7o,19492
+fabricatio/models/extra/advanced_judge.py,sha256=98NACWVFG01Q-tZDiMNwyQ5-RDVAZ73IVt3D9aqky4Y,574
+fabricatio/models/extra/article_base.py,sha256=SRMCwtxYMkJyA7tK2GG8rFmg2UJgQV7O3qyiVwoq2MQ,15826
+fabricatio/models/extra/article_essence.py,sha256=-vtI8Kua-XoAYXg82b3szT-vscrXne-zmlv2TIxWspI,9063
+fabricatio/models/extra/article_main.py,sha256=N5deYozSjmAyYO8_On85NesUV0mIyTsGdHUWtR2b6q4,8087
+fabricatio/models/extra/article_outline.py,sha256=jFbVgiwlo7rnwCGS6ToVgeMUOoRe99Edgbx95THR6z8,1450
+fabricatio/models/extra/article_proposal.py,sha256=DWn3MQUNQlXj9Fcm3xSONyxARz8goAroJUA6pWvBhHw,1398
+fabricatio/models/generic.py,sha256=nyfhgaIEsSvbDvcHrjULEgseBKRzZx2t21lfncwCsq4,19225
 fabricatio/models/kwargs_types.py,sha256=chJ-rHaeBVRUPuORHuGR3DdNxxTUrotz0eflPEh4l4w,5474
 fabricatio/models/role.py,sha256=mmQbJ6GKr2Gx3wtjEz8d-vYoXs09ffcEkT_eCXaDd3E,2782
 fabricatio/models/task.py,sha256=8NaR7ojQWyM740EDTqt9stwHKdrD6axCRpLKo0QzS-I,10492
 fabricatio/models/tool.py,sha256=kD0eB7OxO9geZOxO6JIKvCBeG-KOpRAkfRZqK_WGfW4,7105
-fabricatio/models/usages.py,sha256=BSqTENSva8Flga3bPBfwuc1nHo5Z_29oYzar99NbjLM,31566
+fabricatio/models/usages.py,sha256=BZXHdm198wMOaYvCqL7wBcSzAHUMS4mYeD_VCi08mmY,31736
 fabricatio/models/utils.py,sha256=yjxPZ6N7QGpGwkI_Vb28Ud3EhkdlB-tyfGRHAZMcGxs,5872
 fabricatio/parser.py,sha256=9Jzw-yV6uKbFvf6sPna-XHdziVGVBZWvPctgX_6ODL8,6251
 fabricatio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -42,6 +44,6 @@ fabricatio/workflows/rag.py,sha256=-YYp2tlE9Vtfgpg6ROpu6QVO8j8yVSPa6yDzlN3qVxs,5
 fabricatio/_rust.pyi,sha256=dGTGV7viu3YAGl1cRKIWrdHPc1hlwk3_hbaDaswxdVo,3831
 fabricatio/_rust_instances.py,sha256=2GwF8aVfYNemRI2feBzH1CZfBGno-XJJE5imJokGEYw,314
 fabricatio/__init__.py,sha256=SzBYsRhZeL77jLtfJEjmoHOSwHwUGyvMATX6xfndLDM,1135
-fabricatio/_rust.cp312-win_amd64.pyd,sha256=db4DHfetEQMNh7hqmL6All-asJooQxFIIXZkoWKAx4c,1835008
-fabricatio-0.2.7.dev5.data/scripts/tdown.exe,sha256=xZcDsLIn9rJZcM8iDNgS-eNK4ckH5rufC6mU6I2vmOo,3399680
-fabricatio-0.2.7.dev5.dist-info/RECORD,,
+fabricatio/_rust.cp312-win_amd64.pyd,sha256=8WKD2UwAiWvZL9Nrl7xvYdQjVX0zNIMuINGgdxtaIHU,1830912
+fabricatio-0.2.8.dev1.data/scripts/tdown.exe,sha256=8q6RV1e71w8_otae06rFwh3ESP7jxTx6mQiQMP09aJU,3399680
+fabricatio-0.2.8.dev1.dist-info/RECORD,,