fabricatio 0.2.8.dev1__cp312-cp312-win_amd64.whl → 0.2.8.dev2__cp312-cp312-win_amd64.whl

fabricatio/_rust.pyi

@@ -122,3 +122,53 @@ class BibManager:
         Returns:
             List of all titles in the bibliography
         """
+
+    def get_author_by_key(self, key: str) -> Optional[List[str]]:
+        """Retrieve authors by citation key.
+
+        Args:
+            key: Citation key
+
+        Returns:
+            List of authors if found, None otherwise
+        """
+
+    def get_year_by_key(self, key: str) -> Optional[int]:
+        """Retrieve the publication year by citation key.
+
+        Args:
+            key: Citation key
+
+        Returns:
+            Publication year if found, None otherwise
+        """
+
+    def get_abstract_by_key(self, key: str) -> Optional[str]:
+        """Retrieve the abstract by citation key.
+
+        Args:
+            key: Citation key
+
+        Returns:
+            Abstract if found, None otherwise
+        """
+    def get_title_by_key(self, key: str) -> Optional[str]:
+        """Retrieve the title by citation key.
+
+        Args:
+            key: Citation key
+
+        Returns:
+            Title if found, None otherwise
+        """
+
+    def get_field_by_key(self, key: str, field: str)-> Optional[str]:
+        """Retrieve a specific field by citation key.
+
+        Args:
+            key: Citation key
+            field: Field name
+
+        Returns:
+            Field value if found, None otherwise
+        """

fabricatio/actions/article.py

@@ -4,6 +4,7 @@ from asyncio import gather
 from pathlib import Path
 from typing import Any, Callable, List, Optional
 
+from fabricatio._rust import BibManager
 from fabricatio.capabilities.advanced_judge import AdvancedJudge
 from fabricatio.fs import safe_text_read
 from fabricatio.journal import logger
@@ -40,11 +41,27 @@ class ExtractArticleEssence(Action):
 
         # trim the references
         contents = ["References".join(c.split("References")[:-1]) for c in map(reader, task_input.dependencies)]
-        return await self.propose(
-            ArticleEssence,
-            contents,
-            system_message=f"# your personal briefing: \n{self.briefing}",
-        )
+        return await self.propose(ArticleEssence, contents, **self.prepend_sys_msg())
+
+
+class FixArticleEssence(Action):
+    """Fix the article essence based on the bibtex key."""
+
+    async def _execute(
+        self,
+        bib_mgr: BibManager,
+        article_essence: List[ArticleEssence],
+        **_,
+    ) -> None:
+        for a in article_essence:
+            if key := (bib_mgr.get_cite_key(a.title) or bib_mgr.get_cite_key_fuzzy(a.title)):
+                a.title = bib_mgr.get_title_by_key(key) or a.title
+                a.authors = bib_mgr.get_author_by_key(key) or a.authors
+                a.publication_year = bib_mgr.get_year_by_key(key) or a.publication_year
+                a.bibtex_cite_key = key
+                logger.info(f'Updated {a.title} with {key}')
+            else:
+                logger.warning(f"No key found for {a.title}")
 
 
 class GenerateArticleProposal(Action):
@@ -108,7 +125,7 @@ class GenerateInitialOutline(Action):
                 **self.prepend_sys_msg(),
             ),
             "Could not generate the initial outline.",
-        )
+        ).update_ref(article_proposal)
 
 
 class FixIntrospectedErrors(Action):
@@ -120,6 +137,7 @@ class FixIntrospectedErrors(Action):
     async def _execute(
         self,
         article_outline: ArticleOutline,
+        supervisor_check: bool = False,
         **_,
     ) -> Optional[ArticleOutline]:
         introspect_manual = ok(
@@ -141,7 +159,7 @@ class FixIntrospectedErrors(Action):
                     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,
+                    supervisor_check=supervisor_check,
                 ),
                 "Could not correct the component.",
             )
@@ -159,6 +177,7 @@ class FixIllegalReferences(Action):
     async def _execute(
         self,
         article_outline: ArticleOutline,
+        supervisor_check: bool = False,
         **_,
     ) -> Optional[ArticleOutline]:
         ref_manual = ok(
@@ -177,10 +196,10 @@ class FixIllegalReferences(Action):
             ok(
                 await self.correct_obj_inplace(
                     ref,
-                    reference=f"# Original Article Outline\n{article_outline.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}",
                     topic=ref_topic,
                     rating_manual=ref_manual,
-                    supervisor_check=False,
+                    supervisor_check=supervisor_check,
                 )
             )
         return article_outline.update_ref(article_outline)
@@ -194,7 +213,7 @@ class TweakOutlineBackwardRef(Action, AdvancedJudge):
 
     output_key: str = "article_outline_bw_ref_checked"
 
-    async def _execute(self, article_outline: ArticleOutline, **cxt) -> ArticleOutline:
+    async def _execute(self, article_outline: ArticleOutline, supervisor_check: bool = False, **cxt) -> ArticleOutline:
         tweak_depend_on_manual = ok(
             await self.draft_rating_manual(
                 topic := "Ensure prerequisites are correctly referenced in the `depend_on` field."
@@ -207,14 +226,15 @@ class TweakOutlineBackwardRef(Action, AdvancedJudge):
                 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
+                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,
+                    supervisor_check=supervisor_check,
                 )
 
         return article_outline
@@ -228,7 +248,7 @@ class TweakOutlineForwardRef(Action, AdvancedJudge):
 
     output_key: str = "article_outline_fw_ref_checked"
 
-    async def _execute(self, article_outline: ArticleOutline, **cxt) -> ArticleOutline:
+    async def _execute(self, article_outline: ArticleOutline, supervisor_check: bool = False, **cxt) -> ArticleOutline:
         tweak_support_to_manual = ok(
             await self.draft_rating_manual(
                 topic := "Ensure conclusions support the analysis of subsequent chapters, sections or subsections."
@@ -241,14 +261,15 @@ class TweakOutlineForwardRef(Action, AdvancedJudge):
                 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
+                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,
+                    supervisor_check=supervisor_check,
                 )
 
         return article_outline
@@ -263,6 +284,7 @@ class GenerateArticle(Action):
     async def _execute(
         self,
         article_outline: ArticleOutline,
+        supervisor_check: bool = False,
         **_,
     ) -> Optional[Article]:
         article: Article = Article.from_outline(ok(article_outline, "Article outline not specified.")).update_ref(
@@ -280,7 +302,7 @@ class GenerateArticle(Action):
                     reference=f"# Original Article Outline\n{article_outline.display()}\n# Error Need to be fixed\n{err}",
                     topic=w_topic,
                     rating_manual=write_para_manual,
-                    supervisor_check=False,
+                    supervisor_check=supervisor_check,
                 )
                 for _, __, subsec in article.iter_subsections()
                 if (err := subsec.introspect())

fabricatio/actions/article_rag.py

@@ -1,35 +1,90 @@
 """A module for writing articles using RAG (Retrieval-Augmented Generation) capabilities."""
 
-from typing import Optional
+from asyncio import gather
+from typing import Dict, Optional
 
 from fabricatio.capabilities.rag import RAG
-from fabricatio.journal import logger
 from fabricatio.models.action import Action
-from fabricatio.models.extra.article_main import Article
-from fabricatio.models.extra.article_outline import ArticleOutline
+from fabricatio.models.extra.article_main import Article, ArticleParagraphPatch, ArticleSubsection
+from fabricatio.models.utils import ok
 
 
-class GenerateArticleRAG(Action, RAG):
+class TweakArticleRAG(Action, RAG):
     """Write an article based on the provided outline."""
 
-    output_key: str = "article"
+    output_key: str = "rag_tweaked_article"
 
-    async def _execute(self, article_outline: ArticleOutline, **cxt) -> Optional[Article]:
+    async def _execute(
+        self,
+        article: Article,
+        collection_name: str = "article_essence",
+        citation_requirement: str = "# Citation Format\n"
+        "Use correct citation format based on author count. Cite using author surnames and year:"
+        "For 3+ authors: 'Author1, Author2 et al. (YYYY)'"
+        "For 2 authors: 'Author1 & Author2 (YYYY)'"
+        "Single author: 'Author1 (YYYY)'"
+        "Multiple citations: 'Author1 (YYYY), Author2 (YYYY)'"
+        "Prioritize formulas from reference highlights."
+        "Specify authors/years only - no numeric citations"
+        "Paragraphs must exceed 2-3 sentences",
+        supervisor_check: bool = False,
+        parallel: bool = False,
+        **cxt,
+    ) -> Optional[Article]:
         """Write an article based on the provided outline."""
-        logger.info(f"Writing an article based on the outline:\n{article_outline.title}")
-        refined_q = await self.arefined_query(article_outline.display())
-        return await self.propose(
-            Article,
-            article_outline.display(),
-            **self.prepend_sys_msg(f"{await self.aretrieve_compact(refined_q)}\n{self.briefing}"),
+        criteria = await self.draft_rating_criteria(
+            topic := "choose appropriate reference to insert into the article, "
+            "making conclusions or reasoning based on concrete evidence instead of unreliable guesses."
+            "Extensively use formulas highlighted in reference文献 should be translated to 'references'."
+            "Only specify authors and years without numeric citation numbers (like [1],[2])."
+            "Each paragraph should not end with just 2-3 sentences for better readability.",
+            criteria_count=13,
         )
 
+        tweak_manual = ok(
+            await self.draft_rating_manual(topic, criteria=criteria, co_extractor={"model": "openai/qwen-max"})
+        )
+        self.view(collection_name)
 
-class WriteArticleFineGrind(Action, RAG):
-    """Fine-grind an article based on the provided outline."""
+        if parallel:
+            await gather(
+                *[
+                    self._inner(article, subsec, supervisor_check, citation_requirement, topic, tweak_manual)
+                    for _, __, subsec in article.iter_subsections()
+                ],
+                return_exceptions=True,
+            )
+        else:
+            for _, __, subsec in article.iter_subsections():
+                await self._inner(article, subsec, supervisor_check, citation_requirement, topic, tweak_manual)
 
-    output_key: str = "article"
+        return article
 
-    async def _execute(self, article_outline: ArticleOutline, **cxt) -> Optional[Article]:
-        """Fine-grind an article based on the provided outline."""
-        logger.info(f"Fine-grinding an article based on the outline:\n{article_outline.title}")
+    async def _inner(
+        self,
+        article: Article,
+        subsec: ArticleSubsection,
+        supervisor_check: bool,
+        citation_requirement: str,
+        topic: str,
+        tweak_manual: Dict[str, str],
+    ) -> None:
+        refind_q = ok(
+            await self.arefined_query(
+                f"{article.referenced.as_prompt()}\n"
+                f"# Subsection requiring reference enhancement\n"
+                f"{subsec.display()}\n"
+                f"# Requirement\n"
+                f"Search related articles in the base to find reference candidates, "
+                f"prioritizing both original article language and English usage",
+            )
+        )
+        patch = ArticleParagraphPatch.default()
+        patch.tweaked = subsec.paragraphs
+        await self.correct_obj_inplace(
+            patch,
+            reference=f"{await self.aretrieve_compact(refind_q, final_limit=50)}\n{citation_requirement}",
+            topic=topic,
+            rating_manual=tweak_manual,
+            supervisor_check=supervisor_check,
+        )

fabricatio/actions/output.py

@@ -1,7 +1,7 @@
 """Dump the finalized output to a file."""
 
 from pathlib import Path
-from typing import Optional
+from typing import Iterable, List, Optional, Type
 
 from fabricatio.journal import logger
 from fabricatio.models.action import Action
@@ -14,6 +14,7 @@ class DumpFinalizedOutput(Action):
     """Dump the finalized output to a file."""
 
     output_key: str = "dump_path"
+    dump_path: Optional[str] = None
 
     async def _execute(
         self,
@@ -24,6 +25,7 @@ class DumpFinalizedOutput(Action):
     ) -> str:
         dump_path = Path(
             dump_path
+            or self.dump_path
             or ok(
                 await self.awhich_pathstr(
                     f"{ok(task_input, 'Neither `task_input` and `dump_path` is provided.').briefing}\n\nExtract a single path of the file, to which I will dump the data."
@@ -39,6 +41,7 @@ class PersistentAll(Action):
     """Persist all the data to a file."""
 
     output_key: str = "persistent_count"
+    persist_dir: Optional[str] = None
 
     async def _execute(
         self,
@@ -48,6 +51,7 @@ class PersistentAll(Action):
     ) -> int:
         persist_dir = Path(
             persist_dir
+            or self.persist_dir
             or ok(
                 await self.awhich_pathstr(
                     f"{ok(task_input, 'Neither `task_input` and `dump_path` is provided.').briefing}\n\nExtract a single path of the file, to which I will persist the data."
@@ -60,10 +64,38 @@ class PersistentAll(Action):
         if persist_dir.is_file():
             logger.warning("Dump should be a directory, but it is a file. Skip dumping.")
             return count
-        persist_dir.mkdir(parents=True, exist_ok=True)
-        for v in cxt.values():
+
+        for k, v in cxt.items():
+            final_dir = persist_dir.joinpath(k)
+            final_dir.mkdir(parents=True, exist_ok=True)
             if isinstance(v, PersistentAble):
-                v.persist(persist_dir)
+                v.persist(final_dir)
                 count += 1
+            if isinstance(v, Iterable) and any(
+                persistent_ables := (pers for pers in v if isinstance(pers, PersistentAble))
+            ):
+                for per in persistent_ables:
+                    per.persist(final_dir)
+                    count += 1
 
         return count
+
+
+class RetrieveFromPersistent[T: PersistentAble](Action):
+    """Retrieve the object from the persistent file."""
+
+    output_key: str = "retrieved_obj"
+    """Retrieve the object from the persistent file."""
+    load_path: str
+    """The path of the persistent file or directory contains multiple file."""
+    retrieve_cls: Type[T]
+    """The class of the object to retrieve."""
+
+    async def _execute(self, /, **__) -> Optional[T | List[T]]:
+        logger.info(f"Retrieve `{self.retrieve_cls.__name__}` from persistent file: {self.load_path}")
+        if not (p := Path(self.load_path)).exists():
+            return None
+
+        if p.is_dir():
+            return [self.retrieve_cls.from_persistent(per) for per in p.glob("*")]
+        return self.retrieve_cls.from_persistent(self.load_path)

fabricatio/fs/curd.py

@@ -145,5 +145,9 @@ def gather_files(directory: str | Path | PathLike, extension: str) -> list[str]:
 
     Returns:
         list[str]: A list of file paths with the specified extension.
+
+    Example:
+        >>> gather_files('/path/to/directory', 'txt')
+        ['/path/to/directory/file1.txt', '/path/to/directory/file2.txt']
     """
     return [file.as_posix() for file in Path(directory).rglob(f"*.{extension}")]

