Skip to content

Commit

Permalink
[README]
Browse files Browse the repository at this point in the history
  • Loading branch information
kyegomez committed Dec 10, 2024
1 parent 3953afa commit 0a60d8f
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 12 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,13 @@ WORKSPACE_DIR="agent_workspace"

```python
# Example usage
from autohedge import AutomatedTradingSystem
from autohedge import AutoFund

# Define the stocks to analyze
stocks = ["NVDA"]

# Initialize the trading system with the specified stocks
trading_system = AutomatedTradingSystem(stocks)
trading_system = AutoFund(stocks)

# Define the task for the trading cycle
task = "Let's analyze nvidia to see if we should buy it, we have 50k$ in allocation"
Expand Down Expand Up @@ -124,7 +124,7 @@ class AutoHedgeOutput(BaseModel):
AutoHedge can be configured through environment variables or initialization parameters:

```python
trading_system = AutomatedTradingSystem(
trading_system = AutoFund(
name="CustomStrategy",
description="My Trading Strategy",
stocks=["NVDA", "AAPL"],
Expand Down Expand Up @@ -285,7 +285,7 @@ flowchart LR
### Class Structure
```mermaid
classDiagram
class AutomatedTradingSystem {
class AutoFund {
+String name
+String description
+List stocks
Expand Down Expand Up @@ -314,10 +314,10 @@ classDiagram
+generate_order()
}
AutomatedTradingSystem --> TradingDirector
AutomatedTradingSystem --> QuantAnalyst
AutomatedTradingSystem --> RiskManager
AutomatedTradingSystem --> ExecutionAgent
AutoFund --> TradingDirector
AutoFund --> QuantAnalyst
AutoFund --> RiskManager
AutoFund --> ExecutionAgent
```

## 🤝 Contributing
Expand Down
3 changes: 3 additions & 0 deletions autohedge/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
from autohedge.main import AutoFund

__all__ = ["AutoFund"]
2 changes: 1 addition & 1 deletion autohedge/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,7 @@ def analyze(self, stock: str, thesis: str) -> str:
raise


class AutomatedTradingSystem:
class AutoFund:
"""
Main trading system that coordinates all agents and manages the trading cycle.
Expand Down
4 changes: 2 additions & 2 deletions example.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Example usage
from autohedge.main import AutomatedTradingSystem
from autohedge.main import AutoFund

# Define the stocks to analyze
stocks = ["NVDA"]

# Initialize the trading system with the specified stocks
trading_system = AutomatedTradingSystem(stocks)
trading_system = AutoFund(stocks)

# Define the task for the trading cycle
task = "Let's analyze nvidia to see if we should buy it, we have 50k$ in allocation"
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"

[tool.poetry]
name = "autohedge"
version = "0.0.2"
version = "0.0.3"
description = "autohedge - TGSC"
license = "MIT"
authors = ["Kye Gomez <[email protected]>"]
Expand Down

0 comments on commit 0a60d8f

Please sign in to comment.