104 lines
3.0 KiB
Plaintext
104 lines
3.0 KiB
Plaintext
# 🧠 SightRay 통합 실행 엔트리포인트 개념 정리 (`sightray.py`)
|
|
|
|
---
|
|
|
|
## ✅ 목적
|
|
|
|
`sightray.py`는 SightRay의 모든 엔진을 **하나의 흐름으로 통합 실행**하는 CLI 기반 진입점입니다.
|
|
사용자가 종목 코드와 날짜, 자본만 입력하면:
|
|
|
|
> 수집 → 분석 → 리스크 평가 → 전략 실행 → 결과 저장 까지 전부 자동화됩니다.
|
|
|
|
---
|
|
|
|
## 🔁 실행 흐름 요약
|
|
|
|
```plaintext
|
|
[사용자 입력: symbol, start, end, capital]
|
|
↓
|
|
DataCollectionEngine.collect() → CDS 수집 및 저장
|
|
↓
|
|
train_model.py → 학습 및 모델 저장
|
|
↓
|
|
predict.py → 예측 결과 (prediction_result.csv)
|
|
↓
|
|
evaluate.py → 리스크 평가 + tradable 종목 선정
|
|
↓
|
|
run_strategy.py → 전략 적용 + 포지션 설정
|
|
↓
|
|
[최종 결과: final_strategy_result.csv 저장]
|
|
```
|
|
|
|
---
|
|
|
|
## ⚙️ 실행 인자
|
|
|
|
```bash
|
|
python sightray.py \
|
|
--symbol AAPL \
|
|
--start 2024-01-01 \
|
|
--end 2024-04-01 \
|
|
--capital 1000000 \
|
|
--strategy adjusted
|
|
```
|
|
|
|
| 인자 | 설명 |
|
|
|------|------|
|
|
| `--symbol` | 분석할 종목 코드 (예: AAPL, TSLA) |
|
|
| `--start` | 시작일 (`YYYY-MM-DD`) |
|
|
| `--end` | 종료일 (`YYYY-MM-DD`) |
|
|
| `--capital` | 총 투자 자본 (정수 단위) |
|
|
| `--strategy` | 전략 템플릿 (`basic` 또는 `adjusted`, 기본: `adjusted`) |
|
|
|
|
---
|
|
|
|
## 📁 내부 구성 연계
|
|
|
|
| 모듈 | 역할 |
|
|
|------|------|
|
|
| `engine.py` | 데이터 수집 및 저장 (`data/`) |
|
|
| `train_model.py` | XGBoost 모델 학습 및 저장 |
|
|
| `predict.py` | 분석 예측 수행 (상위 종목 선정) |
|
|
| `evaluate.py` | 리스크 점수 산출 및 필터링 |
|
|
| `run_strategy.py` | 전략 실행 및 결과 저장 |
|
|
|
|
---
|
|
|
|
## 🔐 API 키 설정 기능
|
|
|
|
| 기능 | 설명 |
|
|
|------|------|
|
|
| `.env` 자동 로딩 | POLYGON_API_KEY 로딩 시도 |
|
|
| 키 미입력 시 | 사용자에게 직접 입력받아 `.env`에 저장 |
|
|
| `--reset-api` | 강제로 API 키 재설정 가능 |
|
|
|
|
---
|
|
|
|
## 📊 출력 파일 예시
|
|
|
|
| 파일명 | 내용 |
|
|
|--------|------|
|
|
| `data/AAPL_ohlcv.csv` | 수집된 OHLCV 데이터 (CDS) |
|
|
| `prediction_result.csv` | 예측된 상위 종목 및 확률 |
|
|
| `risk_filtered_result.csv` | tradable 종목 리스트 + risk_score |
|
|
| `final_strategy_result.csv` | TP/SL 및 포지션 포함된 전략 결과 ✅ |
|
|
|
|
---
|
|
|
|
## ✅ SightRay에서의 역할
|
|
|
|
| 기능 | 설명 |
|
|
|------|------|
|
|
| 자동화 허브 | 모든 엔진을 순차 실행하여 결과까지 자동 도출 |
|
|
| CLI 통제 포인트 | 사용자 입력 기반 실행 환경 구성 |
|
|
| 확장 인터페이스 | 추후 Web, API, GUI에서 호출할 핵심 함수로도 전환 가능 |
|
|
|
|
---
|
|
|
|
## ✅ 요약
|
|
|
|
`sightray.py`는 SightRay의 **완전 자동화 파이프라인**을 실행하기 위한 단일 진입점입니다.
|
|
사용자는 단 한 줄의 명령으로 전체 분석과 전략 실행을 완료할 수 있으며,
|
|
이 파일은 운영자, 자동화 시스템, 외부 API 호출 등에서 **실전 통합 인터페이스**로 사용됩니다.
|
|
|