fabricatio/models/action.py

@@ -104,7 +104,7 @@ class WorkFlow(WithBriefing, ToolBoxUsage):
     _instances: Tuple[Action, ...] = PrivateAttr(default_factory=tuple)
     """Instantiated action objects to be executed in this workflow."""
 
-    steps: Tuple[Union[Type[Action], Action], ...] = Field(...)
+    steps: Tuple[Union[Type[Action], Action], ...] = Field(frozen=True,)
     """The sequence of actions to be executed, can be action classes or instances."""
 
     task_input_key: str = Field(default="task_input")
@@ -157,13 +157,14 @@ class WorkFlow(WithBriefing, ToolBoxUsage):
             # Process each action in sequence
             for step in self._instances:
                 current_action = step.name
-                logger.info(f"Executing step: {current_action}")
+                logger.info(f"Executing step >> {current_action}")
 
                 # Get current context and execute action
                 context = await self._context.get()
                 act_task = create_task(step.act(context))
                 # Handle task cancellation
                 if task.is_cancelled():
+                    logger.warning(f"Task cancelled by task: {task.name}")
                     act_task.cancel(f"Cancelled by task: {task.name}")
                     break
 
@@ -171,7 +172,7 @@ class WorkFlow(WithBriefing, ToolBoxUsage):
                 modified_ctx = await act_task
                 logger.success(f"Step execution finished: {current_action}")
                 if step.output_key:
