Conversation
WalkthroughThe documentation for the Draive framework was extensively revised and expanded. The setup instructions were clarified to specify activating the virtual environment before managing dependencies. The architecture section was rewritten to provide detailed explanations of Draive’s design principles, core components, and features, including state management and dependency injection. New sections describe integrations, functionalities, parameters, utilities, and helpers. The code style guidelines were broadened to cover import conventions, type usage, and exception handling. Testing practices were outlined, recommending pytest and mocking strategies. Numerous code examples were added to illustrate state management, resource handling, and testing patterns. No code or public API changes were made. Possibly related PRs
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 4
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
CLAUDE.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: miquido/draive#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-24T08:26:33.028Z
Learning: The draive framework is a Python framework for LLM applications built on haiway for state management, emphasizing immutable State objects and dependency injection via context (ctx).
Learnt from: KaQuMiQ
PR: miquido/draive#338
File: src/draive/lmm/__init__.py:1-2
Timestamp: 2025-06-16T10:28:07.434Z
Learning: The draive project requires Python 3.12+ as specified in pyproject.toml with "requires-python = ">=3.12"" and uses Python 3.12+ specific features like PEP 695 type aliases and generic syntax extensively throughout the codebase.
Learnt from: KaQuMiQ
PR: miquido/draive#327
File: src/draive/helpers/instruction_preparation.py:28-34
Timestamp: 2025-05-28T17:41:57.460Z
Learning: The draive project uses and requires Python 3.12+, so PEP-695 generic syntax with square brackets (e.g., `def func[T: Type]()`) is valid and should be used instead of the older TypeVar approach.
CLAUDE.md (5)
Learnt from: CR
PR: miquido/draive#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-24T08:26:33.028Z
Learning: The draive framework is a Python framework for LLM applications built on haiway for state management, emphasizing immutable State objects and dependency injection via context (ctx).
Learnt from: CR
PR: miquido/draive#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-24T08:26:33.028Z
Learning: Entry points for the framework include: simple generation via TextGeneration.generate() and ModelGeneration.generate(), tool integration via the @tool decorator, complex workflows via Stage composition and Agent systems, and setup via context managers with provider configs.
Learnt from: KaQuMiQ
PR: miquido/draive#338
File: src/draive/lmm/__init__.py:1-2
Timestamp: 2025-06-16T10:28:07.434Z
Learning: The draive project requires Python 3.12+ as specified in pyproject.toml with "requires-python = ">=3.12"" and uses Python 3.12+ specific features like PEP 695 type aliases and generic syntax extensively throughout the codebase.
Learnt from: KaQuMiQ
PR: miquido/draive#327
File: src/draive/helpers/instruction_preparation.py:28-34
Timestamp: 2025-05-28T17:41:57.460Z
Learning: The draive project uses and requires Python 3.12+, so PEP-695 generic syntax with square brackets (e.g., `def func[T: Type]()`) is valid and should be used instead of the older TypeVar approach.
Learnt from: CR
PR: miquido/draive#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-24T08:26:33.028Z
Learning: Key architectural patterns include: immutable state (all state objects are frozen), context scoping (configuration flows through execution contexts), async-first design, composability (small focused components combine into complex workflows), and type safety (heavy use of generics and protocols).
🪛 LanguageTool
CLAUDE.md
[uncategorized] ~32-~32: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...I, VLLM - Functionalities: High and low level interfaces and implementations of appli...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 markdownlint-cli2 (0.17.2)
CLAUDE.md
12-12: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
13-13: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
56-56: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
CLAUDE.md (1)
57-60: Still missing blank line before the bullet list (MD032)The list immediately follows the bold paragraph without an empty line, so markdown-lint keeps flagging it.
Insert a blank line before the first bullet.**ALWAYS use these types for collections in State, Config and DataModel classes:** + - Use `Sequence[T]` instead of `list[T]` (becomes tuple)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
CLAUDE.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: miquido/draive#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-24T08:26:33.028Z
Learning: The draive framework is a Python framework for LLM applications built on haiway for state management, emphasizing immutable State objects and dependency injection via context (ctx).
Learnt from: KaQuMiQ
PR: miquido/draive#338
File: src/draive/lmm/__init__.py:1-2
Timestamp: 2025-06-16T10:28:07.434Z
Learning: The draive project requires Python 3.12+ as specified in pyproject.toml with "requires-python = ">=3.12"" and uses Python 3.12+ specific features like PEP 695 type aliases and generic syntax extensively throughout the codebase.
Learnt from: KaQuMiQ
PR: miquido/draive#327
File: src/draive/helpers/instruction_preparation.py:28-34
Timestamp: 2025-05-28T17:41:57.460Z
Learning: The draive project uses and requires Python 3.12+, so PEP-695 generic syntax with square brackets (e.g., `def func[T: Type]()`) is valid and should be used instead of the older TypeVar approach.
CLAUDE.md (5)
Learnt from: CR
PR: miquido/draive#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-24T08:26:33.028Z
Learning: The draive framework is a Python framework for LLM applications built on haiway for state management, emphasizing immutable State objects and dependency injection via context (ctx).
Learnt from: KaQuMiQ
PR: miquido/draive#338
File: src/draive/lmm/__init__.py:1-2
Timestamp: 2025-06-16T10:28:07.434Z
Learning: The draive project requires Python 3.12+ as specified in pyproject.toml with "requires-python = ">=3.12"" and uses Python 3.12+ specific features like PEP 695 type aliases and generic syntax extensively throughout the codebase.
Learnt from: CR
PR: miquido/draive#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-24T08:26:33.028Z
Learning: Entry points for the framework include: simple generation via TextGeneration.generate() and ModelGeneration.generate(), tool integration via the @tool decorator, complex workflows via Stage composition and Agent systems, and setup via context managers with provider configs.
Learnt from: CR
PR: miquido/draive#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-24T08:26:33.028Z
Learning: Key architectural patterns include: immutable state (all state objects are frozen), context scoping (configuration flows through execution contexts), async-first design, composability (small focused components combine into complex workflows), and type safety (heavy use of generics and protocols).
Learnt from: KaQuMiQ
PR: miquido/draive#327
File: src/draive/helpers/instruction_preparation.py:28-34
Timestamp: 2025-05-28T17:41:57.460Z
Learning: The draive project uses and requires Python 3.12+, so PEP-695 generic syntax with square brackets (e.g., `def func[T: Type]()`) is valid and should be used instead of the older TypeVar approach.
🪛 LanguageTool
CLAUDE.md
[uncategorized] ~50-~50: You might be missing the article “the” here.
Context: ...pytest with async support. Tests are in tests/ directory. - Mock dependencies w...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 markdownlint-cli2 (0.17.2)
CLAUDE.md
58-58: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
| - Uses pytest with async support. Tests are in `tests/` directory. | ||
| - Mock dependencies within scope using stubbed functionality state. |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Unify imperative mood in testing bullets
Other bullets start with “Use”; this one starts with “Uses”. Align wording and add the article “the” for clarity.
-- Uses pytest with async support. Tests are in `tests/` directory.
+- Use pytest with async support. The tests are in the `tests/` directory.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Uses pytest with async support. Tests are in `tests/` directory. | |
| - Mock dependencies within scope using stubbed functionality state. | |
| - Use pytest with async support. The tests are in the `tests/` directory. | |
| - Mock dependencies within scope using stubbed functionality state. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~50-~50: You might be missing the article “the” here.
Context: ...pytest with async support. Tests are in tests/ directory. - Mock dependencies w...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🤖 Prompt for AI Agents
In CLAUDE.md around lines 50 to 51, the bullet point describing testing uses
"Uses" instead of the imperative "Use" like the other bullets and is missing the
article "the". Change "Uses pytest with async support" to "Use the pytest with
async support" to unify the imperative mood and improve clarity.
No description provided.