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

fabricatio/models/extra/article_base.py

@@ -2,9 +2,8 @@
 
 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 typing import Generator, List, Optional, Self, Tuple, overload
 
 from fabricatio.models.generic import (
     AsPrompt,
@@ -30,7 +29,6 @@ class ReferringType(StrEnum):
 type RefKey = Tuple[str, Optional[str], Optional[str]]
 
 
-@cache
 class ArticleRef(CensoredAble, Display, ProposedUpdateAble):
     """Reference to a specific chapter, section or subsection within the article. You SHALL not refer to an article component that is external and not present within our own article.
 
@@ -122,11 +120,11 @@ 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."""
+class Patch[T](ProposedUpdateAble, Display):
+    """Base class for patches."""
 
-    tweaked: List[ArticleRef]
-    """Tweaked refs"""
+    tweaked: List[T]
+    """Tweaked content list"""
 
     def update_from_inner(self, other: Self) -> Self:
         """Updates the current instance with the attributes of another instance."""
@@ -135,11 +133,15 @@ class ArticleRefPatch(ProposedUpdateAble, Display):
         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,
@@ -334,6 +336,34 @@ class ArticleBase[T: ChapterBase](FinalizedDumpAble, AsPrompt, ABC):
                 yield sec
                 yield from sec.subsections
 
+    def iter_support_on(self, rev: bool = False) -> Generator[ArticleRef, None, None]:
+        """Iterates over all references that the article components support.
+
+        Args:
+            rev (bool): If True, iterate in reverse order.
+
+        Yields:
+            ArticleRef: Each reference that the article components support.
+        """
+        if rev:
+            yield from chain(*[a.support_to for a in self.iter_dfs_rev()])
+            return
+        yield from chain(*[a.support_to for a in self.iter_dfs()])
+
+    def iter_depend_on(self, rev: bool = False) -> Generator[ArticleRef, None, None]:
+        """Iterates over all references that the article components depend on.
+
+        Args:
+            rev (bool): If True, iterate in reverse order.
+
+        Yields:
+            ArticleRef: Each reference that the article components depend on.
+        """
+        if rev:
+            yield from chain(*[a.depend_on for a in self.iter_dfs_rev()])
+            return
+        yield from chain(*[a.depend_on for a in self.iter_dfs()])
+
     def iter_sections(self) -> Generator[Tuple[ChapterBase, SectionBase], None, None]:
         """Iterates through all sections in the article.
 
@@ -363,7 +393,13 @@ class ArticleBase[T: ChapterBase](FinalizedDumpAble, AsPrompt, ABC):
                 return component, summary
         return None
 
-    def find_illegal_ref(self) -> Optional[Tuple[ArticleRef, str]]:
+    @overload
+    def find_illegal_ref(self, gather_identical: bool) -> Optional[Tuple[ArticleRef | List[ArticleRef], str]]: ...
+
+    @overload
+    def find_illegal_ref(self) -> Optional[Tuple[ArticleRef, str]]: ...
+
+    def find_illegal_ref(self, gather_identical: bool = False) -> Optional[Tuple[ArticleRef | List[ArticleRef], str]]:
         """Finds the first illegal component in the outline.
 
         Returns:
@@ -374,8 +410,15 @@ class ArticleBase[T: ChapterBase](FinalizedDumpAble, AsPrompt, ABC):
             for ref in chain(component.depend_on, component.support_to):
                 if not ref.deref(self):
                     summary += f"Invalid internal reference in `{component.__class__.__name__}` titled `{component.title}`, because the referred {ref.referring_type} is not exists within the article, see the original obj dump: {ref.model_dump()}\n"
-                if summary:
+                if summary and not gather_identical:
                     return ref, summary
+                if summary and gather_identical:
+                    return [
+                        identical_ref
+                        for identical_ref in chain(self.iter_depend_on(), self.iter_support_on())
+                        if identical_ref == ref
+                    ], summary
+
         return None
 
     def finalized_dump(self) -> str:

fabricatio/models/extra/article_essence.py

@@ -1,223 +1,99 @@
 """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 pydantic import BaseModel, Field
+from fabricatio.models.generic import Display, PersistentAble, ProposedAble, Vectorizable
+from pydantic import BaseModel
 
 
 class Equation(BaseModel):
-    """Mathematical formalism specification for research contributions.
-
-    Encodes equations with dual representation: semantic meaning and typeset-ready notation.
-    """
+    """Mathematical formalism specification for research contributions."""
 
     description: str
-    """Equation significance structured in three elements:
-    1. Physical/conceptual meaning of the equation.
-    2. Role in technical workflow (e.g., derivation, optimization, or analysis).
-    3. Relationship to the paper's core contribution (e.g., theoretical foundation, empirical validation).
-    Example: "Defines constrained search space dimensionality reduction. Used in architecture optimization phase (Section 3.2). Enables 40% parameter reduction."
+    """Structured significance including:
+    1. Conceptual meaning
+    2. Technical workflow role
+    3. Contribution relationship
     """
 
     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}"