-                    logger.success(f"Setting output: {step.output_key}")
+                    logger.success(f"Setting output to `{step.output_key}`")
                 await self._context.put(modified_ctx)
 
             logger.success(f"Workflow execution finished: {self.name}")
@@ -182,7 +183,7 @@ class WorkFlow(WithBriefing, ToolBoxUsage):
 
             if self.task_output_key not in final_ctx:
                 logger.warning(
-                    f"Task output key: {self.task_output_key} not found in the context, None will be returned. "
+                    f"Task output key: `{self.task_output_key}` not found in the context, None will be returned. "
                     f"You can check if `Action.output_key` is set the same as `WorkFlow.task_output_key`."
                 )
 

fabricatio/models/extra/advanced_judge.py

@@ -1,4 +1,4 @@
-"""A module containing the JudgeMent class."""
+"""Module containing the JudgeMent class for holding judgment results."""
 
 from typing import List
 
@@ -6,7 +6,10 @@ from fabricatio.models.generic import ProposedAble
 
 
 class JudgeMent(ProposedAble):
-    """A class representing a judgment made by a judge."""
+    """Represents a judgment result containing supporting/denying evidence and final verdict.
+
+    The class stores both affirmative and denies evidence lists along with the final boolean judgment.
+    """
 
     affirm_evidence: List[str]
     """List of evidence supporting the affirmation."""
