# FinRL - Doramagic AI Context Pack > Purpose: pre-work context for the user's host AI. This pack does not prove that the project has been installed, run, or validated. ## Project - canonical_name: `AI4Finance-Foundation/FinRL` - capability: FinRLĀ®: Financial Reinforcement Learning. šŸ”„ - expected_user_outcome: FinRLĀ®: Financial Reinforcement Learning. šŸ”„ ## Operating Boundaries - Do not claim that the project has been installed, run, called through an API, or used on local files unless separate evidence proves it. - Project facts must come from repo evidence, Claim Graph, or explicit source references. - When a capability is not verified, mark it as unverified instead of completing it as fact. - publish_status: `publishable` - blocking_gaps: none --- ## Doramagic Context Augmentation The following sections strengthen the repository context for a host AI. Human Manual data is a reading route, and pitfall notes become operating constraints. ## Human Manual Outline Usage rule: this is only a reading route and salience signal, not factual authority. Concrete claims must still return to repo evidence or Claim Graph. Host AI hard rules: - Do not treat page titles, section order, summaries, or importance values as factual project evidence. - When explaining the Human Manual outline, state that it is only a reading route or salience signal. - Capability, installation, compatibility, runtime state, and risk claims must cite repo evidence, source paths, or Claim Graph. - **FinRL Architecture, Three-Layer Framework & Project Layout**: importance `high` - source_paths: README.md, finrl/main.py, finrl/train.py, finrl/test.py, finrl/trade.py - **Market Environments: StockTradingEnv, Crypto, Portfolio & Variants**: importance `high` - source_paths: finrl/meta/env_stock_trading/env_stocktrading.py, finrl/meta/env_stock_trading/env_stocktrading_np.py, finrl/meta/env_stock_trading/env_stocktrading_cashpenalty.py, finrl/meta/env_stock_trading/env_stocktrading_stoploss.py, finrl/meta/env_stock_trading/env_nas100_wrds.py - **DRL Agents: Stable Baselines 3, ElegantRL, RLlib & Common Training Errors**: importance `high` - source_paths: finrl/agents/stablebaselines3/models.py, finrl/agents/stablebaselines3/hyperparams_opt.py, finrl/agents/stablebaselines3/tune_sb3.py, finrl/agents/elegantrl/models.py, finrl/agents/rllib/drllibv2.py - **Data Pipeline, Paper Trading (Alpaca) & End-to-End Applications**: importance `high` - source_paths: finrl/meta/data_processor.py, finrl/meta/data_processors/processor_yahoofinance.py, finrl/meta/data_processors/processor_alpaca.py, finrl/meta/data_processors/processor_ccxt.py, finrl/meta/data_processors/processor_wrds.py ## Repo Inspection Evidence - repo_clone_verified: true - repo_inspection_verified: true - repo_commit: `220f9e490996a6e5c84cfad914ff14f2e0c42d22` - inspected_files: `README.md`, `pyproject.toml`, `requirements.txt`, `docs/.readthdocs.yaml`, `docs/source/conf.py`, `docs/source/reference/publication.md`, `docs/source/reference/reference.md`, `examples/FinRL_PaperTrading_Demo_refactored.py`, `examples/FinRL_StockTrading_2026_1_data.py`, `examples/FinRL_StockTrading_2026_2_train.py`, `examples/FinRL_StockTrading_2026_3_Backtest.py`, `examples/README.md` Host AI hard rules: - Without repo_clone_verified=true, do not claim that the source code has been read. - Without repo_inspection_verified=true, do not write README, docs, or package-file conclusions as facts. - Without quick_start_verified=true, do not claim that the Quick Start path has run successfully. ## Doramagic Pitfall Constraints These rules come from Doramagic discovery, validation, or compilation findings. The host AI must treat them as operating constraints, not background notes. ### Constraint 1: Runtime risk requires verification - Trigger: Project evidence flags a runtime risk. Review the linked source before relying on this workflow. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: community_evidence:github | https://github.com/AI4Finance-Foundation/FinRL/issues/1395 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 2: Runtime risk requires verification - Trigger: Project evidence flags a runtime risk. Review the linked source before relying on this workflow. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: community_evidence:github | https://github.com/AI4Finance-Foundation/FinRL/issues/1414 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 3: Security or permission risk requires verification - Trigger: Project evidence flags a security or permission risk. Review the linked source before relying on this workflow. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: community_evidence:github | https://github.com/AI4Finance-Foundation/FinRL/issues/1412 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 4: Security or permission risk requires verification - Trigger: Project evidence flags a security or permission risk. Review the linked source before relying on this workflow. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: community_evidence:github | https://github.com/AI4Finance-Foundation/FinRL/issues/671 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 5: Security or permission risk requires verification - Trigger: Project evidence flags a security or permission risk. Review the linked source before relying on this workflow. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: community_evidence:github | https://github.com/AI4Finance-Foundation/FinRL/issues/1013 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 6: Security or permission risk requires verification - Trigger: Project evidence flags a security or permission risk. Review the linked source before relying on this workflow. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: packet_text.keyword_scan | https://github.com/AI4Finance-Foundation/FinRL - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 7: Capability evidence risk requires verification - Trigger: README/documentation is current enough for a first validation pass. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: capability.assumptions | https://github.com/AI4Finance-Foundation/FinRL - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 8: Maintenance risk requires verification - Trigger: Project evidence flags a maintenance risk. Review the linked source before relying on this workflow. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: evidence.maintainer_signals | https://github.com/AI4Finance-Foundation/FinRL - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 9: Security or permission risk requires verification - Trigger: no_demo - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: downstream_validation.risk_items | https://github.com/AI4Finance-Foundation/FinRL - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 10: Security or permission risk requires verification - Trigger: no_demo - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: risks.scoring_risks | https://github.com/AI4Finance-Foundation/FinRL - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.