tensortrade 1.0.1b0__tar.gz → 1.0.4__tar.gz

tensortrade-1.0.4/CONTRIBUTING.md

@@ -0,0 +1,78 @@
+# On Github Issues and Pull Requests
+
+Found a bug? Have a new feature to suggest? Want to contribute changes to the codebase? Make sure to read this first.
+
+## Bug reporting
+
+Your code doesn't work, and you have determined that the issue lies with TensorTrade? Follow these steps to report a bug.
+
+1. Your bug may already be fixed. Make sure to update to the current TensorTrade master branch, as well as the latest TensorFlow master branch.
+
+2. Search for similar issues. Make sure to delete `is:open` on the issue search to find solved tickets as well. It's possible somebody has encountered this bug already. Also remember to check out TensorTrade's [FAQ](http://tensortrader.io/faq/). Still having a problem? Open an issue on Github to let us know.
+
+3. Make sure you provide us with useful information about your configuration: what OS are you using? What Tensorflow version are you using? Are you running on GPU? If so, what is your version of Cuda, of cuDNN? What is your GPU?
+
+4. Provide us with a script to reproduce the issue. This script should be runnable as-is and should not require external data download (use randomly generated data if you need to run a model on some test data). We recommend that you use Github Gists to post your code. Any issue that cannot be reproduced is likely to be closed.
+
+5. If possible, take a stab at fixing the bug yourself --if you can!
+
+The more information you provide, the easier it is for us to validate that there is a bug and the faster we'll be able to take action. If you want your issue to be resolved quickly, following the steps above is crucial.
+
+---
+
+## Requesting a Feature
+
+You can also use Github issues to request features you would like to see in TensorTrade, or changes in the TensorTrade API.
+
+1. Provide a clear and detailed explanation of the feature you want and why it's important to add. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on library for TensorTrade. It is crucial for TensorTrade to avoid bloating the API and codebase.
+
+2. Provide code snippets demonstrating the API you have in mind and illustrating the use cases of your feature. Of course, you don't need to write any real code at this point!
+
+3. After discussing the feature you may choose to attempt a Pull Request. If you're at all able, start writing some code. We always have more work to do than time to do it. If you can write some code then that will speed the process along.
+
+---
+
+## Requests for Contributions
+
+[This is the board](https://github.com/notadamking/tensortrader/projects/1) where we list current outstanding issues and features to be added. If you want to start contributing to TensorTrade, this is the place to start.
+
+---
+
+## Pull Requests
+
+Please note that PRs that are primarily about **code style** (as opposed to fixing bugs, improving docs, or adding new functionality) will likely be rejected.
+
+Here's a quick guide to submitting your improvements:
+
+1. If your PR introduces a change in functionality, make sure you start by writing a design doc and opening a Github issue to discuss whether the change should be made, and how to handle it. This will save you from having your PR closed down the road! Of course, if your PR is a simple bug fix, you don't need to do that.
+
+2) Write the code (or get others to write it). This is the hard part!
+
+3) Make sure any new function or class you introduce has proper docstrings. Make sure any code you touch still has up-to-date docstrings and documentation. **Docstring style should be respected.** In particular, they should be formatted in MarkDown, and there should be sections for `Arguments`, `Returns`, `Raises` (if applicable). Look at other docstrings in the codebase for examples.
+
+4) Write tests. Your code should have full unit test coverage. If you want to see your PR merged promptly, this is crucial. Use the _coverage_  module module to make sure that code coverage is increased on the component you are working on. PRs that decrease coverage may be rejected. 
+
+5) Run our test suite locally. It's easy: from the TensorTrade folder, simply run: `py.test tests/`.
+
+   - You will need to install the test requirements as well: `pip install -e .[tests]`.
+
+6) Make sure all tests are passing.
+
+7) We use PEP8 syntax conventions, but we aren't dogmatic when it comes to line length. Make sure your lines stay reasonably sized, though. To make your life easier, we recommend running a PEP8 linter:
+
+   - Install PEP8 packages: `pip install pep8 pytest-pep8 autopep8`
+   - Run a standalone PEP8 check: `py.test --pep8 -m pep8`
+   - You can automatically fix some PEP8 error by running: `autopep8 -i --select <errors> <FILENAME>` for example: `autopep8 -i --select E128 tests/tensortrader/backend/test_backends.py`
+
+8) When committing, use appropriate, descriptive commit messages.
+
+9) Update the documentation. If introducing new functionality, make sure you include code snippets demonstrating the usage of your new feature.
+
+10) Submit your PR. If your changes have been approved in a previous discussion, and if you have complete (and passing) unit tests as well as proper docstrings/documentation, your PR is likely to be merged promptly.
+
+
+---
+
+## Adding new examples
+
+Even if you don't contribute to the TensorTrade source code, if you have an application of TensorTrade that is concise and powerful, please consider adding it to our collection of examples. [Existing examples](./examples) show idiomatic TensorTrade code: make sure to keep your own script in the same spirit.

tensortrade-1.0.4/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 Quantopian, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tensortrade-1.0.4/MANIFEST.in