@@ -15,8 +18,12 @@ class JudgeMent(ProposedAble):
     """List of evidence supporting the denial."""
 
     final_judgement: bool
-    """The final judgement."""
+    """The final judgment made according to all extracted evidence."""
 
     def __bool__(self) -> bool:
-        """Return the final judgement."""
+        """Return the final judgment value.
+
+        Returns:
+            bool: The stored final_judgement value indicating the judgment result.
+        """
         return self.final_judgement

fabricatio/models/extra/article_base.py

@@ -122,24 +122,30 @@ 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"""
+class Patch[T](ProposedUpdateAble, Display):
+    """Base class for patches."""
 
+    tweaked: List[T]
+    """Tweaked content list"""
     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":
+    def default(cls) -> Self:
         """Defaults to empty list."""
         return cls(tweaked=[])
 
 
+class ArticleRefPatch(Patch[ArticleRef]):
+    """Patch for article refs."""
+
+
+
+
 class ArticleOutlineBase(
     ArticleMetaData,
     ResolveUpdateConflict,

fabricatio/models/extra/article_essence.py

@@ -1,8 +1,8 @@
 """ArticleEssence: Semantic fingerprint of academic paper for structured analysis."""
 
-from typing import List
+from typing import List, Self
 
-from fabricatio.models.generic import Display, PrepareVectorization, ProposedAble
+from fabricatio.models.generic import Display, PersistentAble, PrepareVectorization, ProposedAble
 from pydantic import BaseModel, Field
 
 
@@ -20,12 +20,49 @@ class Equation(BaseModel):
     Example: "Defines constrained search space dimensionality reduction. Used in architecture optimization phase (Section 3.2). Enables 40% parameter reduction."
     """
 
