How future-house/aviary works
Main Components
a) Core Framework Layer:
• Message System (src/aviary/message.py)
• Environment Core (src/aviary/env.py)
• Tool System (src/aviary/tools/)
• Functional Interface (src/aviary/functional.py)
b) Environment Implementation Layer:
• Base Environment Class
• Functional Environment Interface
• Environment Registry
c) Package Environments:
• GSM8k Environment
• HotPotQA Environment
• PaperQA Environment
d) Testing Infrastructure:
• Test Fixtures
• Cassettes for API Testing
[Client Applications]
• ↕
[Environment Packages Layer]
• ↕
[Core Framework Layer]
• ↕
[External Dependencies/Services]
Component Relationships
• Message flow between components
• Inheritance relationships for environments
• Tool registration and execution paths
• Dataset server interactions
Specific Elements
a) Core Framework Components:
[Message System] ←→ [Environment Core]
• ↕ ↕
[Tool System] ←→ [Functional Interface]
b) Environment Implementation:
[Base Environment]
• ↙ ↓ ↘
[GSM8k] [HotPotQA] [PaperQA]
c) Tool System Detail:
[Tool Registry]
• ↓
[Tool Definitions]
• ↓
[Tool Execution Engine]
Important Implementation Details
• Async execution flow paths
• Message-based communication system
• Tool registration and discovery mechanism
• Environment state management
• Testing integration points
Technical Details to Emphasize
• Python 3.11+ requirement
• Pydantic model usage for state management
• Gymnasium compatibility
• Tool documentation and type hint system
• Dataset server architecture
Remember to include version compatibility notes and external dependency relationships, as these are critical for understanding the system's boundaries and requirements.
This system design should help developers understand both how to use the framework and how to extend it with new environments and tools.