fabricatio 0.2.6.dev5__tar.gz → 0.2.6.dev6__tar.gz

{fabricatio-0.2.6.dev5 → fabricatio-0.2.6.dev6}/PKG-INFO

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

{fabricatio-0.2.6.dev5 → fabricatio-0.2.6.dev6}/examples/extract_and_review/extract_and_review.py

@@ -2,12 +2,15 @@
 
 import asyncio
 from pathlib import Path
-from typing import List
+from typing import TYPE_CHECKING, List
 
-from fabricatio import ArticleEssence, Event, Role, Task, WorkFlow, logger
+from fabricatio import Event, Role, Task, WorkFlow, logger
 from fabricatio.actions.article import ExtractArticleEssence
 from fabricatio.fs.curd import dump_text, gather_files
 
+if TYPE_CHECKING:
+    from fabricatio.models.extra import ArticleEssence
+
 
 async def main() -> None:
     """Main function."""

{fabricatio-0.2.6.dev5 → fabricatio-0.2.6.dev6}/examples/extract_article/extract.py

@@ -1,11 +1,14 @@
 """Example of proposing a task to a role."""
 
 import asyncio
-from typing import List
+from typing import TYPE_CHECKING, List
 
-from fabricatio import ArticleEssence, Event, Role, Task, WorkFlow, logger
+from fabricatio import Event, Role, Task, WorkFlow, logger
 from fabricatio.actions.article import ExtractArticleEssence
 
+if TYPE_CHECKING:
+    from fabricatio.models.extra import ArticleEssence
+
 
 async def main() -> None:
     """Main function."""

{fabricatio-0.2.6.dev5 → fabricatio-0.2.6.dev6}/pyproject.toml

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

{fabricatio-0.2.6.dev5 → fabricatio-0.2.6.dev6}/python/fabricatio/actions/article.py

@@ -93,10 +93,11 @@ class CorrectProposal(Action):
             f"{task_input.briefing}\nExtract the path of file, which contains the article briefing that I need to read."
         )
 
-        rprint(article_proposal.display())
         ret = None
         while await confirm("Do you want to correct the Proposal?").ask_async():
-            topic = await text("What is the topic of the proposal?").ask_async()
+            rprint(article_proposal.display())
+            while not (topic := await text("What is the topic of the proposal reviewing?").ask_async()):
+                ...
             ret = await self.correct_obj(
                 article_proposal,
                 safe_text_read(input_path),
@@ -115,11 +116,13 @@ class CorrectOutline(Action):
         self,
         article_outline: ArticleOutline,
         article_proposal: ArticleProposal,
+
         **_,
     ) -> Optional[str]:
-        rprint(article_outline.finalized_dump())
         ret = None
         while await confirm("Do you want to correct the outline?").ask_async():
-            topic = await text("What is the topic of the outline?").ask_async()
+            rprint(article_outline.finalized_dump())
+            while not (topic := await text("What is the topic of the outline reviewing?").ask_async()):
+                ...
             ret = await self.correct_obj(article_outline, article_proposal.display(), topic=topic)
         return ret or article_outline

{fabricatio-0.2.6.dev5 → fabricatio-0.2.6.dev6}/python/fabricatio/capabilities/rag.py

@@ -21,7 +21,7 @@ from fabricatio.models.kwargs_types import (
     LLMKwargs,
 )
 from fabricatio.models.usages import EmbeddingUsage
-from fabricatio.models.utils import MilvusData
+from fabricatio.models.utils import MilvusData, ok
 from more_itertools.recipes import flatten, unique
 from pydantic import Field, PrivateAttr
 