@@ -0,0 +1,6 @@
+include LICENSE
+include README.md
+include CONTRIBUTING.md
+graft docs
+graft examples
+graft tests

tensortrade-1.0.4/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: tensortrade
+Version: 1.0.4
+Summary: TensorTrade: A reinforcement learning library for training, evaluating, and deploying robust trading agents.
+Home-page: https://github.com/tensortrade-org/tensortrade
+Author: Adam King <adamjking3@gmail.com>, Matthew Brulhardt <mwbrulhardt@gmail.com>
+Maintainer: Carlo Grisetti <carlo.grisetti@gmail.com>
+License: Apache 2.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Natural Language :: English
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: pandas<3.0,>=2.2.3
+Requires-Dist: gymnasium>=0.28.1
+Requires-Dist: pyyaml>=5.1.2
+Requires-Dist: stochastic>=0.6.0
+Requires-Dist: tensorflow>=2.15.1
+Requires-Dist: ipython>=7.12.0
+Requires-Dist: matplotlib>=3.1.1
+Requires-Dist: plotly>=4.5.0
+Requires-Dist: deprecated>=1.2.13
+Requires-Dist: ta>=0.4.7
+Requires-Dist: pytest>=7.0.0
+Provides-Extra: tests
+Requires-Dist: pytest>=7.0.0; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Requires-Dist: sphinxcontrib.apidoc; extra == "docs"
+Requires-Dist: nbsphinx; extra == "docs"
+Requires-Dist: nbsphinx_link; extra == "docs"
+Requires-Dist: recommonmark; extra == "docs"
+Requires-Dist: sphinx_markdown_tables; extra == "docs"
+Requires-Dist: ipykernel; extra == "docs"
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: maintainer
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+TensorTrade: A reinforcement learning library for training, evaluating, and deploying robust trading agents.

tensortrade-1.0.4/README.md