-    """
+    """Typeset-ready notation."""
 
 
 class Figure(BaseModel):
-    """Visual component specification for technical communication.
-
-    Combines graphical assets with structured academic captioning.Extracted from the article provided
-    """
+    """Visual component with academic captioning."""
 
     description: str
-    """Figure interpretation guide containing:
-    1. Key visual elements mapping (e.g., axes, legends, annotations).
-    2. Data representation methodology (e.g., visualization type, statistical measures).
-    3. Connection to research findings (e.g., supports hypothesis, demonstrates performance).
-    Example: "Architecture search space topology (left) vs. convergence curves (right). Demonstrates NAS efficiency gains through constrained search."
+    """Interpretation guide covering:
+    1. Visual element mapping
+    2. Data representation method
+    3. Research connection
     """
 
     figure_caption: str
-    """Complete caption following Nature-style guidelines:
-    1. Brief overview statement (首句总结).
-    2. Technical detail layer (e.g., data sources, experimental conditions).
-    3. Result implication (e.g., key insights, implications for future work).
-    Example: "Figure 3: Differentiable NAS framework. (a) Search space topology with constrained dimensions. (b) Training convergence across language pairs. Dashed lines indicate baseline methods."
+    """Nature-style caption containing:
+    1. Overview statement
+    2. Technical details
+    3. Result implications
     """
 
     figure_serial_number: int
-    """The Image serial number extracted from the Markdown article provided, the path usually in the form of `![](images/1.jpg)`, in this case the serial number is `1`"""
-
-
-class Algorithm(BaseModel):
-    """Algorithm specification for research contributions."""
-
-    title: str
-    """Algorithm title with technical focus descriptor (e.g., 'Gradient Descent Optimization').
-
-    Tip: Do not attempt to translate the original element titles when generating JSON.
-    """
-
-    description: str
-    """Algorithm description with technical focus descriptor:
-    - Includes input/output specifications.
-    - Describes key steps and their purpose.
-    - Explains its role in the research workflow.
-    Example: "Proposed algorithm for neural architecture search. Inputs include search space constraints and training data. Outputs optimized architecture."
-    """
-
-
-class Table(BaseModel):
-    """Table specification for research contributions."""
-
-    title: str
-    """Table title with technical focus descriptor (e.g., 'Comparison of Model Performance Metrics').
-
-    Tip: Do not attempt to translate the original element titles when generating JSON.
-    """
-
-    description: str
-    """Table description with technical focus descriptor:
-    - Includes data source and structure.
-    - Explains key columns/rows and their significance.
-    - Connects to research findings or hypotheses.
-    Example: "Performance metrics for different architectures. Columns represent accuracy, F1-score, and inference time. Highlights efficiency gains of proposed method."
-    """
+    """Image serial number extracted from Markdown path"""
 
 
 class Highlightings(BaseModel):
-    """Technical showcase aggregator for research artifacts.
-
-    Curates core scientific components with machine-parseable annotations.
-    """
+    """Technical component aggregator."""
 
     highlighted_equations: List[Equation]
-    """3-5 pivotal equations representing theoretical contributions:
-    - Each equation must be wrapped in $$ for display math.
-    - Contain at least one novel operator/symbol.
-    - Be referenced in Methods/Results sections.
-    Example: Equation describing proposed loss function.
-    """
-
-    highlighted_algorithms: List[Algorithm]
-    """1-2 key algorithms demonstrating methodological contributions:
-    - Include pseudocode or step-by-step descriptions.
-    - Highlight innovation in computational approach.
-    Example: Algorithm for constrained search space exploration.
-
-    Tip: Do not attempt to translate the original element titles when generating JSON.
-    """
+    """Equations that highlight the article's core contributions"""
 
     highlighted_figures: List[Figure]
-    """4-6 key figures demonstrating:
-    1. Framework overview (1 required).
-    2. Quantitative results (2-3 required).
-    3. Ablation studies (1 optional).
-    Each must appear in Results/Discussion chapters.
-    Example: Figure showing architecture topology and convergence curves.
+    """key figures requiring:
+    1. Framework overview
+    2. Quantitative results
     """
 
-    highlighted_tables: List[Table]
-    """2-3 key tables summarizing:
-    - Comparative analysis of methods.
-    - Empirical results supporting claims.
-    Example: Table comparing model performance across datasets.
 