@@ -60,7 +60,7 @@ class RAG(EmbeddingUsage):
     ) -> Self:
         """Initialize the Milvus client."""
         self._client = create_client(
-            uri=milvus_uri or (self.milvus_uri or configs.rag.milvus_uri).unicode_string(),
+            uri=milvus_uri or ok(self.milvus_uri or configs.rag.milvus_uri).unicode_string(),
             token=milvus_token
             or (token.get_secret_value() if (token := (self.milvus_token or configs.rag.milvus_token)) else ""),
             timeout=milvus_timeout or self.milvus_timeout,
@@ -315,7 +315,7 @@ class RAG(EmbeddingUsage):
             **kwargs,
         )
 
-    async def arefined_query(self, question: List[str] | str, **kwargs: Unpack[ChooseKwargs]) -> List[str]:
+    async def arefined_query(self, question: List[str] | str, **kwargs: Unpack[ChooseKwargs]) -> Optional[List[str]]:
         """Refines the given question using a template.
 
         Args:

{fabricatio-0.2.6.dev5 → fabricatio-0.2.6.dev6}/python/fabricatio/config.py

@@ -66,7 +66,7 @@ class LLMConfig(BaseModel):
     temperature: Optional[NonNegativeFloat] = Field(default=1.0)
     """The temperature of the LLM model. Controls randomness in generation. Set to 1.0 as per request."""
 
-    stop_sign: Optional[str | List[str]] = Field(default="")
+    stop_sign: Optional[str | List[str]] = Field(default=None)
     """The stop sign of the LLM model. No default stop sign specified."""
 
     top_p: Optional[NonNegativeFloat] = Field(default=0.35)
@@ -78,7 +78,7 @@ class LLMConfig(BaseModel):
     stream: Optional[bool] = Field(default=False)
     """Whether to stream the LLM model's response. Default is False."""
 
-    max_tokens: Optional[PositiveInt] = Field(default=8192)
+    max_tokens: Optional[PositiveInt] = Field(default=None)
     """The maximum number of tokens to generate. Set to 8192 as per request."""
 
     rpm: Optional[PositiveInt] = Field(default=100)
@@ -148,13 +148,13 @@ class DebugConfig(BaseModel):
     log_level: Literal["DEBUG", "INFO", "SUCCESS", "WARNING", "ERROR", "CRITICAL"] = Field(default="INFO")
     """The log level of the application."""
 
-    log_file: FilePath = Field(default=Path(rf"{ROAMING_DIR}\fabricatio.log"))
+    log_file: FilePath = Field(default=Path(rf"{ROAMING_DIR}\fabricatio.log"), frozen=True)
     """The log file of the application."""
 
-    rotation: int = Field(default=1)
+    rotation: int = Field(default=1, frozen=True)
     """The rotation of the log file. in weeks."""
 
-    retention: int = Field(default=2)
+    retention: int = Field(default=2, frozen=True)
     """The retention of the log file. in weeks."""
 
     streaming_visible: bool = Field(default=False)

{fabricatio-0.2.6.dev5 → fabricatio-0.2.6.dev6}/python/fabricatio/models/action.py

@@ -10,7 +10,6 @@ from asyncio import Queue, create_task
 from typing import Any, Dict, Self, Tuple, Type, Union, final
 
 from fabricatio.capabilities.correct import Correct
-from fabricatio.capabilities.covalidate import CoValidate
 from fabricatio.capabilities.task import HandleTask, ProposeTask
 from fabricatio.journal import logger
 from fabricatio.models.generic import WithBriefing
@@ -19,7 +18,7 @@ from fabricatio.models.usages import ToolBoxUsage
 from pydantic import Field, PrivateAttr
 
 