-    latex_code: str
-    """LaTeX representation following academic typesetting standards:
-    - Must use equation environment (e.g., `equation`, `align`).
-    - Multiline equations must align at '=' using `&`.
-    - Include unit annotations where applicable.
-    Example: "\\begin{equation} \\mathcal{L}_{NAS} = \\alpha \\|\\theta\\|_2 + \\beta H(p) \\end{equation}"
+    typst_code: str
+    r"""The typst code for the equation, including the equation itself and any necessary formatting.
+#let x = 5  // Define a code variable
+
+// Basic syntax examples
+$x^2$  // Inline formula
+$ x^2 $  // Block formula (spaces before/after $ for standalone display)
+
+// Variables and text handling
+$ A = pi r^2 $  // Single-letter variables as-is
+$"area" = pi dot "radius"^2 $  // Multi-letter variables in quotes
+$ cal(A) := { x in RR | x "is natural" } $  // Calligraphic font and text
+$ #x < 17 $  // Access code variables with #
+
+// Symbols and shorthands
+$x < y => x gt.eq.not y $  // Symbol shorthand (=> for ⇒, gt.eq.not for ≯)
+
+// Multi-line equations with alignment
+$ sum_(k=0)^n k
+    &= 1 + ... + n \
+    &= (n(n+1))/2 $  // Multi-line with & alignment
+
+// Function calls and formatting
+$ frac(a^2, 2) $  // Fraction
+$ vec(1, 2, delim: "[") $  // Custom vector delimiter
+$ mat(1, 2; 3, 4) $  // 2D matrix (semicolon separates rows)
+$ mat(..#range(1, 5).chunks(2)) $  // Dynamic matrix with array expansion
+
+// Advanced alignment example
+$ (3x + y)/7 &= 9 && "given" \
+  3x + y    &= 63 & "multiply by 7" \
+  3x        &= 63 - y && "subtract y" \
+  x         &= 21 - y/3 & "divide by 3" $
+// && skips a column alignment (left/right alternation)
+
+// Math font configuration
+#show math.equation: set text(font: "Fira Math")  // Set math font (requires Fira Math installed)
+$ sum_(i in NN) 1 + i $  // Display with new font
+
+// Escaping and special syntax
+$ frac(a\,, b) $  // Escape comma to display as literal
+$ f(x; y) $  // Literal semicolon (not for 2D arrays)
+$ lim_x = op("lim", limits: #true)_x $  // Custom operator with limits
     """
 
 
@@ -133,11 +170,11 @@ class Highlightings(BaseModel):
     """
 
 
-class ArticleEssence(ProposedAble, Display, PrepareVectorization):
-    """ArticleEssence is a structured representation of the core elements of a scientific article."""
+class ArticleEssence(ProposedAble, Display, PersistentAble, PrepareVectorization):
+    """ArticleEssence is a structured representation of the core elements of a scientific article,using its original language."""
 
-    language: str = Field(...)
-    """Language of the original article."""
+    language: str
+    """Language of the original article, note that you should not attempt to translate the original language when generating JSON."""
 
     title: str = Field(...)
     """Exact title of the original article without any modification.
@@ -219,5 +256,13 @@ class ArticleEssence(ProposedAble, Display, PrepareVectorization):
     Example:
     'Predicted 150+ citations via integration into MMEngine (Alibaba OpenMMLab)'"""
 
+    bibtex_cite_key: str
+    """Bibtex cite_key of the original article."""
+
+    def update_cite_key(self, new_cite_key: str) -> Self:
+        """Update the bibtex_cite_key of the article."""
+        self.bibtex_cite_key = new_cite_key
+        return self
+
     def _prepare_vectorization_inner(self) -> str:
         return self.model_dump_json()

fabricatio/models/extra/article_main.py

@@ -8,6 +8,7 @@ from fabricatio.models.extra.article_base import (
     ArticleBase,
     ArticleOutlineBase,
     ChapterBase,
+    Patch,
     SectionBase,
     SubSectionBase,
 )
@@ -31,6 +32,10 @@ class Paragraph(CensoredAble):
     """The actual content of the paragraph, represented as a string."""
 
 
+class ArticleParagraphPatch(Patch[Paragraph]):
+    """Patch for `Paragraph` list of `ArticleSubsection`."""
+
+
 class ArticleSubsection(SubSectionBase):
     """Atomic argumentative unit with technical specificity."""
 

fabricatio/models/extra/article_proposal.py

@@ -29,5 +29,23 @@ class ArticleProposal(CensoredAble, Display, WithRef[str], AsPrompt, PersistentA
     research_aim: List[str]
     """A list of primary research objectives that the paper seeks to achieve."""
 
+    literature_review: List[str]
+    """A list of key references and literature that support the research context and background."""
+
+    expected_outcomes: List[str]
+    """A list of anticipated results or contributions that the research aims to achieve."""
+
+    keywords: List[str]
+    """A list of keywords that represent the main topics and focus areas of the research."""
+
+    abstract: str
+    """A concise summary of the research proposal, outlining the main points and objectives."""
+
+    min_word_count: int
+    """The minimum number of words required for the research proposal."""
+
     def _as_prompt_inner(self) -> Dict[str, str]:
-        return {"ArticleBriefing": self.referenced, "ArticleProposal": self.display()}
+        return {
+            "ArticleBriefing": self.referenced,
+            "ArticleProposal": self.display(),
+        }

fabricatio/models/generic.py

@@ -1,6 +1,7 @@
 """This module defines generic classes for models in the Fabricatio library."""
 
 from abc import ABC, abstractmethod
+from datetime import datetime
 from pathlib import Path
 from typing import Any, Callable, Dict, Iterable, List, Optional, Self, Union, final, overload
 
@@ -93,7 +94,9 @@ class WithRef[T](Base):
     @property
     def referenced(self) -> T:
         """Get the referenced object."""
-        return ok(self._reference, "_reference is None")
+        return ok(
+            self._reference, f"`{self.__class__.__name__}`' s `_reference` field is None. Have you called `update_ref`?"
+        )
 
     def update_ref[S: "WithRef"](self: S, reference: T | S) -> S:  # noqa: PYI019
         """Update the reference of the object."""
@@ -118,17 +121,27 @@ class PersistentAble(Base):
         """
         p = Path(path)
         out = self.model_dump_json(indent=1)
+
+        # Generate a timestamp in the format YYYYMMDD_HHMMSS
+        timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
+
+        # Generate the hash
+        file_hash = blake3_hash(out.encode())[:6]
+
+        # Construct the file name with timestamp and hash
+        file_name = f"{self.__class__.__name__}_{timestamp}_{file_hash}.json"
+
         if p.is_dir():
-            p.joinpath(f"{self.__class__.__name__}_{blake3_hash(out.encode())[:6]}.json").write_text(
-                out, encoding="utf-8"
-            )
-            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()}")
+            p.joinpath(file_name).write_text(out, encoding="utf-8")
+        else:
+            p.mkdir(exist_ok=True, parents=True)
+            p.write_text(out, encoding="utf-8")
+
+        logger.info(f"Persisted `{self.__class__.__name__}` to {p.as_posix()}")
         return self
 
-    def from_persistent(self, path: str | Path) -> Self:
+    @classmethod
+    def from_persistent(cls, path: str | Path) -> Self:
         """Load the object from a file.
 
         Args:
@@ -137,7 +150,7 @@ class PersistentAble(Base):
         Returns:
             Self: The current instance of the object.
         """
-        return self.model_validate_json(Path(path).read_text(encoding="utf-8"))
+        return cls.model_validate_json(Path(path).read_text(encoding="utf-8"))
 
 
 class ModelHash(Base):
@@ -308,7 +321,7 @@ class ProposedAble(CreateJsonObjPrompt, InstantiateFromString):
     """Class that provides a method to propose a JSON object based on the requirement."""
 
 
-class ProposedUpdateAble(PersistentAble, UpdateFrom, ABC):
+class ProposedUpdateAble(ProposedAble, UpdateFrom, ABC):
     """Make the obj can be updated from the proposed obj in place."""
 
 

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

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

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

@@ -1,9 +1,9 @@
-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=eHI4EH5n1nOt6MqQ00b7UWTjIqO8FerNakem_45d5qk,2315
+fabricatio-0.2.8.dev2.dist-info/METADATA,sha256=jSG3EsC4mXSR7vZlV1ZCFmjZ-dAAB6QEWB7sCVsMFaE,5259
+fabricatio-0.2.8.dev2.dist-info/WHEEL,sha256=jABKVkLC9kJr8mi_er5jOqpiQUjARSLXDUIIxDqsS50,96
+fabricatio-0.2.8.dev2.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
+fabricatio/actions/article.py,sha256=FcpNfiKhFOTZ1TE5NJdoNAk_cHndJuB8lZ6_CrpBB7o,13185
+fabricatio/actions/article_rag.py,sha256=UqL7eZR9dDZ5oK7i7vCQcZHA0gmj4Zl-L3dAjnyoWzk,3795
+fabricatio/actions/output.py,sha256=FpHQkY_EO5XnyUxM5bvoAMOBc_ZRuu6E0QMlX3i8SXQ,3629
 fabricatio/actions/rag.py,sha256=QBdzEM8MloM_ahx5pTBZAETm9_631lTe_0ih_he_Iuo,2759
 fabricatio/capabilities/advanced_judge.py,sha256=selB0Gwf1F4gGJlwBiRo6gI4KOUROgh3WnzO3mZFEls,706
 fabricatio/capabilities/correct.py,sha256=2093ggHkY8vQW8fl7VwXC8u39oW1xsfjxDjGoQ5puOA,7269
@@ -15,19 +15,19 @@ fabricatio/capabilities/task.py,sha256=vtS0YOe639vN8iTrkP2WK0AJVCr5N_JAaJuvRGyY2
 fabricatio/config.py,sha256=hUv5XMzOkEw8cQjsVHTpPPix52IKwmxjBsZM6Px3xZI,16915
 fabricatio/core.py,sha256=VQ_JKgUGIy2gZ8xsTBZCdr_IP7wC5aPg0_bsOmjQ588,6458
 fabricatio/decorators.py,sha256=C0Gi7wcXC-0sWITqsSv3JdBGcgVJOlRvOt0FfO0aUsA,7554
-fabricatio/fs/curd.py,sha256=N6l2MncjrFfnXBRtteRouXp5Rjy8EAKC_i29_G-zz98,4618
+fabricatio/fs/curd.py,sha256=p8y0LGKgVDk-CWOlm37E6wg7RK6RCD6denKo-VsW28c,4763
 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=Rt3a9JWVhaoo7AatStzb9Gl45MKRcSeLWcOHJFCqNNM,8883
+fabricatio/models/action.py,sha256=xYuwnDO9T2sKWT8erQTqelW5AICpgOE5Tp6XVpZ4lN8,8976
 fabricatio/models/events.py,sha256=QvlnS8FEELg6KNabcJMeh2GV_y0ZBzKOPphcteKYWYU,4183
-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/advanced_judge.py,sha256=mjJMps65Wfm5uJVREss5ndOqCFLheFdz9rJ9QLg5IvU,910
+fabricatio/models/extra/article_base.py,sha256=zZ2Gn_VssBL8LZ7hJ-id064tE9AW3HHDyqo5J9PBtDc,15891
+fabricatio/models/extra/article_essence.py,sha256=XqnOnNmnWtje0H61UqQZh5h36yTVYjTMqo_KY2wogWg,10806
+fabricatio/models/extra/article_main.py,sha256=402wYN00ymHJDPb7gX5n-MBFPseIGfb8fezBn8NTgkA,8213
 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/extra/article_proposal.py,sha256=L2kPvH1XCCQSNcI1KQU3ULGq7C24Y88ssugX43LgbsE,2043
+fabricatio/models/generic.py,sha256=5ZnnNaVK5hFp8c87NtyX6zBolEauEOeLSUP7PK0CXRo,19648
 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
@@ -41,9 +41,9 @@ fabricatio/toolboxes/fs.py,sha256=l4L1CVxJmjw9Ld2XUpIlWfV0_Fu_2Og6d3E13I-S4aE,73
 fabricatio/toolboxes/__init__.py,sha256=KBJi5OG_pExscdlM7Bnt_UF43j4I3Lv6G71kPVu4KQU,395
 fabricatio/workflows/articles.py,sha256=G5HGRr-DHuYuEcfhFdFAuDvTTJ9aSU_UQ2yYXEjTMtM,1047
 fabricatio/workflows/rag.py,sha256=-YYp2tlE9Vtfgpg6ROpu6QVO8j8yVSPa6yDzlN3qVxs,520
-fabricatio/_rust.pyi,sha256=dGTGV7viu3YAGl1cRKIWrdHPc1hlwk3_hbaDaswxdVo,3831
+fabricatio/_rust.pyi,sha256=1MAPGjFWw2RaxgVNBqOb6wSwxAf6YrcikD51T_K4QWA,5102
 fabricatio/_rust_instances.py,sha256=2GwF8aVfYNemRI2feBzH1CZfBGno-XJJE5imJokGEYw,314
 fabricatio/__init__.py,sha256=SzBYsRhZeL77jLtfJEjmoHOSwHwUGyvMATX6xfndLDM,1135
-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,,
+fabricatio/_rust.cp312-win_amd64.pyd,sha256=44oKDBFbAF02G5WneLn3_UaN9jYSNsJXAlS96_wbPhM,1885696
+fabricatio-0.2.8.dev2.data/scripts/tdown.exe,sha256=YRgDNGlGCqN9QmhcifAM3KHLWzk4e_OVy4jXCsj42s0,3401216
+fabricatio-0.2.8.dev2.dist-info/RECORD,,