-    Tip: Do not attempt to translate the original element titles when generating JSON.
-    """
-
-
-class ArticleEssence(ProposedAble, Display, PrepareVectorization):
-    """ArticleEssence is a structured representation of the core elements of a scientific article."""
+class ArticleEssence(ProposedAble, Display, PersistentAble, Vectorizable):
+    """Structured representation of a scientific article's core elements in its original language."""
 
-    language: str = Field(...)
+    language: str
     """Language of the original article."""
 
-    title: str = Field(...)
-    """Exact title of the original article without any modification.
-    Must be preserved precisely from the source material without:
-    - Translation
-    - Paraphrasing
-    - Adding/removing words
-    - Altering style or formatting
-    """
+    title: str
+    """Exact title of the original article."""
 
     authors: List[str]
-    """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."""
+    """Original author full names as they appear in the source document."""
 
     keywords: List[str]
-    """Original keywords exactly as they appear in the source document. No translation or paraphrasing.
-    Extract the complete set without modifying format or terminology."""
+    """Original keywords as they appear in the source document."""
 
     publication_year: int
-    """Publication timestamp in ISO 8601 (YYYY format)."""
+    """Publication year in ISO 8601 (YYYY format)."""
 
     highlightings: Highlightings
-    """Technical highlight reel containing:
-    - Core equations (Theory)
-    - Key algorithms (Implementation)
-    - Critical figures (Results)
-    - Benchmark tables (Evaluation)"""
+    """Technical highlights including equations, algorithms, figures, and tables."""
 
-    domain: List[str]
-    """Domain tags for research focus."""
-
-    abstract: str = Field(...)
-    """Abstract text with original language."""
+    abstract: str
+    """Abstract text in the original language."""
 
     core_contributions: List[str]
-    """3-5 technical contributions using CRediT taxonomy verbs.
-    Each item starts with action verb.
-    Example:
-    - 'Developed constrained NAS framework'
-    - 'Established cross-lingual transfer metrics'"""
+    """Technical contributions using CRediT taxonomy verbs."""
 
     technical_novelty: List[str]
-
-    """Patent-style claims with technical specificity.
-    Format: 'A [system/method] comprising [novel components]...'
-    Example:
-    'A neural architecture search system comprising:
-     a differentiable constrained search space;
-     multi-lingual transferability predictors...'"""
+    """Patent-style claims with technical specificity."""
 
     research_problems: List[str]
-    """Problem statements as how/why questions.
-    Example:
-    - 'How to reduce NAS computational overhead while maintaining search diversity?'
-    - 'Why do existing architectures fail in low-resource cross-lingual transfer?'"""
+    """Problem statements as how/why questions."""
 
     limitations: List[str]
-    """Technical limitations analysis containing:
-    1. Constraint source (data/method/theory)
-    2. Impact quantification
-    3. Mitigation pathway
-    Example:
-    'Methodology constraint: Single-objective optimization (affects 5% edge cases),
-    mitigated through future multi-task extension'"""
-
-    future_work: List[str]
-    """Research roadmap items with 3 horizons:
-    1. Immediate extensions (1 year)
-    2. Mid-term directions (2-3 years)
-    3. Long-term vision (5+ years)
-    Example:
-    'Short-term: Adapt framework for vision transformers (ongoing with CVPR submission)'"""
-
-    impact_analysis: List[str]
-    """Bibliometric impact projections:
-    - Expected citation counts (next 3 years)
-    - Target application domains
-    - Standard adoption potential
-    Example:
-    'Predicted 150+ citations via integration into MMEngine (Alibaba OpenMMLab)'"""
-
-    def _prepare_vectorization_inner(self) -> str:
-        return self.model_dump_json()
+    """Technical limitations analysis."""
+
+    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

fabricatio/models/extra/article_main.py

@@ -8,6 +8,7 @@ from fabricatio.models.extra.article_base import (
     ArticleBase,
     ArticleOutlineBase,
     ChapterBase,
+    Patch,
     SectionBase,
     SubSectionBase,
 )
@@ -15,7 +16,7 @@ from fabricatio.models.extra.article_outline import (
     ArticleOutline,
 )
 from fabricatio.models.generic import CensoredAble, Display, PersistentAble, WithRef
-from fabricatio.models.utils import ok
+from fabricatio.utils import ok
 
 
 class Paragraph(CensoredAble):
@@ -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/extra/problem.py

