fabricatio 0.2.8.dev0__tar.gz → 0.2.8.dev1__tar.gz

{fabricatio-0.2.8.dev0 → fabricatio-0.2.8.dev1}/PKG-INFO

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

{fabricatio-0.2.8.dev0 → fabricatio-0.2.8.dev1}/pyproject.toml

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

{fabricatio-0.2.8.dev0 → fabricatio-0.2.8.dev1}/python/fabricatio/actions/article.py

@@ -4,9 +4,11 @@ from asyncio import gather
 from pathlib import Path
 from typing import Any, Callable, List, Optional
 
+from fabricatio.capabilities.advanced_judge import AdvancedJudge
 from fabricatio.fs import safe_text_read
 from fabricatio.journal import logger
 from fabricatio.models.action import Action
+from fabricatio.models.extra.article_base import ArticleRefPatch
 from fabricatio.models.extra.article_essence import ArticleEssence
 from fabricatio.models.extra.article_main import Article
 from fabricatio.models.extra.article_outline import ArticleOutline
@@ -88,10 +90,10 @@ class GenerateArticleProposal(Action):
         return proposal
 
 
-class GenerateOutline(Action):
-    """Generate the article based on the outline."""
+class GenerateInitialOutline(Action):
+    """Generate the initial article outline based on the article proposal."""
 
-    output_key: str = "article_outline"
+    output_key: str = "initial_article_outline"
     """The key of the output data."""
 
     async def _execute(
@@ -99,15 +101,27 @@ class GenerateOutline(Action):
         article_proposal: ArticleProposal,
         **_,
     ) -> Optional[ArticleOutline]:
-        out = ok(
+        return ok(
             await self.propose(
                 ArticleOutline,
                 article_proposal.as_prompt(),
                 **self.prepend_sys_msg(),
             ),
-            "Could not generate the outline.",
+            "Could not generate the initial outline.",
         )
 
+
+class FixIntrospectedErrors(Action):
+    """Fix introspected errors in the article outline."""
+
+    output_key: str = "introspected_errors_fixed_outline"
+    """The key of the output data."""
+
+    async def _execute(
+        self,
+        article_outline: ArticleOutline,
+        **_,
+    ) -> Optional[ArticleOutline]:
         introspect_manual = ok(
             await self.draft_rating_manual(
                 topic=(
@@ -118,13 +132,13 @@ class GenerateOutline(Action):
             "Could not generate the rating manual.",
         )
 
-        while pack := out.find_introspected():
+        while pack := article_outline.find_introspected():
             component, err = ok(pack)
             logger.warning(f"Found introspected error: {err}")
             corrected = ok(
                 await self.correct_obj(
                     component,
-                    reference=f"# Original Article Outline\n{out.display()}\n# Error Need to be fixed\n{err}",
+                    reference=f"# Original Article Outline\n{article_outline.display()}\n# Error Need to be fixed\n{err}",
                     topic=intro_topic,
                     rating_manual=introspect_manual,
                     supervisor_check=False,
@@ -133,6 +147,20 @@ class GenerateOutline(Action):
             )
             component.update_from(corrected)
 
+        return article_outline
+
+
+class FixIllegalReferences(Action):
+    """Fix illegal references in the article outline."""
+
+    output_key: str = "illegal_references_fixed_outline"
+    """The key of the output data."""
+
+    async def _execute(
+        self,
+        article_outline: ArticleOutline,
+        **_,
+    ) -> Optional[ArticleOutline]:
         ref_manual = ok(
             await self.draft_rating_manual(
                 topic=(
@@ -143,19 +171,87 @@ class GenerateOutline(Action):
             "Could not generate the rating manual.",
         )
 
-        while pack := out.find_illegal_ref():
+        while pack := article_outline.find_illegal_ref():
             ref, err = ok(pack)
             logger.warning(f"Found illegal referring error: {err}")
             ok(
                 await self.correct_obj_inplace(
                     ref,
-                    reference=f"# Original Article Outline\n{out.display()}\n# Error Need to be fixed\n{err}\n\n",
+                    reference=f"# Original Article Outline\n{article_outline.display()}\n# Error Need to be fixed\n{err}\n\n",
                     topic=ref_topic,
                     rating_manual=ref_manual,
                     supervisor_check=False,
                 )
             )
-        return out.update_ref(article_proposal)
+        return article_outline.update_ref(article_outline)
+
+
+class TweakOutlineBackwardRef(Action, AdvancedJudge):
+    """Tweak the backward references in the article outline.
+
+    Ensures that the prerequisites of the current chapter are correctly referenced in the `depend_on` field.
+    """
+
+    output_key: str = "article_outline_bw_ref_checked"
+
+    async def _execute(self, article_outline: ArticleOutline, **cxt) -> ArticleOutline:
+        tweak_depend_on_manual = ok(
+            await self.draft_rating_manual(
+                topic := "Ensure prerequisites are correctly referenced in the `depend_on` field."
+            ),
+            "Could not generate the rating manual.",
+        )
+
+        for a in article_outline.iter_dfs():
+            if await self.evidently_judge(
+                f"{article_outline.as_prompt()}\n\n{a.display()}\n"
+                f"Does the `{a.__class__.__name__}`'s `depend_on` field need to be extended or tweaked?"
+            ):
+                patch=ArticleRefPatch.default()
+                patch.tweaked=a.depend_on
+
+                await self.correct_obj_inplace(
+                    patch,
+                    topic=topic,
+                    reference=f"{article_outline.as_prompt()}\nThe Article component whose `depend_on` field needs to be extended or tweaked",
+                    rating_manual=tweak_depend_on_manual,
+                )
+
+        return article_outline
+
+
+class TweakOutlineForwardRef(Action, AdvancedJudge):
+    """Tweak the forward references in the article outline.
+
+    Ensures that the conclusions of the current chapter effectively support the analysis of subsequent chapters.
+    """
+
+    output_key: str = "article_outline_fw_ref_checked"
+
+    async def _execute(self, article_outline: ArticleOutline, **cxt) -> ArticleOutline:
+        tweak_support_to_manual = ok(
+            await self.draft_rating_manual(
+                topic := "Ensure conclusions support the analysis of subsequent chapters, sections or subsections."
+            ),
+            "Could not generate the rating manual.",
+        )
+
+        for a in article_outline.iter_dfs():
+            if await self.evidently_judge(
+                f"{article_outline.as_prompt()}\n\n{a.display()}\n"
+                f"Does the `{a.__class__.__name__}`'s `support_to` field need to be extended or tweaked?"
+            ):
+                patch=ArticleRefPatch.default()
+                patch.tweaked=a.support_to
+
+                await self.correct_obj_inplace(
+                    patch,
+                    topic=topic,
+                    reference=f"{article_outline.as_prompt()}\nThe Article component whose `support_to` field needs to be extended or tweaked",
+                    rating_manual=tweak_support_to_manual,
+                )
+
+        return article_outline
 
 
 class GenerateArticle(Action):
@@ -191,6 +287,7 @@ class GenerateArticle(Action):
             ],
             return_exceptions=True,
         )
+
         return article
 
 

fabricatio-0.2.8.dev1/python/fabricatio/capabilities/advanced_judge.py

@@ -0,0 +1,23 @@
+"""The Capabilities module for advanced judging."""
+
+from typing import Optional, Unpack
+
+from fabricatio.capabilities.propose import Propose
+from fabricatio.models.extra.advanced_judge import JudgeMent
+from fabricatio.models.kwargs_types import ValidateKwargs
+
+
+class AdvancedJudge(Propose):
+    """A class that judges the evidence and makes a final decision."""
+    async def evidently_judge(
+        self,
+        prompt: str,
+        **kwargs: Unpack[ValidateKwargs[JudgeMent]],
+    ) -> Optional[JudgeMent]:
+        """Judge the evidence and make a final decision."""
+        return await self.propose(
+            JudgeMent,
+            prompt,
+            **kwargs
+        )
+

{fabricatio-0.2.8.dev0 → fabricatio-0.2.8.dev1}/python/fabricatio/capabilities/rating.py

@@ -16,7 +16,7 @@ from more_itertools import flatten, windowed
 from pydantic import NonNegativeInt, PositiveInt
 
 
-class GiveRating(WithBriefing, LLMUsage):
+class Rating(WithBriefing, LLMUsage):
     """A class that provides functionality to rate tasks based on a rating manual and score range.
 
     References:

{fabricatio-0.2.8.dev0 → fabricatio-0.2.8.dev1}/python/fabricatio/capabilities/review.py

@@ -4,7 +4,7 @@ from typing import Dict, List, Optional, Self, Set, Unpack, cast
 
 from fabricatio._rust_instances import TEMPLATE_MANAGER
 from fabricatio.capabilities.propose import Propose
-from fabricatio.capabilities.rating import GiveRating
+from fabricatio.capabilities.rating import Rating
 from fabricatio.config import configs
 from fabricatio.models.generic import Base, Display, ProposedAble, WithBriefing
 from fabricatio.models.kwargs_types import ReviewKwargs, ValidateKwargs
@@ -175,7 +175,7 @@ class ReviewResult[T](ProposedAble, Display):
         return self
 
 
-class Review(GiveRating, Propose):
+class Review(Rating, Propose):
     """Class that provides functionality to review tasks and strings using a language model.
 
     This class extends GiveRating and Propose capabilities to analyze content,

{fabricatio-0.2.8.dev0 → fabricatio-0.2.8.dev1}/python/fabricatio/models/action.py

@@ -221,7 +221,7 @@ class WorkFlow(WithBriefing, ToolBoxUsage):
         self.provide_tools_to(self._instances)
         return self
 
-    def update_init_context(self, **kwargs) -> Self:
+    def update_init_context(self, /, **kwargs) -> Self:
         """Update the initial context with additional key-value pairs.
 
         Args:

fabricatio-0.2.8.dev1/python/fabricatio/models/extra/advanced_judge.py

@@ -0,0 +1,22 @@
+"""A module containing the JudgeMent class."""
+
+from typing import List
+
+from fabricatio.models.generic import ProposedAble
+
+
+class JudgeMent(ProposedAble):
+    """A class representing a judgment made by a judge."""
+
+    affirm_evidence: List[str]
+    """List of evidence supporting the affirmation."""
+
+    deny_evidence: List[str]
+    """List of evidence supporting the denial."""
+
+    final_judgement: bool
+    """The final judgement."""
+
+    def __bool__(self) -> bool:
+        """Return the final judgement."""
+        return self.final_judgement

{fabricatio-0.2.8.dev0 → fabricatio-0.2.8.dev1}/python/fabricatio/models/extra/article_base.py

@@ -1,12 +1,13 @@
 """A foundation for hierarchical document components with dependency tracking."""
 
-from abc import abstractmethod
+from abc import ABC, abstractmethod
 from enum import StrEnum
 from functools import cache
 from itertools import chain
 from typing import Generator, List, Optional, Self, Tuple
 
 from fabricatio.models.generic import (
+    AsPrompt,
     CensoredAble,
     Display,
     FinalizedDumpAble,
@@ -121,6 +122,24 @@ class ArticleMetaData(CensoredAble, Display):
     """Do not add any prefix or suffix to the title. should not contain special characters."""
 
 
+class ArticleRefPatch(ProposedUpdateAble, Display):
+    """Patch for article refs."""
+
+    tweaked: List[ArticleRef]
+    """Tweaked refs"""
+
+    def update_from_inner(self, other: Self) -> Self:
+        """Updates the current instance with the attributes of another instance."""
+        self.tweaked.clear()
+        self.tweaked.extend(other.tweaked)
+        return self
+
+    @classmethod
+    def default(cls) -> "ArticleRefPatch":
+        """Defaults to empty list."""
+        return cls(tweaked=[])
+
+
 class ArticleOutlineBase(
     ArticleMetaData,
     ResolveUpdateConflict,
@@ -267,7 +286,7 @@ class ChapterBase[T: SectionBase](ArticleOutlineBase):
         return ""
 
 
-class ArticleBase[T: ChapterBase](FinalizedDumpAble):
+class ArticleBase[T: ChapterBase](FinalizedDumpAble, AsPrompt, ABC):
     """Base class for article outlines."""
 
     language: str

{fabricatio-0.2.8.dev0 → fabricatio-0.2.8.dev1}/python/fabricatio/models/extra/article_essence.py

@@ -134,10 +134,10 @@ class Highlightings(BaseModel):
 
 
 class ArticleEssence(ProposedAble, Display, PrepareVectorization):
-    """Semantic fingerprint of academic paper for structured analysis.
+    """ArticleEssence is a structured representation of the core elements of a scientific article."""
 
-    Encodes research artifacts with dual human-machine interpretability.
-    """
+    language: str = Field(...)
+    """Language of the original article."""
 
     title: str = Field(...)
     """Exact title of the original article without any modification.
@@ -149,7 +149,7 @@ class ArticleEssence(ProposedAble, Display, PrepareVectorization):
     """
 
     authors: List[str]
-    """Original author names exactly as they appear in the source document. No translation or paraphrasing.
+    """Original author full names exactly as they appear in the source document. No translation or paraphrasing.
     Extract complete list without any modifications or formatting changes."""
 
     keywords: List[str]
@@ -170,11 +170,7 @@ class ArticleEssence(ProposedAble, Display, PrepareVectorization):
     """Domain tags for research focus."""
 
     abstract: str = Field(...)
-    """Three-paragraph structured abstract:
-    Paragraph 1: Problem & Motivation (2-3 sentences)
-    Paragraph 2: Methodology & Innovations (3-4 sentences)
-    Paragraph 3: Results & Impact (2-3 sentences)
-    Total length: 150-250 words"""
+    """Abstract text with original language."""
 
     core_contributions: List[str]
     """3-5 technical contributions using CRediT taxonomy verbs.
@@ -184,6 +180,7 @@ class ArticleEssence(ProposedAble, Display, PrepareVectorization):
     - 'Established cross-lingual transfer metrics'"""
 
     technical_novelty: List[str]
+
     """Patent-style claims with technical specificity.
     Format: 'A [system/method] comprising [novel components]...'
     Example:

{fabricatio-0.2.8.dev0 → fabricatio-0.2.8.dev1}/python/fabricatio/models/extra/article_main.py

@@ -1,7 +1,7 @@
 """ArticleBase and ArticleSubsection classes for managing hierarchical document components."""
 
 from itertools import chain
-from typing import Generator, List, Self, Tuple, override
+from typing import Dict, Generator, List, Self, Tuple, override
 
 from fabricatio.journal import logger
 from fabricatio.models.extra.article_base import (
@@ -81,6 +81,14 @@ class Article(
     aiming to provide a comprehensive model for academic papers.
     """
 
+    def _as_prompt_inner(self) -> Dict[str, str]:
+        return {
+            "Original Article Briefing": self.referenced.referenced.referenced,
+            "Original Article Proposal": self.referenced.referenced.display(),
+            "Original Article Outline": self.referenced.display(),
+            "Original Article": self.display(),
+        }
+
     @override
     def iter_subsections(self) -> Generator[Tuple[ArticleChapter, ArticleSection, ArticleSubsection], None, None]:
         return super().iter_subsections()

{fabricatio-0.2.8.dev0 → fabricatio-0.2.8.dev1}/python/fabricatio/models/extra/article_outline.py

@@ -1,5 +1,7 @@
 """A module containing the ArticleOutline class, which represents the outline of an academic paper."""
 
+from typing import Dict
+
 from fabricatio.models.extra.article_base import (
     ArticleBase,
     ChapterBase,
@@ -30,3 +32,10 @@ class ArticleOutline(
     ArticleBase[ArticleChapterOutline],
 ):
     """Outline of an academic paper, containing chapters, sections, subsections."""
+
+    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(),
+        }

{fabricatio-0.2.8.dev0 → fabricatio-0.2.8.dev1}/uv.lock

@@ -248,7 +248,7 @@ wheels = [
 
 [[package]]
 name = "fabricatio"
-version = "0.2.8.dev0"
+version = "0.2.8.dev1"
 source = { editable = "." }
 dependencies = [
     { name = "appdirs" },