@@ -0,0 +1,204 @@
+<p align="center">
+  <img src="docs/source/_static/logo.jpg" width="200" alt="TensorTrade Logo">
+</p>
+
+# TensorTrade
+
+**Train RL agents to trade. Can they beat Buy-and-Hold?**
+
+[![Tests](https://github.com/tensortrade-org/tensortrade/actions/workflows/tests.yml/badge.svg)](https://github.com/tensortrade-org/tensortrade/actions/workflows/tests.yml)
+[![Documentation Status](https://readthedocs.org/projects/tensortrade/badge/?version=latest)](https://tensortrade.org)
+[![Apache License](https://img.shields.io/github/license/tensortrade-org/tensortrade.svg?color=brightgreen)](http://www.apache.org/licenses/LICENSE-2.0)
+[![Discord](https://img.shields.io/discord/592446624882491402.svg?color=brightgreen)](https://discord.gg/ZZ7BGWh)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/release/python-3120/)
+
+TensorTrade is an open-source Python framework for building, training, and evaluating reinforcement learning agents for algorithmic trading. The framework provides composable components for environments, action schemes, reward functions, and data feeds that can be combined to create custom trading systems.
+
+## Quick Start
+
+```bash
+# Requires Python 3.12+
+python3.12 -m venv tensortrade-env && source tensortrade-env/bin/activate
+pip install -e .
+
+# For training with Ray/RLlib (recommended)
+pip install -r examples/requirements.txt
+
+# Run training
+python examples/training/train_simple.py
+```
+
+## Documentation & Tutorials
+
+📚 **[Tutorial Index](docs/tutorials/index.md)** — Start here for the complete learning curriculum.
+
+### Foundations
+- [The Three Pillars](docs/tutorials/01-foundations/01-three-pillars.md) — RL + Trading + Data concepts
+- [Architecture](docs/tutorials/01-foundations/02-architecture.md) — How components work together
+- [Your First Run](docs/tutorials/01-foundations/03-your-first-run.md) — Run and understand output
+
+### Domain Knowledge
+- [Trading for RL Practitioners](docs/tutorials/02-domains/track-a-trading-for-rl/01-trading-basics.md)
+- [RL for Traders](docs/tutorials/02-domains/track-b-rl-for-traders/01-rl-fundamentals.md)
+- [Common Failures](docs/tutorials/02-domains/track-b-rl-for-traders/02-common-failures.md) — Critical pitfalls to avoid
+- [Full Introduction](docs/tutorials/02-domains/track-c-full-intro/README.md) — New to both domains
+
+### Core Components
+- [Action Schemes](docs/tutorials/03-components/01-action-schemes.md) — BSH and order execution
+- [Reward Schemes](docs/tutorials/03-components/02-reward-schemes.md) — Why PBR works
+- [Observers & Feeds](docs/tutorials/03-components/03-observers-feeds.md) — Feature engineering
+
+### Training
+- [First Training](docs/tutorials/04-training/01-first-training.md) — Train with Ray RLlib
+- [Ray RLlib Deep Dive](docs/tutorials/04-training/02-ray-rllib.md) — Configuration options
+- [Optuna Optimization](docs/tutorials/04-training/03-optuna.md) — Hyperparameter tuning
+
+### Advanced Topics
+- [Overfitting](docs/tutorials/05-advanced/01-overfitting.md) — Detection and prevention
+- [Commission Analysis](docs/tutorials/05-advanced/02-commission.md) — Key research findings
+- [Walk-Forward Validation](docs/tutorials/05-advanced/03-walk-forward.md) — Proper evaluation
+
+### Additional Resources
+- [Experiments Log](docs/EXPERIMENTS.md) — Full research documentation
+- [Environment Setup](docs/ENVIRONMENT_SETUP.md) — Detailed installation guide
+- [API Reference](https://www.tensortrade.org/en/latest/)
+
+---
+
+## Research Findings
+
+We conducted extensive experiments training PPO agents on BTC/USD. Key results:
+
+| Configuration | Test P&L | vs Buy-and-Hold |
+|---------------|----------|-----------------|
+| Agent (0% commission) | +$239 | +$594 |
+| Agent (0.1% commission) | -$650 | -$295 |
+| Buy-and-Hold | -$355 | — |
+
+The agent demonstrates directional prediction capability at zero commission. The primary challenge is trading frequency—commission costs currently exceed prediction profits. See [EXPERIMENTS.md](docs/EXPERIMENTS.md) for methodology and detailed analysis.
+
+---
+
+## Architecture
+
+```
+┌─────────────────────────────────────────────────────────────────┐
+│                        TradingEnv                               │
+│                                                                 │
+│   Observer ──────> Agent ──────> ActionScheme ──────> Portfolio │
+│   (features)      (policy)      (BSH/Orders)        (wallets)  │
+│       ^                                                  │      │
+│       └──────────── RewardScheme <───────────────────────┘      │
+│                        (PBR)                                    │
+│                                                                 │
+│   DataFeed ──────> Exchange ──────> Broker ──────> Trades       │
+└─────────────────────────────────────────────────────────────────┘
+```
+
+| Component | Purpose | Default |
+|-----------|---------|---------|
+| ActionScheme | Converts agent output to orders | BSH (Buy/Sell/Hold) |
+| RewardScheme | Computes learning signal | PBR (Position-Based Returns) |
+| Observer | Generates observations | Windowed features |
+| Portfolio | Manages wallets and positions | USD + BTC |
+| Exchange | Simulates execution | Configurable commission |
+
+---
+
+## Training Scripts
+
+| Script | Description |
+|--------|-------------|
+| `examples/training/train_simple.py` | Basic demo with wallet tracking |
+| `examples/training/train_ray_long.py` | Distributed training with Ray RLlib |
+| `examples/training/train_optuna.py` | Hyperparameter optimization |
+| `examples/training/train_best.py` | Best configuration from experiments |
+
+---
+
+## Installation
+
+**Requirements:** Python 3.11 or 3.12
+
+```bash
+# Create environment
+python3.12 -m venv tensortrade-env
+source tensortrade-env/bin/activate  # Windows: tensortrade-env\Scripts\activate
+
+# Install
+pip install --upgrade pip
+pip install -r requirements.txt
+pip install -e .
+
+# Verify
+pytest tests/tensortrade/unit -v
+
+# Training dependencies (optional)
+pip install -r examples/requirements.txt
+```
+
+See [ENVIRONMENT_SETUP.md](docs/ENVIRONMENT_SETUP.md) for platform-specific instructions and troubleshooting.
+
+### Docker
+
+```bash
+make run-notebook  # Jupyter
+make run-docs      # Documentation
+make run-tests     # Test suite
+```
+
+---
+
+## Project Structure
+
+```
+tensortrade/
+├── tensortrade/           # Core library
+│   ├── env/              # Trading environments
+│   ├── feed/             # Data pipeline
+│   ├── oms/              # Order management
+│   └── data/             # Data fetching
+├── examples/
+│   ├── training/         # Training scripts
+│   └── notebooks/        # Jupyter tutorials
+├── docs/
+│   ├── tutorials/        # Learning curriculum
+│   └── EXPERIMENTS.md    # Research log
+└── tests/
+```
+
+---
+
+## Troubleshooting
+
+| Issue | Solution |
+|-------|----------|
+| "No stream satisfies selector" | Update to v1.0.4-dev1+ |
+| Ray installation fails | Run `pip install --upgrade pip` first |
+| NumPy version conflict | `pip install "numpy>=1.26.4,<2.0"` |
+| TensorFlow CUDA issues | `pip install tensorflow[and-cuda]>=2.15.1` |
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+Priority areas:
+1. Trading frequency reduction (position sizing, holding periods)
+2. Commission-aware reward schemes
+3. Alternative action spaces
+
+---
+
+## Community
+
+- [Discord](https://discord.gg/ZZ7BGWh)
+- [GitHub Issues](https://github.com/notadamking/tensortrade/issues)
+- [Documentation](https://www.tensortrade.org/)
+
+---
+
+## License
+
+[Apache 2.0](LICENSE)

tensortrade-1.0.4/docs/.readthedocs.yml

@@ -0,0 +1,19 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - requirements: docs/requirements.txt