-class Action(HandleTask, ProposeTask, Correct, CoValidate):
+class Action(HandleTask, ProposeTask, Correct):
     """Class that represents an action to be executed in a workflow.
 
     Actions are the atomic units of work in a workflow. Each action performs

fabricatio-0.2.6.dev6/python/fabricatio/models/extra.py

@@ -0,0 +1,339 @@
+"""Extra models for built-in actions."""
+
+from typing import List
+
+from fabricatio.models.generic import Base, Display, FinalizedDumpAble, PrepareVectorization, ProposedAble
+from pydantic import Field
+
+
+class Equation(Base):
+    """Mathematical formalism specification for research contributions.
+
+    Encodes equations with dual representation: semantic meaning and typeset-ready notation.
+    """
+
+    description: str
+    """Equation significance structured in three elements:
+    1. Physical/conceptual meaning
+    2. Role in technical workflow
+    3. Relationship to paper's core contribution
+    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
+    - Multiline equations aligned at '='
+    - Unit annotations where applicable
+    Example: r'\begin{equation} \\mathcal{L}_{NAS} = \alpha \\|\theta\\|_2 + \beta H(p) \\end{equation}'"""
+
+
+class Figure(Base):
+    """Visual component specification for technical communication.
+
+    Combines graphical assets with structured academic captioning.
+    """
+
+    description: str
+    """Figure interpretation guide containing:
+    1. Key visual elements mapping
+    2. Data representation methodology
+    3. Connection to research findings
+    Example: 'Architecture search space topology (left) vs. convergence curves (right). Demonstrates NAS efficiency gains through constrained search.'"""
+
+    figure_caption: str
+    """Complete caption following Nature-style guidelines:
+    1. Brief overview statement (首句总结)
+    2. Technical detail layer
+    3. Result implication
+    Example: 'Figure 3: Differentiable NAS framework. (a) Search space topology with constrained dimensions. (b) Training convergence across language pairs. Dashed lines indicate baseline methods.'"""
+
+    figure_path: str
+    """Filesystem path to high-resolution vector graphic (PDF/EPS/SVG).
+    Strict validation requirements:
+    - Absolute path under /assets/figures/
+    - Naming convention: fig[chapter]-[section]_[description].pdf
+    Example: '/assets/figures/fig3-2_nas_convergence.pdf'"""
+
+
+class Highlightings(Base):
+    """Technical showcase aggregator for research artifacts.
+
+    Curates core scientific components with machine-parseable annotations.
+    """
+
+    highlighted_equations: List[Equation] = Field(default_factory=list)
+    """3-5 pivotal equations representing theoretical contributions.
+    Each must:
+    - Use $$ wrapping for display math
+    - Contain at least one novel operator/symbol
+    - Reference in Methods/Results sections
+    Example: Equation describing proposed loss function"""
+
+    highlighted_algorithms: List[str] = Field(default_factory=list)
+    """Algorithm pseudocode following ACM style:
+    1. Numbered steps with bold keywords
+    2. Complexity analysis subsection
+    3. Novel components marked with ※
+    Example:
+    'Algorithm 1: Constrained NAS
+    1. Initialize search space with §3.1 constraints ※
+    2. While not converged:
+        a. Compute gradient ▽θ
+        b. Update architecture parameters...'"""
+
+    highlighted_figures: List[Figure] = Field(default_factory=list)
+    """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."""
+
+    highlighted_tables: List[str] = Field(default_factory=list)
+    """Critical data presentations using booktabs format:
+    - Minimum 3 comparison baselines
+    - Statistical significance markers (*/†/‡)
+    - Standard deviation in parentheses
+    Example:
+    \begin{tabular}{lcc}
+    \toprule
+    Method & BLEU & Δ Params \\
+    \\midrule
+    Ours & 32.4 & -41\\%† \\
+    \bottomrule
+    \\end{tabular}"""
+
+
+class ArticleEssence(ProposedAble, Display, PrepareVectorization):
+    """Semantic fingerprint of academic paper for structured analysis.
+
+    Encodes research artifacts with dual human-machine interpretability.
+    """
+
+    title: str = Field(...)
+    """Complete title with technical specificity (12-18 words).
+    Must contain:
+    1. Methodology focus
+    2. Application domain
+    3. Performance metric
+    Example: 'EfficientViT: Multi-Scale Linear Attention for High-Resolution Dense Prediction'"""
+
+    authors: List[str]
+    """Author list with institutional annotations.
+    Format: [First Last¹, First Last²]
+    Superscripts mapping to affiliations.
+    Example: ['Yuanhao Zhou¹', 'Lei Chen²']"""
+
+    keywords: List[str]
+    """5-8 ACM CCS concepts in camel case.
+    Example: ['Computing methodologies~Neural networks', 'Hardware~Emerging technologies']"""
+
+    publication_year: int
+    """Publication timestamp in ISO 8601 (YYYY format).
+    Constraint: 2017 ≤ year ≤ current_year"""
+
+    highlightings: Highlightings = Field(default_factory=Highlightings)
+    """Technical highlight reel containing:
+    - Core equations (Theory)
+    - Key algorithms (Implementation)
+    - Critical figures (Results)
+    - Benchmark tables (Evaluation)"""
+
+    domain: List[str]
+    """Primary research domains from ACM CCS 2023 taxonomy.
+    Exactly 2-3 categories required.
+    Example: ['Computing methodologies → Machine learning']"""
+
+    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"""
+
+    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_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...'"""
+
+    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?'"""
+
+    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()
+
+
+class ArticleProposal(ProposedAble, Display):
+    """Structured proposal for academic paper development with core research elements.
+
+    Guides LLM in generating comprehensive research proposals with clearly defined components.
+    """
+
+    title: str = Field(...)
+    """Paper title in academic style (Title Case, 8-15 words). Example: 'Exploring Neural Architecture Search for Low-Resource Machine Translation'"""
+
+    focused_problem: List[str] = Field(default_factory=list)
+    """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']"""
+
+    research_aim: List[str] = Field(default_factory=list)
+    """Primary research objectives (list of 2-4 measurable goals).
+    Example: ['Develop parameter-efficient NAS framework', 'Establish cross-lingual architecture transfer metrics']"""
+
+    research_methods: List[str] = Field(default_factory=list)
+    """Methodological components (list of techniques/tools).
+    Example: ['Differentiable architecture search', 'Transformer-based search space', 'Multi-lingual perplexity evaluation']"""
+
+
+class ArticleSubsectionOutline(Base):
+    """Atomic content unit within academic paper sections.
+
+    Provides structured content specification for LLM-generated subsections.
+    """
+
+    title: str = Field(...)
+    """Subsection title reflecting specific content focus (Title Case, 3-8 words).
+    Example: 'Differentiable Search Space Design'"""
+
+    description: str = Field(...)
+    """Content specification with three required elements:
+    1. Core technical content
+    2. Structural purpose in section
+    3. Research significance
+    Example: 'Introduces continuous relaxation method for search space, enabling gradient-based optimization. Forms technical foundation for Section 3. Critical for reducing search complexity.'"""
+
+
+class ArticleSectionOutline(Base):
+    """Primary organizational unit within paper chapters.
+
+    Defines section-level structure with nested subsections for hierarchical content organization.
+    """
+
+    title: str = Field(...)
+    """Section title indicating methodological phase or conceptual component (Title Case).
+    Example: 'Architecture Search Methodology'"""
+
+    description: str = Field(...)
+    """Functional description covering:
+    1. Section's research stage
+    2. Key contributions
+    3. Flow relationship with adjacent sections
+    Example: 'Presents core NAS framework building on literature from Section 2. Introduces novel constrained search space. Leads to implementation details in Section 4.'"""
+
+    subsections: List[ArticleSubsectionOutline]
+    """Ordered sequence of 3-5 subsections implementing IMRaD structure within section. Maintains logical flow from problem statement to technical solution."""
+
+
+class ArticleChapterOutline(Base):
+    """Macro-level paper organization unit.
+
+    Represents major paper divisions (Introduction, Methodology, etc.) with hierarchical section structure.
+    """
+
+    title: str = Field(...)
+    """Chapter title reflecting standard academic sections (Title Case).
+    Example: 'Experimental Evaluation', 'Theoretical Framework'"""
+
+    description: str = Field(...)
+    """Chapter role specification containing:
+    1. Research phase covered
+    2. Chapter-specific objectives
+    3. Relationship to overall paper thesis
+    Example: 'Validates NAS framework through multilingual experiments. Demonstrates method effectiveness across 10 language pairs. Supports core thesis of parameter-efficient architecture search.'"""
+
+    sections: List[ArticleSectionOutline]
+    """3-5 sections implementing chapter's main function. Ordered to maintain academic paper logic:
+    Introduction → Related Work → Methods → Experiments → Analysis"""
+
+
+class ArticleOutline(ProposedAble, Display, FinalizedDumpAble):
+    """Complete hierarchical structure for academic paper generation.
+
+    Provides multi-level outline specification for LLM-based paper drafting with strict academic conventions.
+    """
+
+    title: str = Field(...)
+    """Full paper title with technical specificity (Title Case, 12-18 words).
+    Example: 'Parameter-Efficient Neural Architecture Search for Low-Resource Machine Translation: A Cross-Lingual Transfer Approach'"""
+
+    prospect: str = Field(...)
+    """Unified problem-solution statement combining:
+    1. Core research gap
+    2. Proposed methodology
+    3. Expected contribution
+    Example: 'Addressing NAS computational barriers in low-resource NLP through differentiable constrained search spaces and cross-lingual transfer metrics, enabling efficient architecture discovery for 50+ languages.'"""
+
+    chapters: List[ArticleChapterOutline]
+    """Standard academic structure (5-8 chapters):
+    1. Introduction
+    2. Related Work
+    3. Methodology
+    4. Experiments
+    5. Results
+    6. Discussion
+    7. Conclusion
+    Maintains IMRaD logical flow with clear inter-chapter transitions."""
+
+    def finalized_dump(self) -> str:
+        """Generates standardized hierarchical markup for paper drafting systems.
+
+        Returns:
+            str: Multi-level outline using academic markup conventions:
+            = Chapter Title
+            == Section Title
+            === Subsection Title
+            ==== Subsubsection Title (if needed)
+
+        Example:
+            = Methodology
+            == Neural Architecture Search Framework
+            === Differentiable Search Space
+            === Constrained Optimization Approach
+        """
+        lines: List[str] = []
+
+        for chapter in self.chapters:
+            lines.append(f"= {chapter.title}")
+            for section in chapter.sections:
+                lines.append(f"== {section.title}")
+                for subsection in section.subsections:
+                    lines.append(f"=== {subsection.title}")
+
+        return "\n\n".join(lines)

{fabricatio-0.2.6.dev5 → fabricatio-0.2.6.dev6}/python/fabricatio/models/kwargs_types.py

@@ -81,6 +81,7 @@ class ValidateKwargs[T](GenerateKwargs, total=False):
 
     default: T
     max_validations: int
+    co_extractor: GenerateKwargs
 
 
 # noinspection PyTypedDict

{fabricatio-0.2.6.dev5 → fabricatio-0.2.6.dev6}/python/fabricatio/models/role.py

@@ -3,7 +3,6 @@
 from typing import Any, Self, Set
 
 from fabricatio.capabilities.correct import Correct
-from fabricatio.capabilities.covalidate import CoValidate
 from fabricatio.capabilities.task import HandleTask, ProposeTask
 from fabricatio.core import env
 from fabricatio.journal import logger
@@ -13,7 +12,7 @@ from fabricatio.models.tool import ToolBox
 from pydantic import Field
 
 
-class Role(ProposeTask, HandleTask, Correct, CoValidate):
+class Role(ProposeTask, HandleTask, Correct):
     """Class that represents a role with a registry of events and workflows.
 
     A Role serves as a container for workflows, managing their registration to events