@@ -0,0 +1,120 @@
+"""A class representing a problem-solution pair identified during a review process."""
+
+from typing import List, Literal, Self
+
+from fabricatio.models.generic import Display, ProposedAble, ProposedUpdateAble, WithBriefing
+from fabricatio.utils import ask_edit
+from questionary import Choice, checkbox, text
+from rich import print as r_print
+
+
+class Problem(ProposedAble, WithBriefing, Display):
+    """Represents a problem identified during review."""
+
+    description: str
+    """Description of the problem, The """
+
+    severity: Literal["low", "medium", "high"]
+    """Severity level of the problem."""
+
+    category: str
+    """Category of the problem."""
+
+    location: str
+    """Location where the problem was identified."""
+
+    recommendation: str
+    """Recommended solution or action."""
+
+
+class Solution(ProposedAble, WithBriefing, Display):
+    """Represents a proposed solution to a problem."""
+
+    operation: str
+    """Description or identifier of the operation."""
+
+    feasibility: Literal["low", "medium", "high"]
+    """Feasibility level of the solution."""
+
+    impact: Literal["low", "medium", "high"]
+    """Impact level of the solution."""
+
+
+class ProblemSolutions(ProposedUpdateAble):
+    """Represents a problem-solution pair identified during a review process."""
+
+    problem: Problem
+    """The problem identified in the review."""
+    solutions: List[Solution]
+    """A collection of potential solutions."""
+
+    def update_from_inner(self, other: Self) -> Self:
+        """Update the current instance with another instance's attributes."""
+        self.solutions.clear()
+        self.solutions.extend(other.solutions)
+        return self
+
+    def update_problem(self, problem: Problem) -> Self:
+        """Update the problem description."""
+        self.problem = problem
+        return self
+
+    def update_solutions(self, solutions: List[Solution]) -> Self:
+        """Update the list of potential solutions."""
+        self.solutions = solutions
+        return self
+
+    async def edit_problem(self) -> Self:
+        """Interactively edit the problem description."""
+        self.problem = Problem.model_validate_strings(
+            await text("Please edit the problem below:", default=self.problem.display()).ask_async()
+        )
+        return self
+
+    async def edit_solutions(self) -> Self:
+        """Interactively edit the list of potential solutions."""
+        r_print(self.problem.display())
+        string_seq = await ask_edit([s.display() for s in self.solutions])
+        self.solutions = [Solution.model_validate_strings(s) for s in string_seq]
+        return self
+
+
+class Improvement(ProposedAble, Display):
+    """A class representing an improvement suggestion."""
+
+    problem_solutions: List[ProblemSolutions]
+    """Collection of problems identified during review along with their potential solutions."""
+
+    async def supervisor_check(self, check_solutions: bool = True) -> Self:
+        """Perform an interactive review session to filter problems and solutions.
+
+        Presents an interactive prompt allowing a supervisor to select which
+        problems (and optionally solutions) should be retained in the final review.
+
+        Args:
+            check_solutions (bool, optional): When True, also prompts for filtering
+                individual solutions for each retained problem. Defaults to False.
+
+        Returns:
+            Self: The current instance with filtered problems and solutions.
+        """
+        # Choose the problems to retain
+        chosen_ones: List[ProblemSolutions] = await checkbox(
+            "Please choose the problems you want to retain.(Default: retain all)",
+            choices=[Choice(p.problem.name, p, checked=True) for p in self.problem_solutions],
+        ).ask_async()
+        self.problem_solutions = [await p.edit_problem() for p in chosen_ones]
+        if not check_solutions:
+            return self
+
+        # Choose the solutions to retain
+        for to_exam in self.problem_solutions:
+            to_exam.update_solutions(
+                await checkbox(
+                    f"Please choose the solutions you want to retain.(Default: retain all)\n\t`{to_exam.problem}`",
+                    choices=[Choice(s.name, s, checked=True) for s in to_exam.solutions],
+                ).ask_async()
+            )
+            await to_exam.edit_solutions()
+
+        return self

fabricatio/models/extra/rule.py

@@ -0,0 +1,23 @@
+"""A module containing classes related to rule sets and rules."""
+
+from typing import List
+
+from fabricatio.models.generic import Described, Display, PersistentAble, ProposedAble, WithBriefing
+
+
+class Rule(WithBriefing,ProposedAble,Display):
+    """Represents a rule or guideline for a specific topic."""
+
+    violation_examples: List[str]
+    """Examples of violations of the rule."""
+    compliance_examples: List[str]
+    """Examples of how to comply with the rule."""
+
+
+class RuleSet(ProposedAble, Display, PersistentAble, Described):
+    """Represents a collection of rules and guidelines for a particular topic."""
+
+    title: str
+    """The title of the rule set."""
+    rules: List[Rule]
+    """The rules and guidelines contained in the rule set."""