-
Notifications
You must be signed in to change notification settings - Fork 7
Labels
Semver:minorminor version changesminor version changesType:Mediumjunior developers talksjunior developers talksenhancementNew feature or requestNew feature or requestfeaturenew feature addednew feature added
Description
Check out this issue under .github/ISSUE_TEMPLATE/good-first-issue-1
Summary
Add a new example factor BollingerBandsFactor under src/quant_research_starter/factors/.
Tasks
- Create
bollinger.pywith a factor computing z-score of price vs. rolling band. - Export in
factors/__init__.py. - Add unit tests in
tests/test_factors.py. - Update README with a short mention.
Definition of Done
pytestpasses and coverage unchanged or better.
name: "Good First Issue: Add New Simple Factor"
title: "Factor Implementation: [Your Factor Name]"
labels: ["good-first-issue", "enhancement", "factors"]
assignees: []
Description
Add a new factor implementation to the factors module. This is a great first issue to understand how factors work in the framework.
Suggested Factor
Factor Name: Liquidity Factor
Description: Measure trading liquidity using volume-based metrics
Implementation Steps
- Create new file
src/quant_research_starter/factors/liquidity.py - Implement a
LiquidityFactorclass inheriting fromFactor - Use trading volume (or synthetic volume) to compute liquidity measures
- Add basic tests in
tests/test_factors.py - Update
src/quant_research_starter/factors/__init__.pyto export the new factor
Code Example
class LiquidityFactor(Factor):
def compute(self, prices: pd.DataFrame, volumes: pd.DataFrame = None) -> pd.DataFrame:
# Your implementation here
# Suggested: Use dollar volume or turnover as liquidity proxy
passMetadata
Metadata
Assignees
Labels
Semver:minorminor version changesminor version changesType:Mediumjunior developers talksjunior developers talksenhancementNew feature or requestNew feature or requestfeaturenew feature addednew feature added