Deployed 9003d5e to develop in en with MkDocs 1.6.1 and mike 2.2.0

.coveragerc

@@ -1,7 +0,0 @@
-[run]
-omit =
-    scripts/*
-    freqtrade/templates/*
-    freqtrade/vendor/*
-    freqtrade/__main__.py
-    tests/*

.devcontainer/devcontainer.json

@@ -1,44 +0,0 @@
-{
-    "name": "freqtrade Develop",
-    "image": "ghcr.io/freqtrade/freqtrade-devcontainer:latest",
-    // Use 'forwardPorts' to make a list of ports inside the container available locally.
-    "forwardPorts": [
-        8080
-    ],
-    "workspaceMount": "source=${localWorkspaceFolder},target=/workspaces/freqtrade,type=bind,consistency=cached",
-    // Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
-    "remoteUser": "ftuser",
-    "onCreateCommand": "pip install --user -e .",
-    "postCreateCommand": "freqtrade create-userdir --userdir user_data/",
-    "workspaceFolder": "/workspaces/freqtrade",
-    "customizations": {
-        "vscode": {
-            "settings": {
-                "terminal.integrated.shell.linux": "/bin/bash",
-                "editor.insertSpaces": true,
-                "files.trimTrailingWhitespace": true,
-                "[markdown]": {
-                    "files.trimTrailingWhitespace": false
-                },
-                "python.pythonPath": "/usr/local/bin/python",
-                "[python]": {
-                    "editor.codeActionsOnSave": {
-                        "source.organizeImports": "explicit"
-                    },
-                    "editor.formatOnSave": true,
-                    "editor.defaultFormatter": "charliermarsh.ruff"
-                }
-            },
-            // Add the IDs of extensions you want installed when the container is created.
-            "extensions": [
-                "ms-python.python",
-                "ms-python.vscode-pylance",
-                "charliermarsh.ruff",
-                "davidanson.vscode-markdownlint",
-                "ms-azuretools.vscode-docker",
-                "vscode-icons-team.vscode-icons",
-                "github.vscode-github-actions",
-            ],
-        }
-    }
-}

.dockerignore

@@ -1,25 +0,0 @@
-.git
-.gitignore
-Dockerfile
-Dockerfile.armhf
-.dockerignore
-docker/
-.coveragerc
-.eggs
-.github
-.pylintrc
-.travis.yml
-CONTRIBUTING.md
-MANIFEST.in
-README.md
-freqtrade.service
-freqtrade.egg-info
-
-config.json*
-*.sqlite
-user_data
-*.log
-
-.vscode
-.mypy_cache
-.ipynb_checkpoints

.gitattributes

@@ -1,3 +0,0 @@
-*.py    eol=lf
-*.sh    eol=lf
-*.ps1   eol=crlf

.github/.devcontainer/Dockerfile

@@ -1,21 +0,0 @@
-FROM freqtradeorg/freqtrade:develop_freqairl
-
-USER root
-# Install dependencies
-COPY requirements-dev.txt /freqtrade/
-
-ARG USERNAME=ftuser
-
-RUN apt-get update \
-    && apt-get -y install --no-install-recommends apt-utils dialog git ssh vim build-essential zsh \
-    && apt-get clean \
-    && mkdir -p /home/${USERNAME}/.vscode-server /home/${USERNAME}/.vscode-server-insiders /home/${USERNAME}/commandhistory \
-    && chown ${USERNAME}:${USERNAME} -R /home/${USERNAME}/.local/ \
-    && chown ${USERNAME}: -R /home/${USERNAME}/
-
-USER ftuser
-
-RUN pip install --user autopep8 -r docs/requirements-docs.txt -r requirements-dev.txt --no-cache-dir
-
-# Empty the ENTRYPOINT to allow all commands
-ENTRYPOINT []

.github/.devcontainer/devcontainer.json

@@ -1,12 +0,0 @@
-{
-    "name": "freqtrade Dev container image builder",
-    "build": {
-        "dockerfile": "Dockerfile",
-        "context": "../../"
-    },
-    "features": {
-        "ghcr.io/devcontainers/features/common-utils:2": {
-        },
-        "ghcr.io/stuartleeks/dev-container-features/shell-history:0.0.3": {}
-    }
-}

.github/FUNDING.yml

@@ -1,3 +0,0 @@
-# These are supported funding model platforms
-
-github: [xmatthias]

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,48 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: "Triage Needed"
-assignees: ''
-
----
-<!-- 
-Have you searched for similar issues before posting it?
-
-If you have discovered a bug in the bot, please [search the issue tracker](https://github.com/freqtrade/freqtrade/issues?q=is%3Aissue). 
-If it hasn't been reported, please create a new issue.
-
-Please do not use bug reports to request new features.
--->
-
-## Describe your environment
-
-  * Operating system: ____
-  * Python Version: _____ (`python -V`)
-  * CCXT version: _____ (`pip freeze | grep ccxt`)
-  * Freqtrade Version: ____ (`freqtrade -V` or `docker compose run --rm freqtrade -V` for Freqtrade running in docker)
-  
-Note: All issues other than enhancement requests will be closed without further comment if the above template is deleted or not filled out.
-
-## Describe the problem:
-
-*Explain the problem you have encountered*
-
-### Steps to reproduce:
-
-  1. _____
-  2. _____
-  3. _____
-  
-### Observed Results:
-
-  * What happened?
-  * What did you expect to happen?
-
-### Relevant code exceptions or logs
-
-Note: Please copy/paste text of the messages, no screenshots of logs please.
-
-  ```
-  // paste your log here
-  ```

.github/ISSUE_TEMPLATE/config.yml

@@ -1,6 +0,0 @@
----
-blank_issues_enabled: false
-contact_links:
-  - name: Discord Server
-    url: https://discord.gg/p7nuUNVfP7
-    about: Ask a question or get community support from our Discord server

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,26 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-<!-- 
-Note: this section will not show up in the issue.
-Have you search for this feature before requesting it? It's highly likely that a similar request was already filed.
--->
-
-## Describe your environment
-(if applicable)
-
-  * Operating system: ____
-  * Python Version: _____ (`python -V`)
-  * CCXT version: _____ (`pip freeze | grep ccxt`)
-  * Freqtrade Version: ____ (`freqtrade -V` or `docker compose run --rm freqtrade -V` for Freqtrade running in docker)
-
-
-## Describe the enhancement
-
-*Explain the enhancement you would like*

.github/ISSUE_TEMPLATE/question.md

@@ -1,25 +0,0 @@
----
-name: Question
-about: Ask a question you could not find an answer in the docs
-title: ''
-labels: "Question"
-assignees: ''
-
----
-<!-- 
-Have you searched for similar issues before posting it?
-Did you have a VERY good look at the [documentation](https://www.freqtrade.io/en/latest/) and are sure that the question is not explained there
-
-Please do not use the question template to report bugs or to request new features.
--->
-
-## Describe your environment
-
-  * Operating system: ____
-  * Python Version: _____ (`python -V`)
-  * CCXT version: _____ (`pip freeze | grep ccxt`)
-  * Freqtrade Version: ____ (`freqtrade -V` or `docker compose run --rm freqtrade -V` for Freqtrade running in docker)
-  
-## Your question
-
-*Ask the question you have not been able to find an answer in the [Documentation](https://www.freqtrade.io/en/latest/)*

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,17 +0,0 @@
-<!-- Thank you for sending your pull request. But first, have you included
-unit tests, and is your code PEP8 conformant? [More details](https://github.com/freqtrade/freqtrade/blob/develop/CONTRIBUTING.md)
--->
-## Summary
-
-<!-- Explain in one sentence the goal of this PR -->
-
-Solve the issue: #___
-
-## Quick changelog
-
-- <change log 1>
-- <change log 1>
-
-## What's new?
-
-<!-- Explain in details what this PR solve or improve. You can include visuals. -->

.github/dependabot.yml

@@ -1,38 +0,0 @@
-version: 2
-updates:
-- package-ecosystem: docker
-  directories:
-    - "/"
-    - "/docker"
-  schedule:
-    interval: daily
-  ignore:
-  - dependency-name: "*"
-    update-types: ["version-update:semver-major"]
-  open-pull-requests-limit: 10
-
-- package-ecosystem: pip
-  directory: "/"
-  schedule:
-    interval: weekly
-    time: "03:00"
-    timezone: "Etc/UTC"
-  open-pull-requests-limit: 15
-  target-branch: develop
-  groups:
-    types:
-      patterns:
-        - "types-*"
-    pytest:
-      patterns:
-        - "pytest*"
-    mkdocs:
-      patterns:
-        - "mkdocs*"
-
-- package-ecosystem: "github-actions"
-  directory: "/"
-  schedule:
-    interval: "weekly"
-  open-pull-requests-limit: 10
-  target-branch: develop

.github/workflows/binance-lev-tier-update.yml

@@ -1,47 +0,0 @@
-name: Binance Leverage tiers update
-
-on:
-  schedule:
-    - cron: "0 3 * * 4"
-  # on demand
-  workflow_dispatch:
-
-permissions:
-  contents: read
-
-jobs:
-  auto-update:
-    runs-on: ubuntu-latest
-    environment:
-      name: develop
-    steps:
-    - uses: actions/checkout@v4
-
-    - uses: actions/setup-python@v5
-      with:
-        python-version: "3.12"
-
-    - name: Install ccxt
-      run: pip install ccxt
-
-    - name: Run leverage tier update
-      env:
-        CI_WEB_PROXY: ${{ secrets.CI_WEB_PROXY }}
-        FREQTRADE__EXCHANGE__KEY: ${{ secrets.BINANCE_EXCHANGE_KEY }}
-        FREQTRADE__EXCHANGE__SECRET: ${{ secrets.BINANCE_EXCHANGE_SECRET }}
-      run: python build_helpers/binance_update_lev_tiers.py
-
-
-    - uses: peter-evans/create-pull-request@v7
-      with:
-        token: ${{ secrets.REPO_SCOPED_TOKEN }}
-        add-paths: freqtrade/exchange/binance_leverage_tiers.json
-        labels: |
-          Tech maintenance
-          Dependencies
-        branch: update/binance-leverage-tiers
-        title: Update Binance Leverage Tiers
-        commit-message: "chore: update pre-commit hooks"
-        committer: Freqtrade Bot <noreply@github.com>
-        body: Update binance leverage tiers.
-        delete-branch: true

.github/workflows/ci.yml

@@ -1,638 +0,0 @@
-name: Freqtrade CI
-
-on:
-  push:
-    branches:
-      - stable
-      - develop
-      - ci/*
-    tags:
-  release:
-    types: [published]
-  pull_request:
-  schedule:
-    - cron:  '0 3 * * 4'
-
-concurrency:
-  group: "${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }}"
-  cancel-in-progress: true
-permissions:
-  repository-projects: read
-jobs:
-  build-linux:
-
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ "ubuntu-20.04", "ubuntu-22.04", "ubuntu-24.04" ]
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
-
-    steps:
-    - uses: actions/checkout@v4
-
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
-
-    - name: Cache_dependencies
-      uses: actions/cache@v4
-      id: cache
-      with:
-        path: ~/dependencies/
-        key: ${{ runner.os }}-dependencies
-
-    - name: pip cache (linux)
-      uses: actions/cache@v4
-      with:
-        path: ~/.cache/pip
-        key: test-${{ matrix.os }}-${{ matrix.python-version }}-pip
-
-    - name: TA binary *nix
-      if: steps.cache.outputs.cache-hit != 'true'
-      run: |
-        cd build_helpers && ./install_ta-lib.sh ${HOME}/dependencies/; cd ..
-
-    - name: Installation - *nix
-      run: |
-        python -m pip install --upgrade pip wheel
-        export LD_LIBRARY_PATH=${HOME}/dependencies/lib:$LD_LIBRARY_PATH
-        export TA_LIBRARY_PATH=${HOME}/dependencies/lib
-        export TA_INCLUDE_PATH=${HOME}/dependencies/include
-        pip install -r requirements-dev.txt
-        pip install -e ft_client/
-        pip install -e .
-
-    - name: Check for version alignment
-      run: |
-        python build_helpers/freqtrade_client_version_align.py
-
-    - name: Tests
-      run: |
-        pytest --random-order --cov=freqtrade --cov=freqtrade_client --cov-config=.coveragerc
-
-    - name: Coveralls
-      if: (runner.os == 'Linux' && matrix.python-version == '3.10' && matrix.os == 'ubuntu-22.04')
-      env:
-        # Coveralls token. Not used as secret due to github not providing secrets to forked repositories
-        COVERALLS_REPO_TOKEN: 6D1m0xupS3FgutfuGao8keFf9Hc0FpIXu
-      run: |
-        # Allow failure for coveralls
-        coveralls || true
-
-    - name: Run json schema extract
-      # This should be kept before the repository check to ensure that the schema is up-to-date
-      run: |
-        python build_helpers/extract_config_json_schema.py
-
-    - name: Check for repository changes
-      run: |
-        if [ -n "$(git status --porcelain)" ]; then
-          echo "Repository is dirty, changes detected:"
-          git status
-          git diff
-          exit 1
-        else
-          echo "Repository is clean, no changes detected."
-        fi
-
-    - name: Backtesting (multi)
-      run: |
-        cp tests/testdata/config.tests.json config.json
-        freqtrade create-userdir --userdir user_data
-        freqtrade new-strategy -s AwesomeStrategy
-        freqtrade new-strategy -s AwesomeStrategyMin --template minimal
-        freqtrade backtesting --datadir tests/testdata --strategy-list AwesomeStrategy AwesomeStrategyMin -i 5m
-
-    - name: Hyperopt
-      run: |
-        cp tests/testdata/config.tests.json config.json
-        freqtrade create-userdir --userdir user_data
-        freqtrade hyperopt --datadir tests/testdata -e 6 --strategy SampleStrategy --hyperopt-loss SharpeHyperOptLossDaily --print-all
-
-    - name: Sort imports (isort)
-      run: |
-        isort --check .
-
-    - name: Run Ruff
-      run: |
-        ruff check --output-format=github
-
-    - name: Run Ruff format check
-      run: |
-        ruff format --check
-
-    - name: Mypy
-      run: |
-        mypy freqtrade scripts tests
-
-    - name: Discord notification
-      uses: rjstone/discord-webhook-notify@v1
-      if: failure() && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false)
-      with:
-          severity: error
-          details: Freqtrade CI failed on ${{ matrix.os }}
-          webhookUrl: ${{ secrets.DISCORD_WEBHOOK }}
-
-  build-macos:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ "macos-12", "macos-13", "macos-14" ]
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
-        exclude:
-          - os: "macos-14"
-            python-version: "3.9"
-
-    steps:
-    - uses: actions/checkout@v4
-
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
-        check-latest: true
-
-    - name: Cache_dependencies
-      uses: actions/cache@v4
-      id: cache
-      with:
-        path: ~/dependencies/
-        key: ${{ matrix.os }}-dependencies
-
-    - name: pip cache (macOS)
-      uses: actions/cache@v4
-      with:
-        path: ~/Library/Caches/pip
-        key: ${{ matrix.os }}-${{ matrix.python-version }}-pip
-
-    - name: TA binary *nix
-      if: steps.cache.outputs.cache-hit != 'true'
-      run: |
-        cd build_helpers && ./install_ta-lib.sh ${HOME}/dependencies/; cd ..
-
-    - name: Installation - macOS (Brew)
-      run: |
-        # brew update
-        # TODO: Should be the brew upgrade
-        # homebrew fails to update python due to unlinking failures
-        # https://github.com/actions/runner-images/issues/6817
-        rm /usr/local/bin/2to3 || true
-        rm /usr/local/bin/2to3-3.11 || true
-        rm /usr/local/bin/2to3-3.12 || true
-        rm /usr/local/bin/idle3 || true
-        rm /usr/local/bin/idle3.11 || true
-        rm /usr/local/bin/idle3.12 || true
-        rm /usr/local/bin/pydoc3 || true
-        rm /usr/local/bin/pydoc3.11 || true
-        rm /usr/local/bin/pydoc3.12 || true
-        rm /usr/local/bin/python3 || true
-        rm /usr/local/bin/python3.11 || true
-        rm /usr/local/bin/python3.12 || true
-        rm /usr/local/bin/python3-config || true
-        rm /usr/local/bin/python3.11-config || true
-        rm /usr/local/bin/python3.12-config || true
-
-        brew install hdf5 c-blosc libomp
-
-    - name: Installation (python)
-      run: |
-        python -m pip install --upgrade pip wheel
-        export LD_LIBRARY_PATH=${HOME}/dependencies/lib:$LD_LIBRARY_PATH
-        export TA_LIBRARY_PATH=${HOME}/dependencies/lib
-        export TA_INCLUDE_PATH=${HOME}/dependencies/include
-        pip install -r requirements-dev.txt
-        pip install -e ft_client/
-        pip install -e .
-
-    - name: Tests
-      run: |
-        pytest --random-order
-
-    - name: Check for repository changes
-      run: |
-        if [ -n "$(git status --porcelain)" ]; then
-          echo "Repository is dirty, changes detected:"
-          git status
-          git diff
-          exit 1
-        else
-          echo "Repository is clean, no changes detected."
-        fi
-
-    - name: Backtesting
-      run: |
-        cp tests/testdata/config.tests.json config.json
-        freqtrade create-userdir --userdir user_data
-        freqtrade new-strategy -s AwesomeStrategyAdv --template advanced
-        freqtrade backtesting --datadir tests/testdata --strategy AwesomeStrategyAdv
-
-    - name: Hyperopt
-      run: |
-        cp tests/testdata/config.tests.json config.json
-        freqtrade create-userdir --userdir user_data
-        freqtrade hyperopt --datadir tests/testdata -e 5 --strategy SampleStrategy --hyperopt-loss SharpeHyperOptLossDaily --print-all
-
-    - name: Sort imports (isort)
-      run: |
-        isort --check .
-
-    - name: Run Ruff
-      run: |
-        ruff check --output-format=github
-
-    - name: Run Ruff format check
-      run: |
-        ruff format --check
-
-    - name: Mypy
-      run: |
-        mypy freqtrade scripts
-
-    - name: Discord notification
-      uses: rjstone/discord-webhook-notify@v1
-      if: failure() && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false)
-      with:
-          severity: info
-          details: Test Succeeded!
-          webhookUrl: ${{ secrets.DISCORD_WEBHOOK }}
-
-  build-windows:
-
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ windows-latest ]
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
-
-    steps:
-    - uses: actions/checkout@v4
-
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python-version }}
-
-    - name: Pip cache (Windows)
-      uses: actions/cache@v4
-      with:
-        path: ~\AppData\Local\pip\Cache
-        key: ${{ matrix.os }}-${{ matrix.python-version }}-pip
-
-    - name: Installation
-      run: |
-        ./build_helpers/install_windows.ps1
-
-    - name: Tests
-      run: |
-        pytest --random-order
-
-    - name: Check for repository changes
-      run: |
-        if (git status --porcelain) {
-          Write-Host "Repository is dirty, changes detected:"
-          git status
-          git diff
-          exit 1
-        }
-        else {
-          Write-Host "Repository is clean, no changes detected."
-        }
-
-    - name: Backtesting
-      run: |
-        cp tests/testdata/config.tests.json config.json
-        freqtrade create-userdir --userdir user_data
-        freqtrade backtesting --datadir tests/testdata --strategy SampleStrategy
-
-    - name: Hyperopt
-      run: |
-        cp tests/testdata/config.tests.json config.json
-        freqtrade create-userdir --userdir user_data
-        freqtrade hyperopt --datadir tests/testdata -e 5 --strategy SampleStrategy --hyperopt-loss SharpeHyperOptLossDaily --print-all
-
-    - name: Run Ruff
-      run: |
-        ruff check --output-format=github
-
-    - name: Run Ruff format check
-      run: |
-        ruff format --check
-
-    - name: Mypy
-      run: |
-        mypy freqtrade scripts tests
-
-    - name: Run Pester tests (PowerShell)
-      run: |
-        $PSVersionTable
-        Set-PSRepository psgallery -InstallationPolicy trusted
-        Install-Module -Name Pester -RequiredVersion 5.3.1 -Confirm:$false -Force -SkipPublisherCheck
-        $Error.clear()
-        Invoke-Pester -Path "tests" -CI
-        if ($Error.Length -gt 0) {exit 1}
-
-      shell: powershell
-
-    - name: Discord notification
-      uses: rjstone/discord-webhook-notify@v1
-      if: failure() && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false)
-      with:
-          severity: error
-          details: Test Failed
-          webhookUrl: ${{ secrets.DISCORD_WEBHOOK }}
-
-  mypy-version-check:
-    runs-on: ubuntu-22.04
-    steps:
-    - uses: actions/checkout@v4
-
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: "3.12"
-
-    - name: pre-commit dependencies
-      run: |
-        pip install pyaml
-        python build_helpers/pre_commit_update.py
-
-  pre-commit:
-    runs-on: ubuntu-22.04
-    steps:
-    - uses: actions/checkout@v4
-
-    - uses: actions/setup-python@v5
-      with:
-        python-version: "3.12"
-    - uses: pre-commit/action@v3.0.1
-
-  docs-check:
-    runs-on: ubuntu-22.04
-    steps:
-    - uses: actions/checkout@v4
-
-    - name: Documentation syntax
-      run: |
-        ./tests/test_docs.sh
-
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: "3.12"
-
-    - name: Documentation build
-      run: |
-        pip install -r docs/requirements-docs.txt
-        mkdocs build
-
-    - name: Discord notification
-      uses: rjstone/discord-webhook-notify@v1
-      if: failure() && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false)
-      with:
-          severity: error
-          details: Freqtrade doc test failed!
-          webhookUrl: ${{ secrets.DISCORD_WEBHOOK }}
-
-
-  build-linux-online:
-    # Run pytest with "live" checks
-    runs-on: ubuntu-22.04
-    steps:
-    - uses: actions/checkout@v4
-
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: "3.12"
-
-    - name: Cache_dependencies
-      uses: actions/cache@v4
-      id: cache
-      with:
-        path: ~/dependencies/
-        key: ${{ runner.os }}-dependencies
-
-    - name: pip cache (linux)
-      uses: actions/cache@v4
-      with:
-        path: ~/.cache/pip
-        key: test-${{ matrix.os }}-${{ matrix.python-version }}-pip
-
-    - name: TA binary *nix
-      if: steps.cache.outputs.cache-hit != 'true'
-      run: |
-        cd build_helpers && ./install_ta-lib.sh ${HOME}/dependencies/; cd ..
-
-    - name: Installation - *nix
-      run: |
-        python -m pip install --upgrade pip wheel
-        export LD_LIBRARY_PATH=${HOME}/dependencies/lib:$LD_LIBRARY_PATH
-        export TA_LIBRARY_PATH=${HOME}/dependencies/lib
-        export TA_INCLUDE_PATH=${HOME}/dependencies/include
-        pip install -r requirements-dev.txt
-        pip install -e ft_client/
-        pip install -e .
-
-    - name: Tests incl. ccxt compatibility tests
-      env:
-        CI_WEB_PROXY: http://152.67.78.211:13128
-      run: |
-        pytest --random-order --longrun --durations 20 -n auto
-
-
-  # Notify only once - when CI completes (and after deploy) in case it's successful
-  notify-complete:
-    needs: [
-      build-linux,
-      build-macos,
-      build-windows,
-      docs-check,
-      mypy-version-check,
-      pre-commit,
-      build-linux-online
-    ]
-    runs-on: ubuntu-22.04
-    # Discord notification can't handle schedule events
-    if: github.event_name != 'schedule' && github.repository == 'freqtrade/freqtrade'
-    permissions:
-      repository-projects: read
-    steps:
-
-    - name: Check user permission
-      id: check
-      uses: scherermichael-oss/action-has-permission@1.0.6
-      with:
-        required-permission: write
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-    - name: Discord notification
-      uses: rjstone/discord-webhook-notify@v1
-      if: always() && steps.check.outputs.has-permission && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false)
-      with:
-          severity: info
-          details: Test Completed!
-          webhookUrl: ${{ secrets.DISCORD_WEBHOOK }}
-
-  build:
-    name: "Build"
-    needs: [ build-linux, build-macos, build-windows, docs-check, mypy-version-check, pre-commit ]
-    runs-on: ubuntu-22.04
-
-    steps:
-    - uses: actions/checkout@v4
-
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: "3.12"
-
-    - name: Build distribution
-      run: |
-        pip install -U build
-        python -m build --sdist --wheel
-
-    - name: Upload artifacts 📦
-      uses: actions/upload-artifact@v4
-      with:
-        name: freqtrade-build
-        path: |
-          dist
-        retention-days: 10
-
-    - name: Build Client distribution
-      run: |
-        pip install -U build
-        python -m build --sdist --wheel ft_client
-
-    - name: Upload artifacts 📦
-      uses: actions/upload-artifact@v4
-      with:
-        name: freqtrade-client-build
-        path: |
-          ft_client/dist
-        retention-days: 10
-
-  deploy-pypi:
-    name: "Deploy to PyPI"
-    needs: [ build ]
-    runs-on: ubuntu-22.04
-    if: (github.event_name == 'release')
-    environment:
-      name: release
-      url: https://pypi.org/p/freqtrade
-    permissions:
-      id-token: write
-
-    steps:
-    - uses: actions/checkout@v4
-
-    - name: Download artifact  📦
-      uses: actions/download-artifact@v4
-      with:
-        pattern: freqtrade*-build
-        path: dist
-        merge-multiple: true
-
-
-    - name: Publish to PyPI (Test)
-      uses: pypa/gh-action-pypi-publish@v1.10.2
-      with:
-        repository-url: https://test.pypi.org/legacy/
-
-    - name: Publish to PyPI
-      uses: pypa/gh-action-pypi-publish@v1.10.2
-
-
-  deploy-docker:
-    needs: [ build-linux, build-macos, build-windows, docs-check, mypy-version-check, pre-commit ]
-    runs-on: ubuntu-22.04
-
-    if: (github.event_name == 'push' || github.event_name == 'schedule' || github.event_name == 'release') && github.repository == 'freqtrade/freqtrade'
-
-    steps:
-    - uses: actions/checkout@v4
-
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: "3.12"
-
-    - name: Extract branch name
-      id: extract-branch
-      run: |
-        echo "GITHUB_REF='${GITHUB_REF}'"
-        echo "branch=${GITHUB_REF##*/}" >> "$GITHUB_OUTPUT"
-
-    - name: Dockerhub login
-      env:
-        DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
-        DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
-      run: |
-        echo "${DOCKER_PASSWORD}" | docker login --username ${DOCKER_USERNAME} --password-stdin
-
-    # We need docker experimental to pull the ARM image.
-    - name: Switch docker to experimental
-      run: |
-          docker version -f '{{.Server.Experimental}}'
-          echo $'{\n    "experimental": true\n}' | sudo tee /etc/docker/daemon.json
-          sudo systemctl restart docker
-          docker version -f '{{.Server.Experimental}}'
-
-    - name: Set up QEMU
-      uses: docker/setup-qemu-action@v3
-
-    - name: Set up Docker Buildx
-      id: buildx
-      uses: docker/setup-buildx-action@v3
-
-    - name: Available platforms
-      run: echo ${{ steps.buildx.outputs.platforms }}
-
-    - name: Build and test and push docker images
-      env:
-        BRANCH_NAME: ${{ steps.extract-branch.outputs.branch }}
-      run: |
-        build_helpers/publish_docker_multi.sh
-
-  deploy-arm:
-    name: "Deploy Docker"
-    permissions:
-      packages: write
-    needs: [ deploy-docker ]
-    # Only run on 64bit machines
-    runs-on: [self-hosted, linux, ARM64]
-    if: (github.event_name == 'push' || github.event_name == 'schedule' || github.event_name == 'release') && github.repository == 'freqtrade/freqtrade'
-
-    steps:
-    - uses: actions/checkout@v4
-
-    - name: Extract branch name
-      id: extract-branch
-      run: |
-        echo "GITHUB_REF='${GITHUB_REF}'"
-        echo "branch=${GITHUB_REF##*/}" >> "$GITHUB_OUTPUT"
-
-    - name: Dockerhub login
-      env:
-        DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
-        DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
-      run: |
-        echo "${DOCKER_PASSWORD}" | docker login --username ${DOCKER_USERNAME} --password-stdin
-
-    - name: Build and test and push docker images
-      env:
-        BRANCH_NAME: ${{ steps.extract-branch.outputs.branch }}
-        GHCR_USERNAME: ${{ github.actor }}
-        GHCR_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      run: |
-        build_helpers/publish_docker_arm64.sh
-
-    - name: Discord notification
-      uses: rjstone/discord-webhook-notify@v1
-      if: always() && ( github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false) && (github.event_name != 'schedule')
-      with:
-          severity: info
-          details: Deploy Succeeded!
-          webhookUrl: ${{ secrets.DISCORD_WEBHOOK }}

.github/workflows/deploy-docs.yml

@@ -1,55 +0,0 @@
-name: Build Documentation
-
-on:
-  push:
-    branches:
-      - develop
-  release:
-    types: [published]
-
-
-# disable permissions for all of the available permissions
-permissions: {}
-
-
-jobs:
-  build-docs:
-    permissions:
-      contents: write  #  for mike to push
-    name: Deploy Docs through mike
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.12'
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r docs/requirements-docs.txt
-
-      - name: Fetch gh-pages branch
-        run: |
-          git fetch origin gh-pages --depth=1
-
-      - name: Configure Git user
-        run: |
-          git config --local user.email "github-actions[bot]@users.noreply.github.com"
-          git config --local user.name "github-actions[bot]"
-
-      - name: Build and push Mike
-        if: ${{ github.event_name == 'push' }}
-        run: |
-          mike deploy ${{ github.ref_name }} latest --push --update-aliases
-
-      - name: Build and push Mike - Release
-        if: ${{ github.event_name == 'release' }}
-        run: |
-          mike deploy ${{ github.ref_name }} stable --push --update-aliases
-
-      - name: Show mike versions
-        run: |
-          mike list

.github/workflows/devcontainer-build.yml

@@ -1,45 +0,0 @@
-name: Devcontainer Pre-Build
-
-on:
-  workflow_dispatch:
-  schedule:
-    - cron: "0 3 * * 0"
-  # push:
-  #   branches:
-  #     - "master"
-  #   tags:
-  #     - "v*.*.*"
-  #   pull_requests:
-  #     branches:
-  #       - "master"
-
-concurrency:
-  group: "${{ github.workflow }}"
-  cancel-in-progress: true
-
-permissions:
-  packages: write
-
-jobs:
-  build-and-push:
-    runs-on: ubuntu-latest
-    steps:
-    -
-      name: Checkout
-      id: checkout
-      uses: actions/checkout@v4
-    -
-        name: Login to GitHub Container Registry
-        uses: docker/login-action@v3
-        with:
-          registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-    -
-        name: Pre-build dev container image
-        uses: devcontainers/ci@v0.3
-        with:
-          subFolder: .github
-          imageName: ghcr.io/${{ github.repository }}-devcontainer
-          cacheFrom: ghcr.io/${{ github.repository }}-devcontainer
-          push: always

.github/workflows/docker-update-readme.yml

@@ -1,18 +0,0 @@
-name: Update Docker Hub Description
-on:
-  push:
-    branches:
-    - stable
-
-jobs:
-  dockerHubDescription:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-
-    - name: Docker Hub Description
-      uses: peter-evans/dockerhub-description@v4
-      with:
-        username: ${{ secrets.DOCKER_USERNAME }}
-        password: ${{ secrets.DOCKER_PASSWORD }}
-        repository: freqtradeorg/freqtrade

.github/workflows/pre-commit-update.yml

@@ -1,41 +0,0 @@
-name: Pre-commit auto-update
-
-on:
-  schedule:
-    - cron: "0 3 * * 2"
-  # on demand
-  workflow_dispatch:
-
-permissions:
-  contents: read
-
-jobs:
-  auto-update:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-
-    - uses: actions/setup-python@v5
-      with:
-        python-version: "3.12"
-
-
-    - name: Install pre-commit
-      run: pip install pre-commit
-
-    - name: Run auto-update
-      run: pre-commit autoupdate
-
-    - uses: peter-evans/create-pull-request@v7
-      with:
-        token: ${{ secrets.REPO_SCOPED_TOKEN }}
-        add-paths: .pre-commit-config.yaml
-        labels: |
-          Tech maintenance
-          Dependencies
-        branch: update/pre-commit-hooks
-        title: Update pre-commit hooks
-        commit-message: "chore: update pre-commit hooks"
-        committer: Freqtrade Bot <noreply@github.com>
-        body: Update versions of pre-commit hooks to latest version.
-        delete-branch: true

.gitignore

@@ -1,118 +0,0 @@
-# Freqtrade rules
-config*.json
-*.sqlite
-*.sqlite-shm
-*.sqlite-wal
-logfile.txt
-user_data/*
-!user_data/strategy/sample_strategy.py
-!user_data/notebooks
-!user_data/models
-!user_data/freqaimodels
-user_data/freqaimodels/*
-user_data/models/*
-user_data/notebooks/*
-freqtrade-plot.html
-freqtrade-profit-plot.html
-freqtrade/rpc/api_server/ui/*
-build_helpers/ta-lib/*
-
-# Macos related
-.DS_Store
-
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-env/
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-.hypothesis/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# memray
-memray-*
-
-# Sphinx documentation
-docs/_build/
-# Mkdocs documentation
-site/
-
-# PyBuilder
-target/
-
-# Jupyter Notebook
-*.ipynb_checkpoints
-
-# pyenv
-.python-version
-
-.env
-.venv
-.idea
-.vscode
-
-.pytest_cache/
-.mypy_cache/
-
-#exceptions
-!*.gitkeep
-!config_examples/config_binance.example.json
-!config_examples/config_full.example.json
-!config_examples/config_kraken.example.json
-!config_examples/config_freqai.example.json
-
-docker-compose-*.yml

.pre-commit-config.yaml

@@ -1,64 +0,0 @@
-# See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
-repos:
-  - repo: https://github.com/pycqa/flake8
-    rev: "7.1.1"
-    hooks:
-      - id: flake8
-        additional_dependencies: [Flake8-pyproject]
-        # stages: [push]
-
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: "v1.11.2"
-    hooks:
-      - id: mypy
-        exclude: build_helpers
-        additional_dependencies:
-          - types-cachetools==5.5.0.20240820
-          - types-filelock==3.2.7
-          - types-requests==2.32.0.20240914
-          - types-tabulate==0.9.0.20240106
-          - types-python-dateutil==2.9.0.20240906
-          - SQLAlchemy==2.0.35
-        # stages: [push]
-
-  - repo: https://github.com/pycqa/isort
-    rev: "5.13.2"
-    hooks:
-      - id: isort
-        name: isort (python)
-        # stages: [push]
-
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
-    # Ruff version.
-    rev: 'v0.6.7'
-    hooks:
-      - id: ruff
-      - id: ruff-format
-
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
-    hooks:
-      - id: end-of-file-fixer
-        exclude: |
-            (?x)^(
-                tests/.*|
-                .*\.svg|
-                .*\.yml|
-                .*\.json
-            )$
-      - id: mixed-line-ending
-      - id: debug-statements
-      - id: check-ast
-      - id: trailing-whitespace
-        exclude: |
-          (?x)^(
-                .*\.md
-            )$
-
-  - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
-    hooks:
-    - id: codespell
-      additional_dependencies:
-        - tomli

.pylintrc

@@ -1,9 +0,0 @@
-[MASTER]
-extension-pkg-whitelist=numpy,talib,talib.abstract
-
-[BASIC]
-good-names=logger
-ignore=vendor
-
-[TYPECHECK]
-ignored-modules=numpy,talib,talib.abstract

.readthedocs.yml

@@ -1,14 +0,0 @@
-# .readthedocs.yml
-version: 2
-
-build:
-  os: "ubuntu-22.04"
-  tools:
-    python: "3.11"
-
-python:
-  install:
-    - requirements: docs/requirements-docs.txt
-
-mkdocs:
-  configuration: mkdocs.yml

.vscode/extensions.json

@@ -1,11 +0,0 @@
-{
-    "recommendations": [
-        "ms-python.python",
-        "ms-python.vscode-pylance",
-        "charliermarsh.ruff",
-        "davidanson.vscode-markdownlint",
-        "ms-azuretools.vscode-docker",
-        "vscode-icons-team.vscode-icons",
-        "github.vscode-github-actions",
-    ]
-}

404.html

@@ -0,0 +1,27 @@
+<script>
+    // Check if the current path is versioned, if not, redirect to the default versioned path
+    const versions = ["stable"]
+    const defaultVersion = "stable"
+    const basePath = "en/"
+    const targetRedirectPath = "404" // path to redirect to, relative to basePath
+
+    // if path starts with version, redirect to versioned 404
+    let foundVersion = false
+    versions.forEach(version => {
+        const versionedPath = `${basePath}/${version}`;
+        if (window.location.pathname.startsWith(versionedPath)) {
+             // we need this foundVersion guard because the browser is fast and
+             // will keep the executing code below until the redirect happens
+            foundVersion = true;
+            window.location.href = `${versionedPath}/${targetRedirectPath}`
+        }
+    });
+
+    // if path doesn't start with any version, redirect to defaultVersion
+    // Replace it in href, so we keep hashes and query params
+    // Only replace first occurence of basePath
+    if (!foundVersion){
+        //window.location.href = window.location.href.replace(basePath, `${basePath}/${defaultVersion}`)
+        window.location.href = `https://${window.location.hostname}/${basePath}/${defaultVersion}`
+    }
+</script>

CNAME

@@ -0,0 +1 @@
+www.freqtrade.io

CONTRIBUTING.md

@@ -1,135 +0,0 @@
-# Contributing
-
-## Contribute to freqtrade
-
-Feel like our bot is missing a feature? We welcome your pull requests! 
-
-Issues labeled [good first issue](https://github.com/freqtrade/freqtrade/labels/good%20first%20issue) can be good first contributions, and will help get you familiar with the codebase.
-
-Few pointers for contributions:
-
-- Create your PR against the `develop` branch, not `stable`.
-- New features need to contain unit tests, must conform to PEP8 (max-line-length = 100) and should be documented with the introduction PR.
-- PR's can be declared as `[WIP]` - which signify Work in Progress Pull Requests (which are not finished).
-
-If you are unsure, discuss the feature on our [discord server](https://discord.gg/p7nuUNVfP7) or in a [issue](https://github.com/freqtrade/freqtrade/issues) before a Pull Request.
-
-## Getting started
-
-Best start by reading the [documentation](https://www.freqtrade.io/) to get a feel for what is possible with the bot, or head straight to the [Developer-documentation](https://www.freqtrade.io/en/latest/developer/) (WIP) which should help you getting started.
-
-## Before sending the PR
-
-### 1. Run unit tests
-
-All unit tests must pass. If a unit test is broken, change your code to 
-make it pass. It means you have introduced a regression.
-
-#### Test the whole project
-
-```bash
-pytest
-```
-
-#### Test only one file
-
-```bash
-pytest tests/test_<file_name>.py
-```
-
-#### Test only one method from one file
-
-```bash
-pytest tests/test_<file_name>.py::test_<method_name>
-```
-
-### 2. Test if your code is PEP8 compliant
-
-#### Run Ruff
-
-```bash
-ruff check .
-```
-
-We receive a lot of code that fails the `ruff` checks.
-To help with that, we encourage you to install the git pre-commit 
-hook that will warn you when you try to commit code that fails these checks.
-
-you can manually run pre-commit with `pre-commit run -a`.
-
-##### Additional styles applied
-
-* Have docstrings on all public methods
-* Use double-quotes for docstrings
-* Multiline docstrings should be indented to the level of the first quote
-* Doc-strings should follow the reST format (`:param xxx: ...`, `:return: ...`, `:raises KeyError: ... `)
-
-### 3. Test if all type-hints are correct
-
-#### Run mypy
-
-``` bash
-mypy freqtrade
-```
-
-### 4. Ensure formatting is correct
-
-#### Run ruff
-
-``` bash
-ruff format .
-```
-
-## (Core)-Committer Guide
-
-### Process: Pull Requests
-
-How to prioritize pull requests, from most to least important:
-
-1. Fixes for broken tests. Broken means broken on any supported platform or Python version.
-1. Extra tests to cover corner cases.
-1. Minor edits to docs.
-1. Bug fixes.
-1. Major edits to docs.
-1. Features.
-
-Ensure that each pull request meets all requirements in the Contributing document.
-
-### Process: Issues
-
-If an issue is a bug that needs an urgent fix, mark it for the next patch release.
-Then either fix it or mark as please-help.
-
-For other issues: encourage friendly discussion, moderate debate, offer your thoughts.
-
-### Process: Your own code changes
-
-All code changes, regardless of who does them, need to be reviewed and merged by someone else.
-This rule applies to all the core committers.
-
-Exceptions:
-
-- Minor corrections and fixes to pull requests submitted by others.
-- While making a formal release, the release manager can make necessary, appropriate changes.
-- Small documentation changes that reinforce existing subject matter. Most commonly being, but not limited to spelling and grammar corrections.
-
-### Responsibilities
-
-- Ensure cross-platform compatibility for every change that's accepted. Windows, Mac & Linux.
-- Ensure no malicious code is introduced into the core code.
-- Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
-- Keep feature versions as small as possible, preferably one new feature per version.
-- Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See the Python Community Code of Conduct (https://www.python.org/psf/codeofconduct/).
-
-### Becoming a Committer
-
-Contributors may be given commit privileges. Preference will be given to those with:
-
-1. Past contributions to Freqtrade and other related open-source projects. Contributions to Freqtrade include both code (both accepted and pending) and friendly participation in the issue tracker and Pull request reviews. Both quantity and quality are considered.
-1. A coding style that the other core committers find simple, minimal, and clean.
-1. Access to resources for cross-platform development and testing.
-1. Time to devote to the project regularly.
-
-Being a Committer does not grant write permission on `develop` or `stable` for security reasons (Users trust Freqtrade with their Exchange API keys).
-
-After being Committer for some time, a Committer may be named Core Committer and given full repository access.

Dockerfile

@@ -1,58 +0,0 @@
-FROM python:3.12.6-slim-bookworm as base
-
-# Setup env
-ENV LANG C.UTF-8
-ENV LC_ALL C.UTF-8
-ENV PYTHONDONTWRITEBYTECODE 1
-ENV PYTHONFAULTHANDLER 1
-ENV PATH=/home/ftuser/.local/bin:$PATH
-ENV FT_APP_ENV="docker"
-
-# Prepare environment
-RUN mkdir /freqtrade \
-  && apt-get update \
-  && apt-get -y install sudo libatlas3-base curl sqlite3 libhdf5-serial-dev libgomp1 \
-  && apt-get clean \
-  && useradd -u 1000 -G sudo -U -m -s /bin/bash ftuser \
-  && chown ftuser:ftuser /freqtrade \
-  # Allow sudoers
-  && echo "ftuser ALL=(ALL) NOPASSWD: /bin/chown" >> /etc/sudoers
-
-WORKDIR /freqtrade
-
-# Install dependencies
-FROM base as python-deps
-RUN  apt-get update \
-  && apt-get -y install build-essential libssl-dev git libffi-dev libgfortran5 pkg-config cmake gcc \
-  && apt-get clean \
-  && pip install --upgrade pip wheel
-
-# Install TA-lib
-COPY build_helpers/* /tmp/
-RUN cd /tmp && /tmp/install_ta-lib.sh && rm -r /tmp/*ta-lib*
-ENV LD_LIBRARY_PATH /usr/local/lib
-
-# Install dependencies
-COPY --chown=ftuser:ftuser requirements.txt requirements-hyperopt.txt /freqtrade/
-USER ftuser
-RUN  pip install --user --no-cache-dir "numpy<2.0" \
-  && pip install --user --no-cache-dir -r requirements-hyperopt.txt
-
-# Copy dependencies to runtime-image
-FROM base as runtime-image
-COPY --from=python-deps /usr/local/lib /usr/local/lib
-ENV LD_LIBRARY_PATH /usr/local/lib
-
-COPY --from=python-deps --chown=ftuser:ftuser /home/ftuser/.local /home/ftuser/.local
-
-USER ftuser
-# Install and execute
-COPY --chown=ftuser:ftuser . /freqtrade/
-
-RUN pip install -e . --user --no-cache-dir --no-build-isolation \
-  && mkdir /freqtrade/user_data/ \
-  && freqtrade install-ui
-
-ENTRYPOINT ["freqtrade"]
-# Default to trade mode
-CMD [ "trade" ]

LICENSE

@@ -1,674 +0,0 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-                            Preamble
-
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    {one line to give the program's name and a brief idea of what it does.}
-    Copyright (C) {year}  {name of author}
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    {project}  Copyright (C) {year}  {fullname}
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.

MANIFEST.in

@@ -1,9 +0,0 @@
-include LICENSE
-include README.md
-recursive-include freqtrade *.py
-recursive-include freqtrade/templates/ *.j2 *.ipynb
-include freqtrade/exchange/binance_leverage_tiers.json
-include freqtrade/rpc/api_server/ui/fallback_file.html
-include freqtrade/rpc/api_server/ui/favicon.ico
-
-prune tests

README.md

@@ -1,226 +0,0 @@
-# ![freqtrade](https://raw.githubusercontent.com/freqtrade/freqtrade/develop/docs/assets/freqtrade_poweredby.svg)
-
-[![Freqtrade CI](https://github.com/freqtrade/freqtrade/workflows/Freqtrade%20CI/badge.svg)](https://github.com/freqtrade/freqtrade/actions/)
-[![DOI](https://joss.theoj.org/papers/10.21105/joss.04864/status.svg)](https://doi.org/10.21105/joss.04864)
-[![Coverage Status](https://coveralls.io/repos/github/freqtrade/freqtrade/badge.svg?branch=develop&service=github)](https://coveralls.io/github/freqtrade/freqtrade?branch=develop)
-[![Documentation](https://readthedocs.org/projects/freqtrade/badge/)](https://www.freqtrade.io)
-[![Maintainability](https://api.codeclimate.com/v1/badges/5737e6d668200b7518ff/maintainability)](https://codeclimate.com/github/freqtrade/freqtrade/maintainability)
-
-Freqtrade is a free and open source crypto trading bot written in Python. It is designed to support all major exchanges and be controlled via Telegram or webUI. It contains backtesting, plotting and money management tools as well as strategy optimization by machine learning.
-
-![freqtrade](https://raw.githubusercontent.com/freqtrade/freqtrade/develop/docs/assets/freqtrade-screenshot.png)
-
-## Disclaimer
-
-This software is for educational purposes only. Do not risk money which
-you are afraid to lose. USE THE SOFTWARE AT YOUR OWN RISK. THE AUTHORS
-AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR TRADING RESULTS.
-
-Always start by running a trading bot in Dry-run and do not engage money
-before you understand how it works and what profit/loss you should
-expect.
-
-We strongly recommend you to have coding and Python knowledge. Do not
-hesitate to read the source code and understand the mechanism of this bot.
-
-## Supported Exchange marketplaces
-
-Please read the [exchange specific notes](docs/exchanges.md) to learn about eventual, special configurations needed for each exchange.
-
-- [X] [Binance](https://www.binance.com/)
-- [X] [Bitmart](https://bitmart.com/)
-- [X] [BingX](https://bingx.com/invite/0EM9RX)
-- [X] [Bybit](https://bybit.com/)
-- [X] [Gate.io](https://www.gate.io/ref/6266643)
-- [X] [HTX](https://www.htx.com/) (Former Huobi)
-- [X] [Kraken](https://kraken.com/)
-- [X] [OKX](https://okx.com/) (Former OKEX)
-- [ ] [potentially many others](https://github.com/ccxt/ccxt/). _(We cannot guarantee they will work)_
-
-### Supported Futures Exchanges (experimental)
-
-- [X] [Binance](https://www.binance.com/)
-- [X] [Gate.io](https://www.gate.io/ref/6266643)
-- [X] [OKX](https://okx.com/)
-- [X] [Bybit](https://bybit.com/)
-
-Please make sure to read the [exchange specific notes](docs/exchanges.md), as well as the [trading with leverage](docs/leverage.md) documentation before diving in.
-
-### Community tested
-
-Exchanges confirmed working by the community:
-
-- [X] [Bitvavo](https://bitvavo.com/)
-- [X] [Kucoin](https://www.kucoin.com/)
-
-## Documentation
-
-We invite you to read the bot documentation to ensure you understand how the bot is working.
-
-Please find the complete documentation on the [freqtrade website](https://www.freqtrade.io).
-
-## Features
-
-- [x] **Based on Python 3.9+**: For botting on any operating system - Windows, macOS and Linux.
-- [x] **Persistence**: Persistence is achieved through sqlite.
-- [x] **Dry-run**: Run the bot without paying money.
-- [x] **Backtesting**: Run a simulation of your buy/sell strategy.
-- [x] **Strategy Optimization by machine learning**: Use machine learning to optimize your buy/sell strategy parameters with real exchange data.
-- [X] **Adaptive prediction modeling**: Build a smart strategy with FreqAI that self-trains to the market via adaptive machine learning methods. [Learn more](https://www.freqtrade.io/en/stable/freqai/)
-- [x] **Edge position sizing** Calculate your win rate, risk reward ratio, the best stoploss and adjust your position size before taking a position for each specific market. [Learn more](https://www.freqtrade.io/en/stable/edge/).
-- [x] **Whitelist crypto-currencies**: Select which crypto-currency you want to trade or use dynamic whitelists.
-- [x] **Blacklist crypto-currencies**: Select which crypto-currency you want to avoid.
-- [x] **Builtin WebUI**: Builtin web UI to manage your bot.
-- [x] **Manageable via Telegram**: Manage the bot with Telegram.
-- [x] **Display profit/loss in fiat**: Display your profit/loss in fiat currency.
-- [x] **Performance status report**: Provide a performance status of your current trades.
-
-## Quick start
-
-Please refer to the [Docker Quickstart documentation](https://www.freqtrade.io/en/stable/docker_quickstart/) on how to get started quickly.
-
-For further (native) installation methods, please refer to the [Installation documentation page](https://www.freqtrade.io/en/stable/installation/).
-
-## Basic Usage
-
-### Bot commands
-
-```
-usage: freqtrade [-h] [-V]
-                 {trade,create-userdir,new-config,show-config,new-strategy,download-data,convert-data,convert-trade-data,trades-to-ohlcv,list-data,backtesting,backtesting-show,backtesting-analysis,edge,hyperopt,hyperopt-list,hyperopt-show,list-exchanges,list-markets,list-pairs,list-strategies,list-freqaimodels,list-timeframes,show-trades,test-pairlist,convert-db,install-ui,plot-dataframe,plot-profit,webserver,strategy-updater,lookahead-analysis,recursive-analysis}
-                 ...
-
-Free, open source crypto trading bot
-
-positional arguments:
-  {trade,create-userdir,new-config,show-config,new-strategy,download-data,convert-data,convert-trade-data,trades-to-ohlcv,list-data,backtesting,backtesting-show,backtesting-analysis,edge,hyperopt,hyperopt-list,hyperopt-show,list-exchanges,list-markets,list-pairs,list-strategies,list-freqaimodels,list-timeframes,show-trades,test-pairlist,convert-db,install-ui,plot-dataframe,plot-profit,webserver,strategy-updater,lookahead-analysis,recursive-analysis}
-    trade               Trade module.
-    create-userdir      Create user-data directory.
-    new-config          Create new config
-    show-config         Show resolved config
-    new-strategy        Create new strategy
-    download-data       Download backtesting data.
-    convert-data        Convert candle (OHLCV) data from one format to
-                        another.
-    convert-trade-data  Convert trade data from one format to another.
-    trades-to-ohlcv     Convert trade data to OHLCV data.
-    list-data           List downloaded data.
-    backtesting         Backtesting module.
-    backtesting-show    Show past Backtest results
-    backtesting-analysis
-                        Backtest Analysis module.
-    edge                Edge module.
-    hyperopt            Hyperopt module.
-    hyperopt-list       List Hyperopt results
-    hyperopt-show       Show details of Hyperopt results
-    list-exchanges      Print available exchanges.
-    list-markets        Print markets on exchange.
-    list-pairs          Print pairs on exchange.
-    list-strategies     Print available strategies.
-    list-freqaimodels   Print available freqAI models.
-    list-timeframes     Print available timeframes for the exchange.
-    show-trades         Show trades.
-    test-pairlist       Test your pairlist configuration.
-    convert-db          Migrate database to different system
-    install-ui          Install FreqUI
-    plot-dataframe      Plot candles with indicators.
-    plot-profit         Generate plot showing profits.
-    webserver           Webserver module.
-    strategy-updater    updates outdated strategy files to the current version
-    lookahead-analysis  Check for potential look ahead bias.
-    recursive-analysis  Check for potential recursive formula issue.
-
-options:
-  -h, --help            show this help message and exit
-  -V, --version         show program's version number and exit
-
-```
-
-### Telegram RPC commands
-
-Telegram is not mandatory. However, this is a great way to control your bot. More details and the full command list on the [documentation](https://www.freqtrade.io/en/latest/telegram-usage/)
-
-- `/start`: Starts the trader.
-- `/stop`: Stops the trader.
-- `/stopentry`: Stop entering new trades.
-- `/status <trade_id>|[table]`: Lists all or specific open trades.
-- `/profit [<n>]`: Lists cumulative profit from all finished trades, over the last n days.
-- `/forceexit <trade_id>|all`: Instantly exits the given trade (Ignoring `minimum_roi`).
-- `/fx <trade_id>|all`: Alias to `/forceexit`
-- `/performance`: Show performance of each finished trade grouped by pair
-- `/balance`: Show account balance per currency.
-- `/daily <n>`: Shows profit or loss per day, over the last n days.
-- `/help`: Show help message.
-- `/version`: Show version.
-
-## Development branches
-
-The project is currently setup in two main branches:
-
-- `develop` - This branch has often new features, but might also contain breaking changes. We try hard to keep this branch as stable as possible.
-- `stable` - This branch contains the latest stable release. This branch is generally well tested.
-- `feat/*` - These are feature branches, which are being worked on heavily. Please don't use these unless you want to test a specific feature.
-
-## Support
-
-### Help / Discord
-
-For any questions not covered by the documentation or for further information about the bot, or to simply engage with like-minded individuals, we encourage you to join the Freqtrade [discord server](https://discord.gg/p7nuUNVfP7).
-
-### [Bugs / Issues](https://github.com/freqtrade/freqtrade/issues?q=is%3Aissue)
-
-If you discover a bug in the bot, please
-[search the issue tracker](https://github.com/freqtrade/freqtrade/issues?q=is%3Aissue)
-first. If it hasn't been reported, please
-[create a new issue](https://github.com/freqtrade/freqtrade/issues/new/choose) and
-ensure you follow the template guide so that the team can assist you as
-quickly as possible.
-
-For every [issue](https://github.com/freqtrade/freqtrade/issues/new/choose) created, kindly follow up and mark satisfaction or reminder to close issue when equilibrium ground is reached.
-
---Maintain github's [community policy](https://docs.github.com/en/site-policy/github-terms/github-community-code-of-conduct)--
-
-### [Feature Requests](https://github.com/freqtrade/freqtrade/labels/enhancement)
-
-Have you a great idea to improve the bot you want to share? Please,
-first search if this feature was not [already discussed](https://github.com/freqtrade/freqtrade/labels/enhancement).
-If it hasn't been requested, please
-[create a new request](https://github.com/freqtrade/freqtrade/issues/new/choose)
-and ensure you follow the template guide so that it does not get lost
-in the bug reports.
-
-### [Pull Requests](https://github.com/freqtrade/freqtrade/pulls)
-
-Feel like the bot is missing a feature? We welcome your pull requests!
-
-Please read the
-[Contributing document](https://github.com/freqtrade/freqtrade/blob/develop/CONTRIBUTING.md)
-to understand the requirements before sending your pull-requests.
-
-Coding is not a necessity to contribute - maybe start with improving the documentation?
-Issues labeled [good first issue](https://github.com/freqtrade/freqtrade/labels/good%20first%20issue) can be good first contributions, and will help get you familiar with the codebase.
-
-**Note** before starting any major new feature work, *please open an issue describing what you are planning to do* or talk to us on [discord](https://discord.gg/p7nuUNVfP7) (please use the #dev channel for this). This will ensure that interested parties can give valuable feedback on the feature, and let others know that you are working on it.
-
-**Important:** Always create your PR against the `develop` branch, not `stable`.
-
-## Requirements
-
-### Up-to-date clock
-
-The clock must be accurate, synchronized to a NTP server very frequently to avoid problems with communication to the exchanges.
-
-### Minimum hardware required
-
-To run this bot we recommend you a cloud instance with a minimum of:
-
-- Minimal (advised) system requirements: 2GB RAM, 1GB disk space, 2vCPU
-
-### Software requirements
-
-- [Python >= 3.9](http://docs.python-guide.org/en/latest/starting/installation/)
-- [pip](https://pip.pypa.io/en/stable/installing/)
-- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
-- [TA-Lib](https://ta-lib.github.io/ta-lib-python/)
-- [virtualenv](https://virtualenv.pypa.io/en/stable/installation.html) (Recommended)
-- [Docker](https://www.docker.com/products/docker) (Recommended)

build_helpers/binance_update_lev_tiers.py

@@ -1,23 +0,0 @@
-#!/usr/bin/env python3
-import json
-import os
-from pathlib import Path
-
-import ccxt
-
-
-key = os.environ.get("FREQTRADE__EXCHANGE__KEY")
-secret = os.environ.get("FREQTRADE__EXCHANGE__SECRET")
-
-proxy = os.environ.get("CI_WEB_PROXY")
-
-exchange = ccxt.binance(
-    {"apiKey": key, "secret": secret, "httpsProxy": proxy, "options": {"defaultType": "swap"}}
-)
-_ = exchange.load_markets()
-
-lev_tiers = exchange.fetch_leverage_tiers()
-
-# Assumes this is running in the root of the repository.
-file = Path("freqtrade/exchange/binance_leverage_tiers.json")
-json.dump(dict(sorted(lev_tiers.items())), file.open("w"), indent=2)

build_helpers/extract_config_json_schema.py

@@ -1,17 +0,0 @@
-"""Script to extract the configuration json schema from config_schema.py file."""
-
-from pathlib import Path
-
-import rapidjson
-
-from freqtrade.configuration.config_schema import CONF_SCHEMA
-
-
-def extract_config_json_schema():
-    schema_filename = Path(__file__).parent / "schema.json"
-    with schema_filename.open("w") as f:
-        rapidjson.dump(CONF_SCHEMA, f, indent=2)
-
-
-if __name__ == "__main__":
-    extract_config_json_schema()

build_helpers/freqtrade_client_version_align.py

@@ -1,15 +0,0 @@
-#!/usr/bin/env python3
-from freqtrade import __version__ as ft_version
-from freqtrade_client import __version__ as client_version
-
-
-def main():
-    if ft_version != client_version:
-        print(f"Versions do not match: \nft: {ft_version} \nclient: {client_version}")
-        exit(1)
-    print(f"Versions match: ft: {ft_version}, client: {client_version}")
-    exit(0)
-
-
-if __name__ == "__main__":
-    main()

build_helpers/install_ta-lib.sh

@@ -1,35 +0,0 @@
-if [ -z "$1" ]; then
-  INSTALL_LOC=/usr/local
-else
-  INSTALL_LOC=${1}
-fi
-echo "Installing to ${INSTALL_LOC}"
-if [ -n "$2" ] || [ ! -f "${INSTALL_LOC}/lib/libta_lib.a" ]; then
-  tar zxvf ta-lib-0.4.0-src.tar.gz
-  cd ta-lib \
-  && sed -i.bak "s|0.00000001|0.000000000000000001 |g" src/ta_func/ta_utility.h \
-  && echo "Downloading gcc config.guess and config.sub" \
-  && curl -s 'https://raw.githubusercontent.com/gcc-mirror/gcc/master/config.guess' -o config.guess \
-  && curl -s 'https://raw.githubusercontent.com/gcc-mirror/gcc/master/config.sub' -o config.sub \
-  && ./configure --prefix=${INSTALL_LOC}/ \
-  && make
-  if [ $? -ne 0 ]; then
-    echo "Failed building ta-lib."
-    cd .. && rm -rf ./ta-lib/
-    exit 1
-  fi
-  if [ -z "$2" ]; then
-    which sudo && sudo make install || make install
-    if [ -x "$(command -v apt-get)" ]; then
-      echo "Updating library path using ldconfig"
-      sudo ldconfig
-    fi
-  else
-    # Don't install with sudo
-    make install
-  fi
-
-  cd .. && rm -rf ./ta-lib/
-else
-  echo "TA-lib already installed, skipping installation"
-fi

build_helpers/install_windows.ps1

@@ -1,11 +0,0 @@
-# vendored Wheels compiled via https://github.com/xmatthias/ta-lib-python/tree/ta_bundled_040
-
-python -m pip install --upgrade pip wheel
-
-$pyv = python -c "import sys; print(f'{sys.version_info.major}.{sys.version_info.minor}')"
-
-
-pip install --find-links=build_helpers\ --prefer-binary  TA-Lib
-
-pip install -r requirements-dev.txt
-pip install -e .

build_helpers/pre_commit_update.py

@@ -1,49 +0,0 @@
-# File used in CI to ensure pre-commit dependencies are kept up-to-date.
-
-import sys
-from pathlib import Path
-
-import yaml
-
-
-pre_commit_file = Path(".pre-commit-config.yaml")
-require_dev = Path("requirements-dev.txt")
-require = Path("requirements.txt")
-
-with require_dev.open("r") as rfile:
-    requirements = rfile.readlines()
-
-with require.open("r") as rfile:
-    requirements.extend(rfile.readlines())
-
-# Extract types only
-type_reqs = [
-    r.strip("\n") for r in requirements if r.startswith("types-") or r.startswith("SQLAlchemy")
-]
-
-with pre_commit_file.open("r") as file:
-    f = yaml.load(file, Loader=yaml.SafeLoader)
-
-
-mypy_repo = [
-    repo for repo in f["repos"] if repo["repo"] == "https://github.com/pre-commit/mirrors-mypy"
-]
-
-hooks = mypy_repo[0]["hooks"][0]["additional_dependencies"]
-
-errors = []
-for hook in hooks:
-    if hook not in type_reqs:
-        errors.append(f"{hook} is missing in requirements-dev.txt.")
-
-for req in type_reqs:
-    if req not in hooks:
-        errors.append(f"{req} is missing in pre-config file.")
-
-
-if errors:
-    for e in errors:
-        print(e)
-    sys.exit(1)
-
-sys.exit(0)

build_helpers/publish_docker_arm64.sh

@@ -1,119 +0,0 @@
-#!/bin/sh
-
-# Use BuildKit, otherwise building on ARM fails
-export DOCKER_BUILDKIT=1
-
-IMAGE_NAME=freqtradeorg/freqtrade
-CACHE_IMAGE=freqtradeorg/freqtrade_cache
-GHCR_IMAGE_NAME=ghcr.io/freqtrade/freqtrade
-
-# Replace / with _ to create a valid tag
-TAG=$(echo "${BRANCH_NAME}" | sed -e "s/\//_/g")
-TAG_PLOT=${TAG}_plot
-TAG_FREQAI=${TAG}_freqai
-TAG_FREQAI_RL=${TAG_FREQAI}rl
-TAG_FREQAI_TORCH=${TAG_FREQAI}torch
-TAG_PI="${TAG}_pi"
-
-TAG_ARM=${TAG}_arm
-TAG_PLOT_ARM=${TAG_PLOT}_arm
-TAG_FREQAI_ARM=${TAG_FREQAI}_arm
-TAG_FREQAI_RL_ARM=${TAG_FREQAI_RL}_arm
-
-echo "Running for ${TAG}"
-
-# Add commit and commit_message to docker container
-echo "${GITHUB_SHA}" > freqtrade_commit
-
-if [ "${GITHUB_EVENT_NAME}" = "schedule" ]; then
-    echo "event ${GITHUB_EVENT_NAME}: full rebuild - skipping cache"
-    # Build regular image
-    docker build -t freqtrade:${TAG_ARM} .
-
-else
-    echo "event ${GITHUB_EVENT_NAME}: building with cache"
-    # Build regular image
-    docker pull ${IMAGE_NAME}:${TAG_ARM}
-    docker build --cache-from ${IMAGE_NAME}:${TAG_ARM} -t freqtrade:${TAG_ARM} .
-
-fi
-
-if [ $? -ne 0 ]; then
-    echo "failed building multiarch images"
-    return 1
-fi
-
-docker build --build-arg sourceimage=freqtrade --build-arg sourcetag=${TAG_ARM} -t freqtrade:${TAG_PLOT_ARM} -f docker/Dockerfile.plot .
-docker build --build-arg sourceimage=freqtrade --build-arg sourcetag=${TAG_ARM} -t freqtrade:${TAG_FREQAI_ARM} -f docker/Dockerfile.freqai .
-docker build --build-arg sourceimage=freqtrade --build-arg sourcetag=${TAG_FREQAI_ARM} -t freqtrade:${TAG_FREQAI_RL_ARM} -f docker/Dockerfile.freqai_rl .
-
-# Tag image for upload and next build step
-docker tag freqtrade:$TAG_ARM ${CACHE_IMAGE}:$TAG_ARM
-docker tag freqtrade:$TAG_PLOT_ARM ${CACHE_IMAGE}:$TAG_PLOT_ARM
-docker tag freqtrade:$TAG_FREQAI_ARM ${CACHE_IMAGE}:$TAG_FREQAI_ARM
-docker tag freqtrade:$TAG_FREQAI_RL_ARM ${CACHE_IMAGE}:$TAG_FREQAI_RL_ARM
-
-# Run backtest
-docker run --rm -v $(pwd)/tests/testdata/config.tests.json:/freqtrade/config.json:ro -v $(pwd)/tests:/tests freqtrade:${TAG_ARM} backtesting --datadir /tests/testdata --strategy-path /tests/strategy/strats/ --strategy StrategyTestV3
-
-if [ $? -ne 0 ]; then
-    echo "failed running backtest"
-    return 1
-fi
-
-docker images
-
-docker push ${CACHE_IMAGE}:$TAG_PLOT_ARM
-docker push ${CACHE_IMAGE}:$TAG_FREQAI_ARM
-docker push ${CACHE_IMAGE}:$TAG_FREQAI_RL_ARM
-docker push ${CACHE_IMAGE}:$TAG_ARM
-
-# Create multi-arch image
-# Make sure that all images contained here are pushed to github first.
-# Otherwise installation might fail.
-echo "create manifests"
-
-docker manifest create ${IMAGE_NAME}:${TAG} ${CACHE_IMAGE}:${TAG} ${CACHE_IMAGE}:${TAG_ARM} ${IMAGE_NAME}:${TAG_PI}
-docker manifest push -p ${IMAGE_NAME}:${TAG}
-
-docker manifest create ${IMAGE_NAME}:${TAG_PLOT} ${CACHE_IMAGE}:${TAG_PLOT} ${CACHE_IMAGE}:${TAG_PLOT_ARM}
-docker manifest push -p ${IMAGE_NAME}:${TAG_PLOT}
-
-docker manifest create ${IMAGE_NAME}:${TAG_FREQAI} ${CACHE_IMAGE}:${TAG_FREQAI} ${CACHE_IMAGE}:${TAG_FREQAI_ARM}
-docker manifest push -p ${IMAGE_NAME}:${TAG_FREQAI}
-
-docker manifest create ${IMAGE_NAME}:${TAG_FREQAI_RL} ${CACHE_IMAGE}:${TAG_FREQAI_RL} ${CACHE_IMAGE}:${TAG_FREQAI_RL_ARM}
-docker manifest push -p ${IMAGE_NAME}:${TAG_FREQAI_RL}
-
-# Create special Torch tag - which is identical to the RL tag.
-docker manifest create ${IMAGE_NAME}:${TAG_FREQAI_TORCH} ${CACHE_IMAGE}:${TAG_FREQAI_RL} ${CACHE_IMAGE}:${TAG_FREQAI_RL_ARM}
-docker manifest push -p ${IMAGE_NAME}:${TAG_FREQAI_TORCH}
-
-# copy images to ghcr.io
-
-alias crane="docker run --rm -i -v $(pwd)/.crane:/home/nonroot/.docker/ gcr.io/go-containerregistry/crane"
-mkdir .crane
-chmod a+rwx .crane
-
-echo "${GHCR_TOKEN}" | crane auth login ghcr.io -u "${GHCR_USERNAME}" --password-stdin
-
-crane copy ${IMAGE_NAME}:${TAG_FREQAI_RL} ${GHCR_IMAGE_NAME}:${TAG_FREQAI_RL}
-crane copy ${IMAGE_NAME}:${TAG_FREQAI_RL} ${GHCR_IMAGE_NAME}:${TAG_FREQAI_TORCH}
-crane copy ${IMAGE_NAME}:${TAG_FREQAI} ${GHCR_IMAGE_NAME}:${TAG_FREQAI}
-crane copy ${IMAGE_NAME}:${TAG_PLOT} ${GHCR_IMAGE_NAME}:${TAG_PLOT}
-crane copy ${IMAGE_NAME}:${TAG} ${GHCR_IMAGE_NAME}:${TAG}
-
-# Tag as latest for develop builds
-if [ "${TAG}" = "develop" ]; then
-    echo 'Tagging image as latest'
-    docker manifest create ${IMAGE_NAME}:latest ${CACHE_IMAGE}:${TAG_ARM} ${IMAGE_NAME}:${TAG_PI} ${CACHE_IMAGE}:${TAG}
-    docker manifest push -p ${IMAGE_NAME}:latest
-
-    crane copy ${IMAGE_NAME}:latest ${GHCR_IMAGE_NAME}:latest
-fi
-
-docker images
-rm -rf .crane
-
-# Cleanup old images from arm64 node.
-docker image prune -a --force --filter "until=24h"

build_helpers/publish_docker_multi.sh

@@ -1,89 +0,0 @@
-#!/bin/sh
-
-# The below assumes a correctly setup docker buildx environment
-
-IMAGE_NAME=freqtradeorg/freqtrade
-CACHE_IMAGE=freqtradeorg/freqtrade_cache
-# Replace / with _ to create a valid tag
-TAG=$(echo "${BRANCH_NAME}" | sed -e "s/\//_/g")
-TAG_PLOT=${TAG}_plot
-TAG_FREQAI=${TAG}_freqai
-TAG_FREQAI_RL=${TAG_FREQAI}rl
-TAG_PI="${TAG}_pi"
-
-PI_PLATFORM="linux/arm/v7"
-echo "Running for ${TAG}"
-CACHE_TAG=${CACHE_IMAGE}:${TAG_PI}_cache
-
-# Add commit and commit_message to docker container
-echo "${GITHUB_SHA}" > freqtrade_commit
-
-if [ "${GITHUB_EVENT_NAME}" = "schedule" ]; then
-    echo "event ${GITHUB_EVENT_NAME}: full rebuild - skipping cache"
-    # Build regular image
-    docker build -t freqtrade:${TAG} .
-    # Build PI image
-    docker buildx build \
-        --cache-to=type=registry,ref=${CACHE_TAG} \
-        -f docker/Dockerfile.armhf \
-        --platform ${PI_PLATFORM} \
-        -t ${IMAGE_NAME}:${TAG_PI} \
-        --push \
-        --provenance=false \
-        .
-else
-    echo "event ${GITHUB_EVENT_NAME}: building with cache"
-    # Build regular image
-    docker pull ${IMAGE_NAME}:${TAG}
-    docker build --cache-from ${IMAGE_NAME}:${TAG} -t freqtrade:${TAG} .
-
-    # Pull last build to avoid rebuilding the whole image
-    # docker pull --platform ${PI_PLATFORM} ${IMAGE_NAME}:${TAG}
-    # disable provenance due to https://github.com/docker/buildx/issues/1509
-    docker buildx build \
-        --cache-from=type=registry,ref=${CACHE_TAG} \
-        --cache-to=type=registry,ref=${CACHE_TAG} \
-        -f docker/Dockerfile.armhf \
-        --platform ${PI_PLATFORM} \
-        -t ${IMAGE_NAME}:${TAG_PI} \
-        --push \
-        --provenance=false \
-        .
-fi
-
-if [ $? -ne 0 ]; then
-    echo "failed building multiarch images"
-    return 1
-fi
-# Tag image for upload and next build step
-docker tag freqtrade:$TAG ${CACHE_IMAGE}:$TAG
-
-docker build --build-arg sourceimage=freqtrade --build-arg sourcetag=${TAG} -t freqtrade:${TAG_PLOT} -f docker/Dockerfile.plot .
-docker build --build-arg sourceimage=freqtrade --build-arg sourcetag=${TAG} -t freqtrade:${TAG_FREQAI} -f docker/Dockerfile.freqai .
-docker build --build-arg sourceimage=freqtrade --build-arg sourcetag=${TAG_FREQAI} -t freqtrade:${TAG_FREQAI_RL} -f docker/Dockerfile.freqai_rl .
-
-docker tag freqtrade:$TAG_PLOT ${CACHE_IMAGE}:$TAG_PLOT
-docker tag freqtrade:$TAG_FREQAI ${CACHE_IMAGE}:$TAG_FREQAI
-docker tag freqtrade:$TAG_FREQAI_RL ${CACHE_IMAGE}:$TAG_FREQAI_RL
-
-# Run backtest
-docker run --rm -v $(pwd)/tests/testdata/config.tests.json:/freqtrade/config.json:ro -v $(pwd)/tests:/tests freqtrade:${TAG} backtesting --datadir /tests/testdata --strategy-path /tests/strategy/strats/ --strategy StrategyTestV3
-
-if [ $? -ne 0 ]; then
-    echo "failed running backtest"
-    return 1
-fi
-
-docker images
-
-docker push ${CACHE_IMAGE}:$TAG
-docker push ${CACHE_IMAGE}:$TAG_PLOT
-docker push ${CACHE_IMAGE}:$TAG_FREQAI
-docker push ${CACHE_IMAGE}:$TAG_FREQAI_RL
-
-docker images
-
-if [ $? -ne 0 ]; then
-    echo "failed building image"
-    return 1
-fi

config_examples/config_binance.example.json

@@ -1,84 +0,0 @@
-{
-    "$schema": "https://schema.freqtrade.io/schema.json",
-    "max_open_trades": 3,
-    "stake_currency": "USDT",
-    "stake_amount": 0.05,
-    "tradable_balance_ratio": 0.99,
-    "fiat_display_currency": "USD",
-    "timeframe": "5m",
-    "dry_run": true,
-    "cancel_open_orders_on_exit": false,
-    "unfilledtimeout": {
-        "entry": 10,
-        "exit": 10,
-        "exit_timeout_count": 0,
-        "unit": "minutes"
-    },
-    "entry_pricing": {
-        "price_side": "same",
-        "use_order_book": true,
-        "order_book_top": 1,
-        "price_last_balance": 0.0,
-        "check_depth_of_market": {
-            "enabled": false,
-            "bids_to_ask_delta": 1
-        }
-    },
-    "exit_pricing": {
-        "price_side": "same",
-        "use_order_book": true,
-        "order_book_top": 1
-    },
-    "exchange": {
-        "name": "binance",
-        "key": "your_exchange_key",
-        "secret": "your_exchange_secret",
-        "ccxt_config": {},
-        "ccxt_async_config": {
-        },
-        "pair_whitelist": [
-            "ALGO/USDT",
-            "ATOM/USDT",
-            "BAT/USDT",
-            "BCH/USDT",
-            "BRD/USDT",
-            "EOS/USDT",
-            "ETH/USDT",
-            "IOTA/USDT",
-            "LINK/USDT",
-            "LTC/USDT",
-            "NEO/USDT",
-            "NXS/USDT",
-            "XMR/USDT",
-            "XRP/USDT",
-            "XTZ/USDT"
-        ],
-        "pair_blacklist": [
-            "BNB/.*"
-        ]
-    },
-    "pairlists": [
-        {"method": "StaticPairList"}
-    ],
-    "telegram": {
-        "enabled": false,
-        "token": "your_telegram_token",
-        "chat_id": "your_telegram_chat_id"
-    },
-    "api_server": {
-        "enabled": false,
-        "listen_ip_address": "127.0.0.1",
-        "listen_port": 8080,
-        "verbosity": "error",
-        "jwt_secret_key": "somethingrandom",
-        "CORS_origins": [],
-        "username": "freqtrader",
-        "password": "SuperSecurePassword"
-    },
-    "bot_name": "freqtrade",
-    "initial_state": "running",
-    "force_entry_enable": false,
-    "internals": {
-        "process_throttle_secs": 5
-    }
-}

config_examples/config_freqai.example.json

@@ -1,91 +0,0 @@
-{
-    "$schema": "https://schema.freqtrade.io/schema.json",
-    "trading_mode": "futures",
-    "margin_mode": "isolated",
-    "max_open_trades": 5,
-    "stake_currency": "USDT",
-    "stake_amount": 200,
-    "tradable_balance_ratio": 1,
-    "fiat_display_currency": "USD",
-    "dry_run": true,
-    "timeframe": "3m",
-    "dry_run_wallet": 1000,
-    "cancel_open_orders_on_exit": true,
-    "unfilledtimeout": {
-        "entry": 10,
-        "exit": 30
-    },
-    "exchange": {
-        "name": "binance",
-        "key": "",
-        "secret": "",
-        "ccxt_config": {},
-        "ccxt_async_config": {},
-        "pair_whitelist": [
-            "1INCH/USDT:USDT",
-            "ALGO/USDT:USDT"
-        ],
-        "pair_blacklist": []
-    },
-    "entry_pricing": {
-        "price_side": "same",
-        "use_order_book": true,
-        "order_book_top": 1,
-        "price_last_balance": 0.0,
-        "check_depth_of_market": {
-            "enabled": false,
-            "bids_to_ask_delta": 1
-        }
-    },
-    "exit_pricing": {
-        "price_side": "other",
-        "use_order_book": true,
-        "order_book_top": 1
-    },
-    "pairlists": [
-        {
-            "method": "StaticPairList"
-        }
-    ],
-    "freqai": {
-        "enabled": true,
-        "purge_old_models": 2,
-        "train_period_days": 15,
-        "backtest_period_days": 7,
-        "live_retrain_hours": 0,
-        "identifier": "unique-id",
-        "feature_parameters": {
-            "include_timeframes": [
-                "3m",
-                "15m",
-                "1h"
-            ],
-            "include_corr_pairlist": [
-                "BTC/USDT:USDT",
-                "ETH/USDT:USDT"
-            ],
-            "label_period_candles": 20,
-            "include_shifted_candles": 2,
-            "DI_threshold": 0.9,
-            "weight_factor": 0.9,
-            "principal_component_analysis": false,
-            "use_SVM_to_remove_outliers": true,
-            "indicator_periods_candles": [
-                10,
-                20
-            ],
-            "plot_feature_importances": 0
-        },
-        "data_split_parameters": {
-            "test_size": 0.33,
-            "random_state": 1
-        },
-        "model_training_parameters": {}
-    },
-    "bot_name": "",
-    "force_entry_enable": true,
-    "initial_state": "running",
-    "internals": {
-        "process_throttle_secs": 5
-    }
-}

config_examples/config_full.example.json

@@ -1,212 +0,0 @@
-{
-    "$schema": "https://schema.freqtrade.io/schema.json",
-    "max_open_trades": 3,
-    "stake_currency": "BTC",
-    "stake_amount": 0.05,
-    "tradable_balance_ratio": 0.99,
-    "fiat_display_currency": "USD",
-    "amount_reserve_percent": 0.05,
-    "available_capital": 1000,
-    "amend_last_stake_amount": false,
-    "last_stake_amount_min_ratio": 0.5,
-    "dry_run": true,
-    "dry_run_wallet": 1000,
-    "cancel_open_orders_on_exit": false,
-    "timeframe": "5m",
-    "trailing_stop": false,
-    "trailing_stop_positive": 0.005,
-    "trailing_stop_positive_offset": 0.0051,
-    "trailing_only_offset_is_reached": false,
-    "use_exit_signal": true,
-    "exit_profit_only": false,
-    "exit_profit_offset": 0.0,
-    "ignore_roi_if_entry_signal": false,
-    "ignore_buying_expired_candle_after": 300,
-    "trading_mode": "spot",
-    "margin_mode": "",
-    "minimal_roi": {
-        "40":  0.0,
-        "30":  0.01,
-        "20":  0.02,
-        "0":  0.04
-    },
-    "stoploss": -0.10,
-    "unfilledtimeout": {
-        "entry": 10,
-        "exit": 10,
-        "exit_timeout_count": 0,
-        "unit": "minutes"
-    },
-    "entry_pricing": {
-        "price_side": "same",
-        "use_order_book": true,
-        "order_book_top": 1,
-        "price_last_balance": 0.0,
-        "check_depth_of_market": {
-            "enabled": false,
-            "bids_to_ask_delta": 1
-        }
-    },
-    "exit_pricing":{
-        "price_side": "same",
-        "use_order_book": true,
-        "order_book_top": 1,
-        "price_last_balance": 0.0
-    },
-    "order_types": {
-        "entry": "limit",
-        "exit": "limit",
-        "emergency_exit": "market",
-        "force_exit": "market",
-        "force_entry": "market",
-        "stoploss": "market",
-        "stoploss_on_exchange": false,
-        "stoploss_price_type": "last",
-        "stoploss_on_exchange_interval": 60,
-        "stoploss_on_exchange_limit_ratio": 0.99
-    },
-    "order_time_in_force": {
-        "entry": "GTC",
-        "exit": "GTC"
-    },
-    "pairlists": [
-        {"method": "StaticPairList"},
-        {"method": "FullTradesFilter"},
-        {
-            "method": "VolumePairList",
-            "number_assets": 20,
-            "sort_key": "quoteVolume",
-            "refresh_period": 1800
-        },
-        {"method": "AgeFilter", "min_days_listed": 10},
-        {"method": "PrecisionFilter"},
-        {"method": "PriceFilter", "low_price_ratio": 0.01, "min_price": 0.00000010},
-        {"method": "SpreadFilter", "max_spread_ratio": 0.005},
-        {
-            "method": "RangeStabilityFilter",
-            "lookback_days": 10,
-            "min_rate_of_change": 0.01,
-            "refresh_period": 1440
-        }
-    ],
-    "exchange": {
-        "name": "binance",
-        "key": "your_exchange_key",
-        "secret": "your_exchange_secret",
-        "password": "",
-        "log_responses": false,
-        // "unknown_fee_rate": 1,
-        "ccxt_config": {},
-        "ccxt_async_config": {},
-        "pair_whitelist": [
-            "ALGO/BTC",
-            "ATOM/BTC",
-            "BAT/BTC",
-            "BCH/BTC",
-            "BRD/BTC",
-            "EOS/BTC",
-            "ETH/BTC",
-            "IOTA/BTC",
-            "LINK/BTC",
-            "LTC/BTC",
-            "NEO/BTC",
-            "NXS/BTC",
-            "XMR/BTC",
-            "XRP/BTC",
-            "XTZ/BTC"
-        ],
-        "pair_blacklist": [
-            "DOGE/BTC"
-        ],
-        "outdated_offset": 5,
-        "markets_refresh_interval": 60
-    },
-    "edge": {
-        "enabled": false,
-        "process_throttle_secs": 3600,
-        "calculate_since_number_of_days": 7,
-        "allowed_risk": 0.01,
-        "stoploss_range_min": -0.01,
-        "stoploss_range_max": -0.1,
-        "stoploss_range_step": -0.01,
-        "minimum_winrate": 0.60,
-        "minimum_expectancy": 0.20,
-        "min_trade_number": 10,
-        "max_trade_duration_minute": 1440,
-        "remove_pumps": false
-    },
-    "telegram": {
-        "enabled": false,
-        "token": "your_telegram_token",
-        "chat_id": "your_telegram_chat_id",
-        "notification_settings": {
-            "status": "on",
-            "warning": "on",
-            "startup": "on",
-            "entry": "on",
-            "entry_fill": "on",
-            "exit": {
-                "roi": "off",
-                "emergency_exit": "off",
-                "force_exit": "off",
-                "exit_signal": "off",
-                "trailing_stop_loss": "off",
-                "stop_loss": "off",
-                "stoploss_on_exchange": "off",
-                "custom_exit": "off"
-            },
-            "exit_fill": "on",
-            "entry_cancel": "on",
-            "exit_cancel": "on",
-            "protection_trigger": "off",
-            "protection_trigger_global": "on",
-            "show_candle": "off"
-        },
-        "reload": true,
-        "balance_dust_level": 0.01
-    },
-    "api_server": {
-        "enabled": false,
-        "listen_ip_address": "127.0.0.1",
-        "listen_port": 8080,
-        "verbosity": "error",
-        "enable_openapi": false,
-        "jwt_secret_key": "somethingrandom",
-        "CORS_origins": [],
-        "username": "freqtrader",
-        "password": "SuperSecurePassword",
-        "ws_token": "secret_ws_t0ken."
-    },
-    "external_message_consumer": {
-        "enabled": false,
-        "producers": [
-          {
-            "name": "default",
-            "host": "127.0.0.2",
-            "port": 8080,
-            "ws_token": "secret_ws_t0ken."
-          }
-        ],
-        "wait_timeout": 300,
-        "ping_timeout": 10,
-        "sleep_time": 10,
-        "remove_entry_exit_signals": false,
-        "message_size_limit": 8
-    },
-    "bot_name": "freqtrade",
-    "db_url": "sqlite:///tradesv3.sqlite",
-    "initial_state": "running",
-    "force_entry_enable": false,
-    "internals": {
-        "process_throttle_secs": 5,
-        "heartbeat_interval": 60
-    },
-    "disable_dataframe_checks": false,
-    "strategy": "SampleStrategy",
-    "strategy_path": "user_data/strategies/",
-    "recursive_strategy_search": false,
-    "add_config_files": [],
-    "reduce_df_footprint": false,
-    "dataformat_ohlcv": "feather",
-    "dataformat_trades": "feather"
-}

config_examples/config_kraken.example.json

@@ -1,90 +0,0 @@
-{
-    "$schema": "https://schema.freqtrade.io/schema.json",
-    "max_open_trades": 5,
-    "stake_currency": "EUR",
-    "stake_amount": 10,
-    "tradable_balance_ratio": 0.99,
-    "fiat_display_currency": "EUR",
-    "timeframe": "5m",
-    "dry_run": true,
-    "cancel_open_orders_on_exit": false,
-    "unfilledtimeout": {
-        "entry": 10,
-        "exit": 10,
-        "exit_timeout_count": 0,
-        "unit": "minutes"
-    },
-    "entry_pricing": {
-        "price_side": "same",
-        "use_order_book": true,
-        "order_book_top": 1,
-        "price_last_balance": 0.0,
-        "check_depth_of_market": {
-            "enabled": false,
-            "bids_to_ask_delta": 1
-        }
-    },
-    "exit_pricing":{
-        "price_side": "same",
-        "use_order_book": true,
-        "order_book_top": 1
-    },
-    "exchange": {
-        "name": "kraken",
-        "key": "your_exchange_key",
-        "secret": "your_exchange_key",
-        "ccxt_config": {},
-        "ccxt_async_config": {
-        },
-        "pair_whitelist": [
-            "ADA/EUR",
-            "ATOM/EUR",
-            "BAT/EUR",
-            "BCH/EUR",
-            "BTC/EUR",
-            "DAI/EUR",
-            "DASH/EUR",
-            "EOS/EUR",
-            "ETC/EUR",
-            "ETH/EUR",
-            "LINK/EUR",
-            "LTC/EUR",
-            "QTUM/EUR",
-            "REP/EUR",
-            "WAVES/EUR",
-            "XLM/EUR",
-            "XMR/EUR",
-            "XRP/EUR",
-            "XTZ/EUR",
-            "ZEC/EUR"
-        ],
-        "pair_blacklist": [
-
-        ]
-    },
-    "pairlists": [
-        {"method": "StaticPairList"}
-    ],
-    "telegram": {
-        "enabled": false,
-        "token": "your_telegram_token",
-        "chat_id": "your_telegram_chat_id"
-    },
-    "api_server": {
-        "enabled": false,
-        "listen_ip_address": "127.0.0.1",
-        "listen_port": 8080,
-        "verbosity": "error",
-        "jwt_secret_key": "somethingrandom",
-        "CORS_origins": [],
-        "username": "freqtrader",
-        "password": "SuperSecurePassword"
-    },
-    "bot_name": "freqtrade",
-    "initial_state": "running",
-    "force_entry_enable": false,
-    "internals": {
-        "process_throttle_secs": 5
-    },
-    "download_trades": true
-}

docker-compose.yml

@@ -1,36 +0,0 @@
----
-services:
-  freqtrade:
-    image: freqtradeorg/freqtrade:stable
-    # image: freqtradeorg/freqtrade:develop
-    # Use plotting image
-    # image: freqtradeorg/freqtrade:develop_plot
-    # # Enable GPU Image and GPU Resources (only relevant for freqAI)
-    # # Make sure to uncomment the whole deploy section
-    # deploy:
-    #   resources:
-    #     reservations:
-    #       devices:
-    #         - driver: nvidia
-    #           count: 1
-    #           capabilities: [gpu]
-    # Build step - only needed when additional dependencies are needed
-    # build:
-    #   context: .
-    #   dockerfile: "./docker/Dockerfile.custom"
-    restart: unless-stopped
-    container_name: freqtrade
-    volumes:
-      - "./user_data:/freqtrade/user_data"
-    # Expose api on port 8080 (localhost only)
-    # Please read the https://www.freqtrade.io/en/stable/rest-api/ documentation
-    # for more information.
-    ports:
-      - "127.0.0.1:8080:8080"
-    # Default command used when running `docker compose up`
-    command: >
-      trade
-      --logfile /freqtrade/user_data/logs/freqtrade.log
-      --db-url sqlite:////freqtrade/user_data/tradesv3.sqlite
-      --config /freqtrade/user_data/config.json
-      --strategy SampleStrategy

docker/Dockerfile.armhf

@@ -1,58 +0,0 @@
-FROM python:3.11.10-slim-bookworm as base
-
-# Setup env
-ENV LANG C.UTF-8
-ENV LC_ALL C.UTF-8
-ENV PYTHONDONTWRITEBYTECODE 1
-ENV PYTHONFAULTHANDLER 1
-ENV PATH=/home/ftuser/.local/bin:$PATH
-ENV FT_APP_ENV="docker"
-
-# Prepare environment
-RUN mkdir /freqtrade \
-  && apt-get update \
-  && apt-get -y install sudo libatlas3-base libopenblas-dev curl sqlite3 libhdf5-dev libutf8proc-dev libsnappy-dev \
-  && apt-get clean \
-  && useradd -u 1000 -G sudo -U -m ftuser \
-  && chown ftuser:ftuser /freqtrade \
-  # Allow sudoers
-  && echo "ftuser ALL=(ALL) NOPASSWD: /bin/chown" >> /etc/sudoers \
-  && pip install --upgrade pip
-
-WORKDIR /freqtrade
-
-# Install dependencies
-FROM base as python-deps
-RUN  apt-get update \
-  && apt-get -y install build-essential libssl-dev libffi-dev libgfortran5 pkg-config cmake gcc \
-  && apt-get clean \
-  && echo "[global]\nextra-index-url=https://www.piwheels.org/simple" > /etc/pip.conf
-
-# Install TA-lib
-COPY build_helpers/* /tmp/
-
-# Install dependencies
-COPY --chown=ftuser:ftuser requirements.txt /freqtrade/
-USER ftuser
-RUN  pip install --user --no-cache-dir numpy \
-  && pip install --user --no-index --find-links /tmp/ pyarrow TA-Lib \
-  && pip install --user --no-cache-dir -r requirements.txt
-
-# Copy dependencies to runtime-image
-FROM base as runtime-image
-COPY --from=python-deps /usr/local/lib /usr/local/lib
-ENV LD_LIBRARY_PATH /usr/local/lib
-
-COPY --from=python-deps --chown=ftuser:ftuser /home/ftuser/.local /home/ftuser/.local
-
-USER ftuser
-# Install and execute
-COPY --chown=ftuser:ftuser . /freqtrade/
-
-RUN pip install -e . --user --no-cache-dir --no-build-isolation\
-  && mkdir /freqtrade/user_data/ \
-  && freqtrade install-ui
-
-ENTRYPOINT ["freqtrade"]
-# Default to trade mode
-CMD [ "trade" ]

docker/Dockerfile.custom

@@ -1,11 +0,0 @@
-FROM freqtradeorg/freqtrade:develop
-
-# Switch user to root if you must install something from apt
-# Don't forget to switch the user back below!
-# USER root
-
-# The below dependency - pyti - serves as an example. Please use whatever you need!
-RUN pip install --user pyti
-
-# Switch back to user (only if you required root above)
-# USER ftuser

docker/Dockerfile.develop

@@ -1,10 +0,0 @@
-FROM freqtradeorg/freqtrade:develop
-
-# Install dependencies
-COPY requirements-dev.txt /freqtrade/
-
-RUN pip install numpy --user --no-cache-dir \
-  && pip install -r requirements-dev.txt --user --no-cache-dir
-
-# Empty the ENTRYPOINT to allow all commands
-ENTRYPOINT []

docker/Dockerfile.freqai

@@ -1,8 +0,0 @@
-ARG sourceimage=freqtradeorg/freqtrade
-ARG sourcetag=develop
-FROM ${sourceimage}:${sourcetag}
-
-# Install dependencies
-COPY requirements-freqai.txt /freqtrade/
-
-RUN pip install -r requirements-freqai.txt --user --no-cache-dir

docker/Dockerfile.freqai_rl

@@ -1,8 +0,0 @@
-ARG sourceimage=freqtradeorg/freqtrade
-ARG sourcetag=develop_freqai
-FROM ${sourceimage}:${sourcetag}
-
-# Install dependencies
-COPY requirements-freqai.txt requirements-freqai-rl.txt /freqtrade/
-
-RUN pip install -r requirements-freqai-rl.txt --user --no-cache-dir

docker/Dockerfile.jupyter

@@ -1,8 +0,0 @@
-FROM freqtradeorg/freqtrade:develop_plot
-
-
-# Pin prompt-toolkit to avoid questionary version conflict
-RUN pip install jupyterlab "prompt-toolkit<=3.0.36" jupyter-client --user --no-cache-dir
-
-# Empty the ENTRYPOINT to allow all commands
-ENTRYPOINT []

docker/Dockerfile.plot

@@ -1,8 +0,0 @@
-ARG sourceimage=freqtradeorg/freqtrade
-ARG sourcetag=develop
-FROM ${sourceimage}:${sourcetag}
-
-# Install dependencies
-COPY requirements-plot.txt /freqtrade/
-
-RUN pip install -r requirements-plot.txt --user --no-cache-dir

docker/docker-compose-freqai.yml

@@ -1,35 +0,0 @@
----
-services:
-  freqtrade:
-    image: freqtradeorg/freqtrade:stable_freqaitorch
-    # # Enable GPU Image and GPU Resources
-    # # Make sure to uncomment the whole deploy section
-    # deploy:
-    #   resources:
-    #     reservations:
-    #       devices:
-    #         - driver: nvidia
-    #           count: 1
-    #           capabilities: [gpu]
-
-    # Build step - only needed when additional dependencies are needed
-    # build:
-    #   context: .
-    #   dockerfile: "./docker/Dockerfile.custom"
-    restart: unless-stopped
-    container_name: freqtrade
-    volumes:
-      - "./user_data:/freqtrade/user_data"
-    # Expose api on port 8080 (localhost only)
-    # Please read the https://www.freqtrade.io/en/stable/rest-api/ documentation
-    # for more information.
-    ports:
-      - "127.0.0.1:8080:8080"
-    # Default command used when running `docker compose up`
-    command: >
-      trade
-      --logfile /freqtrade/user_data/logs/freqtrade.log
-      --db-url sqlite:////freqtrade/user_data/tradesv3.sqlite
-      --config /freqtrade/user_data/config.json
-      --freqaimodel XGBoostRegressor
-      --strategy FreqaiExampleStrategy

docker/docker-compose-jupyter.yml

@@ -1,15 +0,0 @@
----
-services:
-  ft_jupyterlab:
-    build:
-      context: ..
-      dockerfile: docker/Dockerfile.jupyter
-    restart: unless-stopped
-    # container_name: freqtrade
-    ports:
-      - "127.0.0.1:8888:8888"
-    volumes:
-      - "../user_data:/freqtrade/user_data"
-    # Default command used when running `docker compose up`
-    command: >
-      jupyter lab --port=8888 --ip 0.0.0.0 --allow-root

docs/advanced-backtesting.md

@@ -1,218 +0,0 @@
-# Advanced Backtesting Analysis
-
-## Analyze the buy/entry and sell/exit tags
-
-It can be helpful to understand how a strategy behaves according to the buy/entry tags used to
-mark up different buy conditions. You might want to see more complex statistics about each buy and
-sell condition above those provided by the default backtesting output. You may also want to
-determine indicator values on the signal candle that resulted in a trade opening.
-
-!!! Note
-    The following buy reason analysis is only available for backtesting, *not hyperopt*.
-
-We need to run backtesting with the `--export` option set to `signals` to enable the exporting of
-signals **and** trades:
-
-``` bash
-freqtrade backtesting -c <config.json> --timeframe <tf> --strategy <strategy_name> --timerange=<timerange> --export=signals
-```
-
-This will tell freqtrade to output a pickled dictionary of strategy, pairs and corresponding
-DataFrame of the candles that resulted in entry and exit signals.
-Depending on how many entries your strategy makes, this file may get quite large, so periodically check your `user_data/backtest_results` folder to delete old exports.
-
-Before running your next backtest, make sure you either delete your old backtest results or run
-backtesting with the `--cache none` option to make sure no cached results are used.
-
-If all goes well, you should now see a `backtest-result-{timestamp}_signals.pkl` and `backtest-result-{timestamp}_exited.pkl` files in the `user_data/backtest_results` folder.
-
-To analyze the entry/exit tags, we now need to use the `freqtrade backtesting-analysis` command
-with `--analysis-groups` option provided with space-separated arguments:
-
-``` bash
-freqtrade backtesting-analysis -c <config.json> --analysis-groups 0 1 2 3 4 5
-```
-
-This command will read from the last backtesting results. The `--analysis-groups` option is
-used to specify the various tabular outputs showing the profit of each group or trade,
-ranging from the simplest (0) to the most detailed per pair, per buy and per sell tag (4):
-
-* 0: overall winrate and profit summary by enter_tag
-* 1: profit summaries grouped by enter_tag
-* 2: profit summaries grouped by enter_tag and exit_tag
-* 3: profit summaries grouped by pair and enter_tag
-* 4: profit summaries grouped by pair, enter_ and exit_tag (this can get quite large)
-* 5: profit summaries grouped by exit_tag
-
-More options are available by running with the `-h` option.
-
-### Using export-filename
-
-Normally, `backtesting-analysis` uses the latest backtest results, but if you wanted to go
-back to a previous backtest output, you need to supply the `--export-filename` option.
-You can supply the same parameter to `backtest-analysis` with the name of the final backtest
-output file. This allows you to keep historical versions of backtest results and re-analyse
-them at a later date:
-
-``` bash
-freqtrade backtesting -c <config.json> --timeframe <tf> --strategy <strategy_name> --timerange=<timerange> --export=signals --export-filename=/tmp/mystrat_backtest.json
-```
-
-You should see some output similar to below in the logs with the name of the timestamped
-filename that was exported:
-
-```
-2022-06-14 16:28:32,698 - freqtrade.misc - INFO - dumping json to "/tmp/mystrat_backtest-2022-06-14_16-28-32.json"
-```
-
-You can then use that filename in `backtesting-analysis`:
-
-```
-freqtrade backtesting-analysis -c <config.json> --export-filename=/tmp/mystrat_backtest-2022-06-14_16-28-32.json
-```
-
-### Tuning the buy tags and sell tags to display
-
-To show only certain buy and sell tags in the displayed output, use the following two options:
-
-```
---enter-reason-list : Space-separated list of enter signals to analyse. Default: "all"
---exit-reason-list : Space-separated list of exit signals to analyse. Default: "all"
-```
-
-For example:
-
-```bash
-freqtrade backtesting-analysis -c <config.json> --analysis-groups 0 2 --enter-reason-list enter_tag_a enter_tag_b --exit-reason-list roi custom_exit_tag_a stop_loss
-```
-
-### Outputting signal candle indicators
-
-The real power of `freqtrade backtesting-analysis` comes from the ability to print out the indicator
-values present on signal candles to allow fine-grained investigation and tuning of buy signal
-indicators. To print out a column for a given set of indicators, use the `--indicator-list`
-option:
-
-```bash
-freqtrade backtesting-analysis -c <config.json> --analysis-groups 0 2 --enter-reason-list enter_tag_a enter_tag_b --exit-reason-list roi custom_exit_tag_a stop_loss --indicator-list rsi rsi_1h bb_lowerband ema_9 macd macdsignal
-```
-
-The indicators have to be present in your strategy's main DataFrame (either for your main
-timeframe or for informative timeframes) otherwise they will simply be ignored in the script
-output.
-
-!!! Note "Indicator List"
-    The indicator values will be displayed for both entry and exit points. If `--indicator-list all` is specified, 
-    only the indicators at the entry point will be shown to avoid excessively large lists, which could occur depending on the strategy.
-
-There are a range of candle and trade-related fields that are included in the analysis so are 
-automatically accessible by including them on the indicator-list, and these include:
-
-- **open_date     :** trade open datetime
-- **close_date    :** trade close datetime
-- **min_rate      :** minimum price seen throughout the position
-- **max_rate      :** maximum price seen throughout the position
-- **open          :** signal candle open price
-- **close         :** signal candle close price
-- **high          :** signal candle high price
-- **low           :** signal candle low price
-- **volume        :** signal candle volume
-- **profit_ratio  :** trade profit ratio
-- **profit_abs    :** absolute profit return of the trade 
-
-#### Sample Output for Indicator Values
-
-```bash
-freqtrade backtesting-analysis -c user_data/config.json --analysis-groups 0 --indicator-list chikou_span tenkan_sen 
-```
-
-In this example,
-we aim to display the `chikou_span` and `tenkan_sen` indicator values at both the entry and exit points of trades.
-
-A sample output for indicators might look like this:
-
-| pair      | open_date                 | enter_reason | exit_reason | chikou_span (entry) | tenkan_sen (entry) | chikou_span (exit) | tenkan_sen (exit) |
-|-----------|---------------------------|--------------|-------------|---------------------|--------------------|--------------------|-------------------|
-| DOGE/USDT | 2024-07-06 00:35:00+00:00 |              | exit_signal | 0.105               | 0.106              | 0.105              | 0.107             |
-| BTC/USDT  | 2024-08-05 14:20:00+00:00 |              | roi         | 54643.440           | 51696.400          | 54386.000          | 52072.010         |
-
-As shown in the table, `chikou_span (entry)` represents the indicator value at the time of trade entry, 
-while `chikou_span (exit)` reflects its value at the time of exit. 
-This detailed view of indicator values enhances the analysis.
-
-The `(entry)` and `(exit)` suffixes are added to indicators
-to distinguish the values at the entry and exit points of the trade.
-
-!!! Note "Trade-wide Indicators"
-    Certain trade-wide indicators do not have the `(entry)` or `(exit)` suffix. These indicators include: `pair`, `stake_amount`, 
-    `max_stake_amount`, `amount`, `open_date`, `close_date`, `open_rate`, `close_rate`, `fee_open`, `fee_close`, `trade_duration`, 
-    `profit_ratio`, `profit_abs`, `exit_reason`,`initial_stop_loss_abs`, `initial_stop_loss_ratio`, `stop_loss_abs`, `stop_loss_ratio`, 
-    `min_rate`, `max_rate`, `is_open`, `enter_tag`, `leverage`, `is_short`, `open_timestamp`, `close_timestamp` and `orders`
-
-#### Filtering Indicators Based on Entry or Exit Signals
-
-The `--indicator-list` option, by default, displays indicator values for both entry and exit signals. To filter the indicator values exclusively for entry signals, you can use the `--entry-only` argument. Similarly, to display indicator values only at exit signals, use the `--exit-only` argument.
-
-Example: Display indicator values at entry signals:
-
-```bash
-freqtrade backtesting-analysis -c user_data/config.json --analysis-groups 0 --indicator-list chikou_span tenkan_sen --entry-only
-```
-
-Example: Display indicator values at exit signals:
-
-```bash
-freqtrade backtesting-analysis -c user_data/config.json --analysis-groups 0 --indicator-list chikou_span tenkan_sen --exit-only
-```
-
-!!! note 
-    When using these filters, the indicator names will not be suffixed with `(entry)` or `(exit)`.
-
-### Filtering the trade output by date
-
-To show only trades between dates within your backtested timerange, supply the usual `timerange` option in `YYYYMMDD-[YYYYMMDD]` format:
-
-```
---timerange : Timerange to filter output trades, start date inclusive, end date exclusive. e.g. 20220101-20221231
-```
-
-For example, if your backtest timerange was `20220101-20221231` but you only want to output trades in January:
-
-```bash
-freqtrade backtesting-analysis -c <config.json> --timerange 20220101-20220201
-```
-
-### Printing out rejected signals
-
-Use the `--rejected-signals` option to print out rejected signals.
-
-```bash
-freqtrade backtesting-analysis -c <config.json> --rejected-signals
-```
-
-### Writing tables to CSV
-
-Some of the tabular outputs can become large, so printing them out to the terminal is not preferable.
-Use the `--analysis-to-csv` option to disable printing out of tables to standard out and write them to CSV files.
-
-```bash
-freqtrade backtesting-analysis -c <config.json> --analysis-to-csv
-```
-
-By default this will write one file per output table you specified in the `backtesting-analysis` command, e.g.
-
-```bash
-freqtrade backtesting-analysis -c <config.json> --analysis-to-csv --rejected-signals --analysis-groups 0 1
-```
-
-This will write to `user_data/backtest_results`:
-
-* rejected_signals.csv
-* group_0.csv
-* group_1.csv
-
-To override where the files will be written, also specify the `--analysis-csv-path` option.
-
-```bash
-freqtrade backtesting-analysis -c <config.json> --analysis-to-csv --analysis-csv-path another/data/path/
-```

docs/advanced-hyperopt.md

@@ -1,233 +0,0 @@
-# Advanced Hyperopt
-
-This page explains some advanced Hyperopt topics that may require higher
-coding skills and Python knowledge than creation of an ordinal hyperoptimization
-class.
-
-## Creating and using a custom loss function
-
-To use a custom loss function class, make sure that the function `hyperopt_loss_function` is defined in your custom hyperopt loss class.
-For the sample below, you then need to add the command line parameter `--hyperopt-loss SuperDuperHyperOptLoss` to your hyperopt call so this function is being used.
-
-A sample of this can be found below, which is identical to the Default Hyperopt loss implementation. A full sample can be found in [userdata/hyperopts](https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/templates/sample_hyperopt_loss.py).
-
-``` python
-from datetime import datetime
-from typing import Any, Dict
-
-from pandas import DataFrame
-
-from freqtrade.constants import Config
-from freqtrade.optimize.hyperopt import IHyperOptLoss
-
-TARGET_TRADES = 600
-EXPECTED_MAX_PROFIT = 3.0
-MAX_ACCEPTED_TRADE_DURATION = 300
-
-class SuperDuperHyperOptLoss(IHyperOptLoss):
-    """
-    Defines the default loss function for hyperopt
-    """
-
-    @staticmethod
-    def hyperopt_loss_function(
-        *,
-        results: DataFrame,
-        trade_count: int,
-        min_date: datetime,
-        max_date: datetime,
-        config: Config,
-        processed: Dict[str, DataFrame],
-        backtest_stats: Dict[str, Any],
-        **kwargs,
-    ) -> float:
-        """
-        Objective function, returns smaller number for better results
-        This is the legacy algorithm (used until now in freqtrade).
-        Weights are distributed as follows:
-        * 0.4 to trade duration
-        * 0.25: Avoiding trade loss
-        * 1.0 to total profit, compared to the expected value (`EXPECTED_MAX_PROFIT`) defined above
-        """
-        total_profit = results['profit_ratio'].sum()
-        trade_duration = results['trade_duration'].mean()
-
-        trade_loss = 1 - 0.25 * exp(-(trade_count - TARGET_TRADES) ** 2 / 10 ** 5.8)
-        profit_loss = max(0, 1 - total_profit / EXPECTED_MAX_PROFIT)
-        duration_loss = 0.4 * min(trade_duration / MAX_ACCEPTED_TRADE_DURATION, 1)
-        result = trade_loss + profit_loss + duration_loss
-        return result
-```
-
-Currently, the arguments are:
-
-* `results`: DataFrame containing the resulting trades.
-    The following columns are available in results (corresponds to the output-file of backtesting when used with `--export trades`):  
-    `pair, profit_ratio, profit_abs, open_date, open_rate, fee_open, close_date, close_rate, fee_close, amount, trade_duration, is_open, exit_reason, stake_amount, min_rate, max_rate, stop_loss_ratio, stop_loss_abs`
-* `trade_count`: Amount of trades (identical to `len(results)`)
-* `min_date`: Start date of the timerange used
-* `min_date`: End date of the timerange used
-* `config`: Config object used (Note: Not all strategy-related parameters will be updated here if they are part of a hyperopt space).
-* `processed`: Dict of Dataframes with the pair as keys containing the data used for backtesting.
-* `backtest_stats`: Backtesting statistics using the same format as the backtesting file "strategy" substructure. Available fields can be seen in `generate_strategy_stats()` in `optimize_reports.py`.
-
-This function needs to return a floating point number (`float`). Smaller numbers will be interpreted as better results. The parameters and balancing for this is up to you.
-
-!!! Note
-    This function is called once per epoch - so please make sure to have this as optimized as possible to not slow hyperopt down unnecessarily.
-
-!!! Note "`*args` and `**kwargs`"
-    Please keep the arguments `*args` and `**kwargs` in the interface to allow us to extend this interface in the future.
-
-## Overriding pre-defined spaces
-
-To override a pre-defined space (`roi_space`, `generate_roi_table`, `stoploss_space`, `trailing_space`, `max_open_trades_space`), define a nested class called Hyperopt and define the required spaces as follows:
-
-```python
-from freqtrade.optimize.space import Categorical, Dimension, Integer, SKDecimal
-
-class MyAwesomeStrategy(IStrategy):
-    class HyperOpt:
-        # Define a custom stoploss space.
-        def stoploss_space():
-            return [SKDecimal(-0.05, -0.01, decimals=3, name='stoploss')]
-
-        # Define custom ROI space
-        def roi_space() -> List[Dimension]:
-            return [
-                Integer(10, 120, name='roi_t1'),
-                Integer(10, 60, name='roi_t2'),
-                Integer(10, 40, name='roi_t3'),
-                SKDecimal(0.01, 0.04, decimals=3, name='roi_p1'),
-                SKDecimal(0.01, 0.07, decimals=3, name='roi_p2'),
-                SKDecimal(0.01, 0.20, decimals=3, name='roi_p3'),
-            ]
-
-        def generate_roi_table(params: Dict) -> Dict[int, float]:
-
-            roi_table = {}
-            roi_table[0] = params['roi_p1'] + params['roi_p2'] + params['roi_p3']
-            roi_table[params['roi_t3']] = params['roi_p1'] + params['roi_p2']
-            roi_table[params['roi_t3'] + params['roi_t2']] = params['roi_p1']
-            roi_table[params['roi_t3'] + params['roi_t2'] + params['roi_t1']] = 0
-
-            return roi_table
-
-        def trailing_space() -> List[Dimension]:
-            # All parameters here are mandatory, you can only modify their type or the range.
-            return [
-                # Fixed to true, if optimizing trailing_stop we assume to use trailing stop at all times.
-                Categorical([True], name='trailing_stop'),
-
-                SKDecimal(0.01, 0.35, decimals=3, name='trailing_stop_positive'),
-                # 'trailing_stop_positive_offset' should be greater than 'trailing_stop_positive',
-                # so this intermediate parameter is used as the value of the difference between
-                # them. The value of the 'trailing_stop_positive_offset' is constructed in the
-                # generate_trailing_params() method.
-                # This is similar to the hyperspace dimensions used for constructing the ROI tables.
-                SKDecimal(0.001, 0.1, decimals=3, name='trailing_stop_positive_offset_p1'),
-
-                Categorical([True, False], name='trailing_only_offset_is_reached'),
-        ]
-
-        # Define a custom max_open_trades space
-        def max_open_trades_space(self) -> List[Dimension]:
-            return [
-                Integer(-1, 10, name='max_open_trades'),
-            ]
-```
-
-!!! Note
-    All overrides are optional and can be mixed/matched as necessary.
-
-### Dynamic parameters
-
-Parameters can also be defined dynamically, but must be available to the instance once the [`bot_start()` callback](strategy-callbacks.md#bot-start) has been called.
-
-``` python
-
-class MyAwesomeStrategy(IStrategy):
-
-    def bot_start(self, **kwargs) -> None:
-        self.buy_adx = IntParameter(20, 30, default=30, optimize=True)
-
-    # ...
-```
-
-!!! Warning
-    Parameters created this way will not show up in the `list-strategies` parameter count.
-
-### Overriding Base estimator
-
-You can define your own estimator for Hyperopt by implementing `generate_estimator()` in the Hyperopt subclass.
-
-```python
-class MyAwesomeStrategy(IStrategy):
-    class HyperOpt:
-        def generate_estimator(dimensions: List['Dimension'], **kwargs):
-            return "RF"
-
-```
-
-Possible values are either one of "GP", "RF", "ET", "GBRT" (Details can be found in the [scikit-optimize documentation](https://scikit-optimize.github.io/)), or "an instance of a class that inherits from `RegressorMixin` (from sklearn) and where the `predict` method has an optional `return_std` argument, which returns `std(Y | x)` along with `E[Y | x]`".
-
-Some research will be necessary to find additional Regressors.
-
-Example for `ExtraTreesRegressor` ("ET") with additional parameters:
-
-```python
-class MyAwesomeStrategy(IStrategy):
-    class HyperOpt:
-        def generate_estimator(dimensions: List['Dimension'], **kwargs):
-            from skopt.learning import ExtraTreesRegressor
-            # Corresponds to "ET" - but allows additional parameters.
-            return ExtraTreesRegressor(n_estimators=100)
-
-```
-
-The `dimensions` parameter is the list of `skopt.space.Dimension` objects corresponding to the parameters to be optimized. It can be used to create isotropic kernels for the `skopt.learning.GaussianProcessRegressor` estimator. Here's an example:
-
-```python
-class MyAwesomeStrategy(IStrategy):
-    class HyperOpt:
-        def generate_estimator(dimensions: List['Dimension'], **kwargs):
-            from skopt.utils import cook_estimator
-            from skopt.learning.gaussian_process.kernels import (Matern, ConstantKernel)
-            kernel_bounds = (0.0001, 10000)
-            kernel = (
-                ConstantKernel(1.0, kernel_bounds) * 
-                Matern(length_scale=np.ones(len(dimensions)), length_scale_bounds=[kernel_bounds for d in dimensions], nu=2.5)
-            )
-            kernel += (
-                ConstantKernel(1.0, kernel_bounds) * 
-                Matern(length_scale=np.ones(len(dimensions)), length_scale_bounds=[kernel_bounds for d in dimensions], nu=1.5)
-            )
-
-            return cook_estimator("GP", space=dimensions, kernel=kernel, n_restarts_optimizer=2)
-```
-
-!!! Note
-    While custom estimators can be provided, it's up to you as User to do research on possible parameters and analyze / understand which ones should be used.
-    If you're unsure about this, best use one of the Defaults (`"ET"` has proven to be the most versatile) without further parameters.
-
-## Space options
-
-For the additional spaces, scikit-optimize (in combination with Freqtrade) provides the following space types:
-
-* `Categorical` - Pick from a list of categories (e.g. `Categorical(['a', 'b', 'c'], name="cat")`)
-* `Integer` - Pick from a range of whole numbers (e.g. `Integer(1, 10, name='rsi')`)
-* `SKDecimal` - Pick from a range of decimal numbers with limited precision (e.g. `SKDecimal(0.1, 0.5, decimals=3, name='adx')`). *Available only with freqtrade*.
-* `Real` - Pick from a range of decimal numbers with full precision (e.g. `Real(0.1, 0.5, name='adx')`
-
-You can import all of these from `freqtrade.optimize.space`, although `Categorical`, `Integer` and `Real` are only aliases for their corresponding scikit-optimize Spaces. `SKDecimal` is provided by freqtrade for faster optimizations.
-
-``` python
-from freqtrade.optimize.space import Categorical, Dimension, Integer, SKDecimal, Real  # noqa
-```
-
-!!! Hint "SKDecimal vs. Real"
-    We recommend to use `SKDecimal` instead of the `Real` space in almost all cases. While the Real space provides full accuracy (up to ~16 decimal places) - this precision is rarely needed, and leads to unnecessary long hyperopt times.
-
-    Assuming the definition of a rather small space (`SKDecimal(0.10, 0.15, decimals=2, name='xxx')`) - SKDecimal will have 5 possibilities (`[0.10, 0.11, 0.12, 0.13, 0.14, 0.15]`).
-
-    A corresponding real space `Real(0.10, 0.15 name='xxx')`  on the other hand has an almost unlimited number of possibilities (`[0.10, 0.010000000001, 0.010000000002, ... 0.014999999999, 0.01500000000]`).

docs/advanced-orderflow.md

@@ -1,152 +0,0 @@
-# Orderflow data
-
-This guide walks you through utilizing public trade data for advanced orderflow analysis in Freqtrade.
-
-!!! Warning "Experimental Feature"
-    The orderflow feature is currently in beta and may be subject to changes in future releases. Please report any issues or feedback on the [Freqtrade GitHub repository](https://github.com/freqtrade/freqtrade/issues).
-
-!!! Warning "Performance"
-    Orderflow requires raw trades data. This data is rather large, and can cause a slow initial startup, when freqtrade needs to download the trades data for the last X candles. Additionally, enabling this feature will cause increased memory usage. Please ensure to have sufficient resources available.
-
-## Getting Started
-
-### Enable Public Trades
-
-In your `config.json` file, set the `use_public_trades` option to true under the `exchange` section.
-
-```json
-"exchange": {
-   ...
-   "use_public_trades": true,
-}
-```
-
-### Configure Orderflow Processing
-
-Define your desired settings for orderflow processing within the orderflow section of config.json. Here, you can adjust factors like:
-
-- `cache_size`: How many previous orderflow candles are saved into cache instead of calculated every new candle
-- `max_candles`: Filter how many candles would you like to get trades data for.
-- `scale`: This controls the price bin size for the footprint chart.
-- `stacked_imbalance_range`: Defines the minimum consecutive imbalanced price levels required for consideration.
-- `imbalance_volume`: Filters out imbalances with volume below this threshold.
-- `imbalance_ratio`: Filters out imbalances with a ratio (difference between ask and bid volume) lower than this value.
-
-```json
-"orderflow": {
-    "cache_size": 1000, 
-    "max_candles": 1500, 
-    "scale": 0.5, 
-    "stacked_imbalance_range": 3, //  needs at least this amount of imbalance next to each other
-    "imbalance_volume": 1, //  filters out below
-    "imbalance_ratio": 3 //  filters out ratio lower than
-  },
-```
-
-## Downloading Trade Data for Backtesting
-
-To download historical trade data for backtesting, use the --dl-trades flag with the freqtrade download-data command.
-
-```bash
-freqtrade download-data -p BTC/USDT:USDT --timerange 20230101- --trading-mode futures --timeframes 5m --dl-trades
-```
-
-!!! Warning "Data availability"
-    Not all exchanges provide public trade data. For supported exchanges, freqtrade will warn you if public trade data is not available if you start downloading data with the `--dl-trades` flag.
-
-## Accessing Orderflow Data
-
-Once activated, several new columns become available in your dataframe:
-
-``` python
-
-dataframe["trades"] # Contains information about each individual trade.
-dataframe["orderflow"] # Represents a footprint chart dict (see below)
-dataframe["imbalances"] # Contains information about imbalances in the order flow.
-dataframe["bid"] # Total bid volume 
-dataframe["ask"] # Total ask volume
-dataframe["delta"] # Difference between ask and bid volume.
-dataframe["min_delta"] # Minimum delta within the candle
-dataframe["max_delta"] # Maximum delta within the candle
-dataframe["total_trades"] # Total number of trades
-dataframe["stacked_imbalances_bid"] # Price level of stacked bid imbalance 
-dataframe["stacked_imbalances_ask"] # Price level of stacked ask imbalance  
-```
-
-You can access these columns in your strategy code for further analysis. Here's an example:
-
-``` python
-def populate_indicators(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
-    # Calculating cumulative delta
-    dataframe["cum_delta"] = cumulative_delta(dataframe["delta"])
-    # Accessing total trades
-    total_trades = dataframe["total_trades"]
-    ...
-
-def cumulative_delta(delta: Series):
-    cumdelta = delta.cumsum()
-    return cumdelta
-
-```
-
-### Footprint chart (`dataframe["orderflow"]`)
-
-This column provides a detailed breakdown of buy and sell orders at different price levels, offering valuable insights into order flow dynamics. The `scale` parameter in your configuration determines the price bin size for this representation
-
-The `orderflow` column contains a dict with the following structure:
-
-``` output
-{
-    "price": {
-        "bid_amount": 0.0,
-        "ask_amount": 0.0,
-        "bid": 0,
-        "ask": 0,
-        "delta": 0.0,
-        "total_volume": 0.0,
-        "total_trades": 0
-    }
-}
-```
-
-#### Orderflow column explanation
-
-- key: Price bin - binned at `scale` intervals
-- `bid_amount`: Total volume bought at each price level.
-- `ask_amount`: Total volume sold at each price level.
-- `bid`: Number of buy orders at each price level.
-- `ask`: Number of sell orders at each price level.
-- `delta`: Difference between ask and bid volume at each price level.
-- `total_volume`: Total volume (ask amount + bid amount) at each price level.
-- `total_trades`: Total number of trades (ask + bid) at each price level.
-
-By leveraging these features, you can gain valuable insights into market sentiment and potential trading opportunities based on order flow analysis.
-
-### Raw trades data (`dataframe["trades"]`)
-
-List with the individual trades that occurred during the candle. This data can be used for more granular analysis of order flow dynamics.
-
-Each individual entry contains a dict with the following keys:
-
-- `timestamp`: Timestamp of the trade.
-- `date`: Date of the trade.
-- `price`: Price of the trade.
-- `amount`: Volume of the trade.
-- `side`: Buy or sell.
-- `id`: Unique identifier for the trade.
-- `cost`: Total cost of the trade (price * amount).
-
-### Imbalances (`dataframe["imbalances"]`)
-
-This column provides a dict with information about imbalances in the order flow. An imbalance occurs when there is a significant difference between the ask and bid volume at a given price level.
-
-Each row looks as follows - with price as index, and the corresponding bid and ask imbalance values as columns
-
-``` output
-{
-    "price": {
-        "bid_imbalance": False,
-        "ask_imbalance": False
-    }
-}
-```

docs/advanced-setup.md

@@ -1,246 +0,0 @@
-# Advanced Post-installation Tasks
-
-This page explains some advanced tasks and configuration options that can be performed after the bot installation and may be uselful in some environments.
-
-If you do not know what things mentioned here mean, you probably do not need it.
-
-## Running multiple instances of Freqtrade
-
-This section will show you how to run multiple bots at the same time, on the same machine.
-
-### Things to consider
-
-* Use different database files.
-* Use different Telegram bots (requires multiple different configuration files; applies only when Telegram is enabled).
-* Use different ports (applies only when Freqtrade REST API webserver is enabled).
-
-### Different database files
-
-In order to keep track of your trades, profits, etc., freqtrade is using a SQLite database where it stores various types of information such as the trades you performed in the past and the current position(s) you are holding at any time. This allows you to keep track of your profits, but most importantly, keep track of ongoing activity if the bot process would be restarted or would be terminated unexpectedly.
-
-Freqtrade will, by default, use separate database files for dry-run and live bots (this assumes no database-url is given in either configuration nor via command line argument).
-For live trading mode, the default database will be `tradesv3.sqlite` and for dry-run it will be `tradesv3.dryrun.sqlite`.
-
-The optional argument to the trade command used to specify the path of these files is `--db-url`, which requires a valid SQLAlchemy url.
-So when you are starting a bot with only the config and strategy arguments in dry-run mode, the following 2 commands would have the same outcome.
-
-``` bash
-freqtrade trade -c MyConfig.json -s MyStrategy
-# is equivalent to
-freqtrade trade -c MyConfig.json -s MyStrategy --db-url sqlite:///tradesv3.dryrun.sqlite
-```
-
-It means that if you are running the trade command in two different terminals, for example to test your strategy both for trades in USDT and in another instance for trades in BTC, you will have to run them with different databases.
-
-If you specify the URL of a database which does not exist, freqtrade will create one with the name you specified. So to test your custom strategy with BTC and USDT stake currencies, you could use the following commands (in 2 separate terminals):
-
-``` bash
-# Terminal 1:
-freqtrade trade -c MyConfigBTC.json -s MyCustomStrategy --db-url sqlite:///user_data/tradesBTC.dryrun.sqlite
-# Terminal 2:
-freqtrade trade -c MyConfigUSDT.json -s MyCustomStrategy --db-url sqlite:///user_data/tradesUSDT.dryrun.sqlite
-```
-
-Conversely, if you wish to do the same thing in production mode, you will also have to create at least one new database (in addition to the default one) and specify the path to the "live" databases, for example:
-
-``` bash
-# Terminal 1:
-freqtrade trade -c MyConfigBTC.json -s MyCustomStrategy --db-url sqlite:///user_data/tradesBTC.live.sqlite
-# Terminal 2:
-freqtrade trade -c MyConfigUSDT.json -s MyCustomStrategy --db-url sqlite:///user_data/tradesUSDT.live.sqlite
-```
-
-For more information regarding usage of the sqlite databases, for example to manually enter or remove trades, please refer to the [SQL Cheatsheet](sql_cheatsheet.md).
-
-### Multiple instances using docker
-
-To run multiple instances of freqtrade using docker you will need to edit the docker-compose.yml file and add all the instances you want as separate services. Remember, you can separate your configuration into multiple files, so it's a good idea to think about making them modular, then if you need to edit something common to all bots, you can do that in a single config file. 
-``` yml
----
-version: '3'
-services:
-  freqtrade1:
-    image: freqtradeorg/freqtrade:stable
-    # image: freqtradeorg/freqtrade:develop
-    # Use plotting image
-    # image: freqtradeorg/freqtrade:develop_plot
-    # Build step - only needed when additional dependencies are needed
-    # build:
-    #   context: .
-    #   dockerfile: "./docker/Dockerfile.custom"
-    restart: always
-    container_name: freqtrade1
-    volumes:
-      - "./user_data:/freqtrade/user_data"
-    # Expose api on port 8080 (localhost only)
-    # Please read the https://www.freqtrade.io/en/latest/rest-api/ documentation
-    # before enabling this.
-     ports:
-     - "127.0.0.1:8080:8080"
-    # Default command used when running `docker compose up`
-    command: >
-      trade
-      --logfile /freqtrade/user_data/logs/freqtrade1.log
-      --db-url sqlite:////freqtrade/user_data/tradesv3_freqtrade1.sqlite
-      --config /freqtrade/user_data/config.json
-      --config /freqtrade/user_data/config.freqtrade1.json
-      --strategy SampleStrategy
-  
-  freqtrade2:
-    image: freqtradeorg/freqtrade:stable
-    # image: freqtradeorg/freqtrade:develop
-    # Use plotting image
-    # image: freqtradeorg/freqtrade:develop_plot
-    # Build step - only needed when additional dependencies are needed
-    # build:
-    #   context: .
-    #   dockerfile: "./docker/Dockerfile.custom"
-    restart: always
-    container_name: freqtrade2
-    volumes:
-      - "./user_data:/freqtrade/user_data"
-    # Expose api on port 8080 (localhost only)
-    # Please read the https://www.freqtrade.io/en/latest/rest-api/ documentation
-    # before enabling this.
-    ports:
-      - "127.0.0.1:8081:8080"
-    # Default command used when running `docker compose up`
-    command: >
-      trade
-      --logfile /freqtrade/user_data/logs/freqtrade2.log
-      --db-url sqlite:////freqtrade/user_data/tradesv3_freqtrade2.sqlite
-      --config /freqtrade/user_data/config.json
-      --config /freqtrade/user_data/config.freqtrade2.json
-      --strategy SampleStrategy
-
-```
-
-You can use whatever naming convention you want, freqtrade1 and 2 are arbitrary. Note, that you will need to use different database files, port mappings and telegram configurations for each instance, as mentioned above. 
-
-## Use a different database system
-
-Freqtrade is using SQLAlchemy, which supports multiple different database systems. As such, a multitude of database systems should be supported.
-Freqtrade does not depend or install any additional database driver. Please refer to the [SQLAlchemy docs](https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls) on installation instructions for the respective database systems.
-
-The following systems have been tested and are known to work with freqtrade:
-
-* sqlite (default)
-* PostgreSQL
-* MariaDB
-
-!!! Warning
-    By using one of the below database systems, you acknowledge that you know how to manage such a system. The freqtrade team will not provide any support with setup or maintenance (or backups) of the below database systems.
-
-### PostgreSQL
-
-Installation:
-`pip install psycopg2-binary`
-
-Usage:
-`... --db-url postgresql+psycopg2://<username>:<password>@localhost:5432/<database>`
-
-Freqtrade will automatically create the tables necessary upon startup.
-
-If you're running different instances of Freqtrade, you must either setup one database per Instance or use different users / schemas for your connections.
-
-### MariaDB / MySQL
-
-Freqtrade supports MariaDB by using SQLAlchemy, which supports multiple different database systems.
-
-Installation:
-`pip install pymysql`
-
-Usage:
-`... --db-url mysql+pymysql://<username>:<password>@localhost:3306/<database>`
-
-
-
-## Configure the bot running as a systemd service
-
-Copy the `freqtrade.service` file to your systemd user directory (usually `~/.config/systemd/user`) and update `WorkingDirectory` and `ExecStart` to match your setup.
-
-!!! Note
-    Certain systems (like Raspbian) don't load service unit files from the user directory. In this case, copy `freqtrade.service` into `/etc/systemd/user/` (requires superuser permissions).
-
-After that you can start the daemon with:
-
-```bash
-systemctl --user start freqtrade
-```
-
-For this to be persistent (run when user is logged out) you'll need to enable `linger` for your freqtrade user.
-
-```bash
-sudo loginctl enable-linger "$USER"
-```
-
-If you run the bot as a service, you can use systemd service manager as a software watchdog monitoring freqtrade bot 
-state and restarting it in the case of failures. If the `internals.sd_notify` parameter is set to true in the 
-configuration or the `--sd-notify` command line option is used, the bot will send keep-alive ping messages to systemd 
-using the sd_notify (systemd notifications) protocol and will also tell systemd its current state (Running or Stopped) 
-when it changes. 
-
-The `freqtrade.service.watchdog` file contains an example of the service unit configuration file which uses systemd 
-as the watchdog.
-
-!!! Note
-    The sd_notify communication between the bot and the systemd service manager will not work if the bot runs in a Docker container.
-
-## Advanced Logging
-
-On many Linux systems the bot can be configured to send its log messages to `syslog` or `journald` system services. Logging to a remote `syslog` server is also available on Windows. The special values for the `--logfile` command line option can be used for this.
-
-### Logging to syslog
-
-To send Freqtrade log messages to a local or remote `syslog` service use the `--logfile` command line option with the value in the following format:
-
-* `--logfile syslog:<syslog_address>` -- send log messages to `syslog` service using the `<syslog_address>` as the syslog address.
-
-The syslog address can be either a Unix domain socket (socket filename) or a UDP socket specification, consisting of IP address and UDP port, separated by the `:` character.
-
-So, the following are the examples of possible usages:
-
-* `--logfile syslog:/dev/log` -- log to syslog (rsyslog) using the `/dev/log` socket, suitable for most systems.
-* `--logfile syslog` -- same as above, the shortcut for `/dev/log`.
-* `--logfile syslog:/var/run/syslog` -- log to syslog (rsyslog) using the `/var/run/syslog` socket. Use this on MacOS.
-* `--logfile syslog:localhost:514` -- log to local syslog using UDP socket, if it listens on port 514.
-* `--logfile syslog:<ip>:514` -- log to remote syslog at IP address and port 514. This may be used on Windows for remote logging to an external syslog server.
-
-Log messages are send to `syslog` with the `user` facility. So you can see them with the following commands:
-
-* `tail -f /var/log/user`, or 
-* install a comprehensive graphical viewer (for instance, 'Log File Viewer' for Ubuntu).
-
-On many systems `syslog` (`rsyslog`) fetches data from `journald` (and vice versa), so both `--logfile syslog` or `--logfile journald` can be used and the messages be viewed with both `journalctl` and a syslog viewer utility. You can combine this in any way which suites you better.
-
-For `rsyslog` the messages from the bot can be redirected into a separate dedicated log file. To achieve this, add
-
-```
-if $programname startswith "freqtrade" then -/var/log/freqtrade.log
-```
-
-to one of the rsyslog configuration files, for example at the end of the `/etc/rsyslog.d/50-default.conf`.
-
-For `syslog` (`rsyslog`), the reduction mode can be switched on. This will reduce the number of repeating messages. For instance, multiple bot Heartbeat messages will be reduced to a single message when nothing else happens with the bot. To achieve this, set in `/etc/rsyslog.conf`:
-
-```
-# Filter duplicated messages
-$RepeatedMsgReduction on
-```
-
-### Logging to journald
-
-This needs the `cysystemd` python package installed as dependency (`pip install cysystemd`), which is not available on Windows. Hence, the whole journald logging functionality is not available for a bot running on Windows.
-
-To send Freqtrade log messages to `journald` system service use the `--logfile` command line option with the value in the following format:
-
-* `--logfile journald` -- send log messages to `journald`.
-
-Log messages are send to `journald` with the `user` facility. So you can see them with the following commands:
-
-* `journalctl -f` -- shows Freqtrade log messages sent to `journald` along with other log messages fetched by `journald`.
-* `journalctl -f -u freqtrade.service` -- this command can be used when the bot is run as a `systemd` service.
-
-There are many other options in the `journalctl` utility to filter the messages, see manual pages for this utility.
-
-On many systems `syslog` (`rsyslog`) fetches data from `journald` (and vice versa), so both `--logfile syslog` or `--logfile journald` can be used and the messages be viewed with both `journalctl` and a syslog viewer utility. You can combine this in any way which suites you better.

docs/backtesting.md

@@ -1,646 +0,0 @@
-# Backtesting
-
-This page explains how to validate your strategy performance by using Backtesting.
-
-Backtesting requires historic data to be available.
-To learn how to get data for the pairs and exchange you're interested in, head over to the [Data Downloading](data-download.md) section of the documentation.
-
-## Backtesting command reference
-
-```
-usage: freqtrade backtesting [-h] [-v] [--logfile FILE] [-V] [-c PATH]
-                             [-d PATH] [--userdir PATH] [-s NAME]
-                             [--strategy-path PATH] [-i TIMEFRAME]
-                             [--timerange TIMERANGE]
-                             [--data-format-ohlcv {json,jsongz,hdf5}]
-                             [--max-open-trades INT]
-                             [--stake-amount STAKE_AMOUNT] [--fee FLOAT]
-                             [-p PAIRS [PAIRS ...]] [--eps] [--dmmp]
-                             [--enable-protections]
-                             [--dry-run-wallet DRY_RUN_WALLET]
-                             [--timeframe-detail TIMEFRAME_DETAIL]
-                             [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]]
-                             [--export {none,trades,signals}]
-                             [--export-filename PATH]
-                             [--breakdown {day,week,month} [{day,week,month} ...]]
-                             [--cache {none,day,week,month}]
-
-optional arguments:
-  -h, --help            show this help message and exit
-  -i TIMEFRAME, --timeframe TIMEFRAME
-                        Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
-  --timerange TIMERANGE
-                        Specify what timerange of data to use.
-  --data-format-ohlcv {json,jsongz,hdf5,feather,parquet}
-                        Storage format for downloaded candle (OHLCV) data.
-                        (default: `feather`).
-  --max-open-trades INT
-                        Override the value of the `max_open_trades`
-                        configuration setting.
-  --stake-amount STAKE_AMOUNT
-                        Override the value of the `stake_amount` configuration
-                        setting.
-  --fee FLOAT           Specify fee ratio. Will be applied twice (on trade
-                        entry and exit).
-  -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
-                        Limit command to these pairs. Pairs are space-
-                        separated.
-  --eps, --enable-position-stacking
-                        Allow buying the same pair multiple times (position
-                        stacking).
-  --dmmp, --disable-max-market-positions
-                        Disable applying `max_open_trades` during backtest
-                        (same as setting `max_open_trades` to a very high
-                        number).
-  --enable-protections, --enableprotections
-                        Enable protections for backtesting.Will slow
-                        backtesting down by a considerable amount, but will
-                        include configured protections
-  --dry-run-wallet DRY_RUN_WALLET, --starting-balance DRY_RUN_WALLET
-                        Starting balance, used for backtesting / hyperopt and
-                        dry-runs.
-  --timeframe-detail TIMEFRAME_DETAIL
-                        Specify detail timeframe for backtesting (`1m`, `5m`,
-                        `30m`, `1h`, `1d`).
-  --strategy-list STRATEGY_LIST [STRATEGY_LIST ...]
-                        Provide a space-separated list of strategies to
-                        backtest. Please note that timeframe needs to be set
-                        either in config or via command line. When using this
-                        together with `--export trades`, the strategy-name is
-                        injected into the filename (so `backtest-data.json`
-                        becomes `backtest-data-SampleStrategy.json`
-  --export {none,trades,signals}
-                        Export backtest results (default: trades).
-  --export-filename PATH, --backtest-filename PATH
-                        Use this filename for backtest results.Requires
-                        `--export` to be set as well. Example: `--export-filen
-                        ame=user_data/backtest_results/backtest_today.json`
-  --breakdown {day,week,month} [{day,week,month} ...]
-                        Show backtesting breakdown per [day, week, month].
-  --cache {none,day,week,month}
-                        Load a cached backtest result no older than specified
-                        age (default: day).
-
-Common arguments:
-  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
-  --logfile FILE        Log to the file specified. Special values are:
-                        'syslog', 'journald'. See the documentation for more
-                        details.
-  -V, --version         show program's version number and exit
-  -c PATH, --config PATH
-                        Specify configuration file (default:
-                        `userdir/config.json` or `config.json` whichever
-                        exists). Multiple --config options may be used. Can be
-                        set to `-` to read config from stdin.
-  -d PATH, --datadir PATH
-                        Path to directory with historical backtesting data.
-  --userdir PATH, --user-data-dir PATH
-                        Path to userdata directory.
-
-Strategy arguments:
-  -s NAME, --strategy NAME
-                        Specify strategy class name which will be used by the
-                        bot.
-  --strategy-path PATH  Specify additional strategy lookup path.
-
-```
-
-## Test your strategy with Backtesting
-
-Now you have good Entry and exit strategies and some historic data, you want to test it against
-real data. This is what we call [backtesting](https://en.wikipedia.org/wiki/Backtesting).
-
-Backtesting will use the crypto-currencies (pairs) from your config file and load historical candle (OHLCV) data from `user_data/data/<exchange>` by default.
-If no data is available for the exchange / pair / timeframe combination, backtesting will ask you to download them first using `freqtrade download-data`.
-For details on downloading, please refer to the [Data Downloading](data-download.md) section in the documentation.
-
-The result of backtesting will confirm if your bot has better odds of making a profit than a loss.
-
-All profit calculations include fees, and freqtrade will use the exchange's default fees for the calculation.
-
-!!! Warning "Using dynamic pairlists for backtesting"
-    Using dynamic pairlists is possible (not all of the handlers are allowed to be used in backtest mode), however it relies on the current market conditions - which will not reflect the historic status of the pairlist.
-    Also, when using pairlists other than StaticPairlist, reproducibility of backtesting-results cannot be guaranteed.
-    Please read the [pairlists documentation](plugins.md#pairlists) for more information.
-
-    To achieve reproducible results, best generate a pairlist via the [`test-pairlist`](utils.md#test-pairlist) command and use that as static pairlist.
-
-!!! Note
-    By default, Freqtrade will export backtesting results to `user_data/backtest_results`.
-    The exported trades can be used for [further analysis](#further-backtest-result-analysis) or can be used by the [plotting sub-command](plotting.md#plot-price-and-indicators) (`freqtrade plot-dataframe`) in the scripts directory.
-
-
-### Starting balance
-
-Backtesting will require a starting balance, which can be provided as `--dry-run-wallet <balance>` or `--starting-balance <balance>` command line argument, or via `dry_run_wallet` configuration setting.
-This amount must be higher than `stake_amount`, otherwise the bot will not be able to simulate any trade.
-
-### Dynamic stake amount
-
-Backtesting supports [dynamic stake amount](configuration.md#dynamic-stake-amount) by configuring `stake_amount` as `"unlimited"`, which will split the starting balance into `max_open_trades` pieces.
-Profits from early trades will result in subsequent higher stake amounts, resulting in compounding of profits over the backtesting period.
-
-### Example backtesting commands
-
-With 5 min candle (OHLCV) data (per default)
-
-```bash
-freqtrade backtesting --strategy AwesomeStrategy
-```
-
-Where `--strategy AwesomeStrategy` / `-s AwesomeStrategy` refers to the class name of the strategy, which is within a python file in the `user_data/strategies` directory.
-
----
-
-With 1 min candle (OHLCV) data
-
-```bash
-freqtrade backtesting --strategy AwesomeStrategy --timeframe 1m
-```
-
----
-
-Providing a custom starting balance of 1000 (in stake currency)
-
-```bash
-freqtrade backtesting --strategy AwesomeStrategy --dry-run-wallet 1000
-```
-
----
-
-Using a different on-disk historical candle (OHLCV) data source
-
-Assume you downloaded the history data from the Binance exchange and kept it in the `user_data/data/binance-20180101` directory. 
-You can then use this data for backtesting as follows:
-
-```bash
-freqtrade backtesting --strategy AwesomeStrategy --datadir user_data/data/binance-20180101 
-```
-
----
-
-Comparing multiple Strategies
-
-```bash
-freqtrade backtesting --strategy-list SampleStrategy1 AwesomeStrategy --timeframe 5m
-```
-
-Where `SampleStrategy1` and `AwesomeStrategy` refer to class names of strategies.
-
----
-
-Prevent exporting trades to file
-
-```bash
-freqtrade backtesting --strategy backtesting --export none --config config.json 
-```
-
-Only use this if you're sure you'll not want to plot or analyze your results further.
-
----
-
-Exporting trades to file specifying a custom filename
-
-```bash
-freqtrade backtesting --strategy backtesting --export trades --export-filename=backtest_samplestrategy.json
-```
-
-Please also read about the [strategy startup period](strategy-customization.md#strategy-startup-period).
-
----
-
-Supplying custom fee value
-
-Sometimes your account has certain fee rebates (fee reductions starting with a certain account size or monthly volume), which are not visible to ccxt.
-To account for this in backtesting, you can use the `--fee` command line option to supply this value to backtesting.
-This fee must be a ratio, and will be applied twice (once for trade entry, and once for trade exit).
-
-For example, if the commission fee per order is 0.1% (i.e., 0.001 written as ratio), then you would run backtesting as the following:
-
-```bash
-freqtrade backtesting --fee 0.001
-```
-
-!!! Note
-    Only supply this option (or the corresponding configuration parameter) if you want to experiment with different fee values. By default, Backtesting fetches the default fee from the exchange pair/market info.
-
----
-
-Running backtest with smaller test-set by using timerange
-
-Use the `--timerange` argument to change how much of the test-set you want to use.
-
-For example, running backtesting with the `--timerange=20190501-` option will use all available data starting with May 1st, 2019 from your input data.
-
-```bash
-freqtrade backtesting --timerange=20190501-
-```
-
-You can also specify particular date ranges.
-
-The full timerange specification:
-
-- Use data until 2018/01/31: `--timerange=-20180131`
-- Use data since 2018/01/31: `--timerange=20180131-`
-- Use data since 2018/01/31 till 2018/03/01 : `--timerange=20180131-20180301`
-- Use data between POSIX / epoch timestamps 1527595200 1527618600: `--timerange=1527595200-1527618600`
-
-## Understand the backtesting result
-
-The most important in the backtesting is to understand the result.
-
-A backtesting result will look like that:
-
-```
-================================================ BACKTESTING REPORT =================================================
-| Pair     | Trades |   Avg Profit % |   Tot Profit BTC |   Tot Profit % | Avg Duration |  Wins Draws Loss   Win%  |
-|----------+--------+----------------+------------------+----------------+--------------+--------------------------|
-| ADA/BTC  |     35 |          -0.11 |      -0.00019428 |          -1.94 | 4:35:00      |    14     0    21   40.0 |
-| ARK/BTC  |     11 |          -0.41 |      -0.00022647 |          -2.26 | 2:03:00      |     3     0     8   27.3 |
-| BTS/BTC  |     32 |           0.31 |       0.00048938 |           4.89 | 5:05:00      |    18     0    14   56.2 |
-| DASH/BTC |     13 |          -0.08 |      -0.00005343 |          -0.53 | 4:39:00      |     6     0     7   46.2 |
-| ENG/BTC  |     18 |           1.36 |       0.00122807 |          12.27 | 2:50:00      |     8     0    10   44.4 |
-| EOS/BTC  |     36 |           0.08 |       0.00015304 |           1.53 | 3:34:00      |    16     0    20   44.4 |
-| ETC/BTC  |     26 |           0.37 |       0.00047576 |           4.75 | 6:14:00      |    11     0    15   42.3 |
-| ETH/BTC  |     33 |           0.30 |       0.00049856 |           4.98 | 7:31:00      |    16     0    17   48.5 |
-| IOTA/BTC |     32 |           0.03 |       0.00005444 |           0.54 | 3:12:00      |    14     0    18   43.8 |
-| LSK/BTC  |     15 |           1.75 |       0.00131413 |          13.13 | 2:58:00      |     6     0     9   40.0 |
-| LTC/BTC  |     32 |          -0.04 |      -0.00006886 |          -0.69 | 4:49:00      |    11     0    21   34.4 |
-| NANO/BTC |     17 |           1.26 |       0.00107058 |          10.70 | 1:55:00      |    10     0     7   58.5 |
-| NEO/BTC  |     23 |           0.82 |       0.00094936 |           9.48 | 2:59:00      |    10     0    13   43.5 |
-| REQ/BTC  |      9 |           1.17 |       0.00052734 |           5.27 | 3:47:00      |     4     0     5   44.4 |
-| XLM/BTC  |     16 |           1.22 |       0.00097800 |           9.77 | 3:15:00      |     7     0     9   43.8 |
-| XMR/BTC  |     23 |          -0.18 |      -0.00020696 |          -2.07 | 5:30:00      |    12     0    11   52.2 |
-| XRP/BTC  |     35 |           0.66 |       0.00114897 |          11.48 | 3:49:00      |    12     0    23   34.3 |
-| ZEC/BTC  |     22 |          -0.46 |      -0.00050971 |          -5.09 | 2:22:00      |     7     0    15   31.8 |
-| TOTAL    |    429 |           0.36 |       0.00762792 |          76.20 | 4:12:00      |   186     0   243   43.4 |
-============================================= LEFT OPEN TRADES REPORT =============================================
-| Pair     |  Trades |   Avg Profit % |   Tot Profit BTC |   Tot Profit % | Avg Duration   |  Win Draw Loss Win% |
-|----------+---------+----------------+------------------+----------------+----------------+---------------------|
-| ADA/BTC  |       1 |           0.89 |       0.00004434 |           0.44 | 6:00:00        |    1    0    0  100 |
-| LTC/BTC  |       1 |           0.68 |       0.00003421 |           0.34 | 2:00:00        |    1    0    0  100 |
-| TOTAL    |       2 |           0.78 |       0.00007855 |           0.78 | 4:00:00        |    2    0    0  100 |
-==================== EXIT REASON STATS ====================
-| Exit Reason        |   Exits |  Wins |  Draws |  Losses |
-|--------------------+---------+-------+--------+---------|
-| trailing_stop_loss |     205 |   150 |      0 |      55 |
-| stop_loss          |     166 |     0 |      0 |     166 |
-| exit_signal        |      56 |    36 |      0 |      20 |
-| force_exit         |       2 |     0 |      0 |       2 |
-
-================== SUMMARY METRICS ==================
-| Metric                      | Value               |
-|-----------------------------+---------------------|
-| Backtesting from            | 2019-01-01 00:00:00 |
-| Backtesting to              | 2019-05-01 00:00:00 |
-| Trading Mode                | Spot                |
-| Max open trades             | 3                   |
-|                             |                     |
-| Total/Daily Avg Trades      | 429 / 3.575         |
-| Starting balance            | 0.01000000 BTC      |
-| Final balance               | 0.01762792 BTC      |
-| Absolute profit             | 0.00762792 BTC      |
-| Total profit %              | 76.2%               |
-| CAGR %                      | 460.87%             |
-| Sortino                     | 1.88                |
-| Sharpe                      | 2.97                |
-| Calmar                      | 6.29                |
-| Profit factor               | 1.11                |
-| Expectancy (Ratio)          | -0.15 (-0.05)       |
-| Avg. stake amount           | 0.001      BTC      |
-| Total trade volume          | 0.429      BTC      |
-|                             |                     |
-| Long / Short                | 352 / 77            |
-| Total profit Long %         | 1250.58%            |
-| Total profit Short %        | -15.02%             |
-| Absolute profit Long        | 0.00838792 BTC      |
-| Absolute profit Short       | -0.00076 BTC        |
-|                             |                     |
-| Best Pair                   | LSK/BTC 26.26%      |
-| Worst Pair                  | ZEC/BTC -10.18%     |
-| Best Trade                  | LSK/BTC 4.25%       |
-| Worst Trade                 | ZEC/BTC -10.25%     |
-| Best day                    | 0.00076 BTC         |
-| Worst day                   | -0.00036 BTC        |
-| Days win/draw/lose          | 12 / 82 / 25        |
-| Avg. Duration Winners       | 4:23:00             |
-| Avg. Duration Loser         | 6:55:00             |
-| Max Consecutive Wins / Loss | 3 / 4               |
-| Rejected Entry signals      | 3089                |
-| Entry/Exit Timeouts         | 0 / 0               |
-| Canceled Trade Entries      | 34                  |
-| Canceled Entry Orders       | 123                 |
-| Replaced Entry Orders       | 89                  |
-|                             |                     |
-| Min balance                 | 0.00945123 BTC      |
-| Max balance                 | 0.01846651 BTC      |
-| Max % of account underwater | 25.19%              |
-| Absolute Drawdown (Account) | 13.33%              |
-| Drawdown                    | 0.0015 BTC          |
-| Drawdown high               | 0.0013 BTC          |
-| Drawdown low                | -0.0002 BTC         |
-| Drawdown Start              | 2019-02-15 14:10:00 |
-| Drawdown End                | 2019-04-11 18:15:00 |
-| Market change               | -5.88%              |
-=====================================================
-```
-
-### Backtesting report table
-
-The 1st table contains all trades the bot made, including "left open trades".
-
-The last line will give you the overall performance of your strategy,
-here:
-
-```
-| TOTAL    |    429 |           0.36 |         152.41 |       0.00762792 |          76.20 | 4:12:00      |   186     0   243   43.4 |
-```
-
-The bot has made `429` trades for an average duration of `4:12:00`, with a performance of `76.20%` (profit), that means it has
-earned a total of `0.00762792 BTC` starting with a capital of 0.01 BTC.
-
-The column `Avg Profit %` shows the average profit for all trades made.
-The column `Tot Profit %` shows instead the total profit % in relation to the starting balance.
-In the above results, we have a starting balance of 0.01 BTC and an absolute profit of 0.00762792 BTC - so the `Tot Profit %` will be `(0.00762792 / 0.01) * 100 ~= 76.2%`.
-
-Your strategy performance is influenced by your entry strategy, your exit strategy, and also by the `minimal_roi` and `stop_loss` you have set.
-
-For example, if your `minimal_roi` is only `"0":  0.01` you cannot expect the bot to make more profit than 1% (because it will exit every time a trade reaches 1%).
-
-```json
-"minimal_roi": {
-    "0":  0.01
-},
-```
-
-On the other hand, if you set a too high `minimal_roi` like `"0":  0.55`
-(55%), there is almost no chance that the bot will ever reach this profit.
-Hence, keep in mind that your performance is an integral mix of all different elements of the strategy, your configuration, and the crypto-currency pairs you have set up.
-
-### Exit reasons table
-
-The 2nd table contains a recap of exit reasons.
-This table can tell you which area needs some additional work (e.g. all or many of the `exit_signal` trades are losses, so you should work on improving the exit signal, or consider disabling it).
-
-### Left open trades table
-
-The 3rd table contains all trades the bot had to `force_exit` at the end of the backtesting period to present you the full picture.
-This is necessary to simulate realistic behavior, since the backtest period has to end at some point, while realistically, you could leave the bot running forever.
-These trades are also included in the first table, but are also shown separately in this table for clarity.
-
-### Summary metrics
-
-The last element of the backtest report is the summary metrics table.
-It contains some useful key metrics about performance of your strategy on backtesting data.
-
-```
-================== SUMMARY METRICS ==================
-| Metric                      | Value               |
-|-----------------------------+---------------------|
-| Backtesting from            | 2019-01-01 00:00:00 |
-| Backtesting to              | 2019-05-01 00:00:00 |
-| Trading Mode                | Spot                |
-| Max open trades             | 3                   |
-|                             |                     |
-| Total/Daily Avg Trades      | 429 / 3.575         |
-| Starting balance            | 0.01000000 BTC      |
-| Final balance               | 0.01762792 BTC      |
-| Absolute profit             | 0.00762792 BTC      |
-| Total profit %              | 76.2%               |
-| CAGR %                      | 460.87%             |
-| Sortino                     | 1.88                |
-| Sharpe                      | 2.97                |
-| Calmar                      | 6.29                |
-| Profit factor               | 1.11                |
-| Expectancy (Ratio)          | -0.15 (-0.05)       |
-| Avg. stake amount           | 0.001      BTC      |
-| Total trade volume          | 0.429      BTC      |
-|                             |                     |
-| Long / Short                | 352 / 77            |
-| Total profit Long %         | 1250.58%            |
-| Total profit Short %        | -15.02%             |
-| Absolute profit Long        | 0.00838792 BTC      |
-| Absolute profit Short       | -0.00076 BTC        |
-|                             |                     |
-| Best Pair                   | LSK/BTC 26.26%      |
-| Worst Pair                  | ZEC/BTC -10.18%     |
-| Best Trade                  | LSK/BTC 4.25%       |
-| Worst Trade                 | ZEC/BTC -10.25%     |
-| Best day                    | 0.00076 BTC         |
-| Worst day                   | -0.00036 BTC        |
-| Days win/draw/lose          | 12 / 82 / 25        |
-| Avg. Duration Winners       | 4:23:00             |
-| Avg. Duration Loser         | 6:55:00             |
-| Max Consecutive Wins / Loss | 3 / 4               |
-| Rejected Entry signals      | 3089                |
-| Entry/Exit Timeouts         | 0 / 0               |
-| Canceled Trade Entries      | 34                  |
-| Canceled Entry Orders       | 123                 |
-| Replaced Entry Orders       | 89                  |
-|                             |                     |
-| Min balance                 | 0.00945123 BTC      |
-| Max balance                 | 0.01846651 BTC      |
-| Max % of account underwater | 25.19%              |
-| Absolute Drawdown (Account) | 13.33%              |
-| Drawdown                    | 0.0015 BTC          |
-| Drawdown high               | 0.0013 BTC          |
-| Drawdown low                | -0.0002 BTC         |
-| Drawdown Start              | 2019-02-15 14:10:00 |
-| Drawdown End                | 2019-04-11 18:15:00 |
-| Market change               | -5.88%              |
-=====================================================
-
-```
-
-- `Backtesting from` / `Backtesting to`: Backtesting range (usually defined with the `--timerange` option).
-- `Max open trades`: Setting of `max_open_trades` (or `--max-open-trades`) - or number of pairs in the pairlist (whatever is lower).
-- `Trading Mode`: Spot or Futures trading.
-- `Total/Daily Avg Trades`: Identical to the total trades of the backtest output table / Total trades divided by the backtesting duration in days (this will give you information about how many trades to expect from the strategy).
-- `Starting balance`: Start balance - as given by dry-run-wallet (config or command line).
-- `Final balance`: Final balance - starting balance + absolute profit.
-- `Absolute profit`: Profit made in stake currency.
-- `Total profit %`: Total profit. Aligned to the `TOTAL` row's `Tot Profit %` from the first table. Calculated as `(End capital − Starting capital) / Starting capital`.
-- `CAGR %`: Compound annual growth rate.
-- `Sortino`: Annualized Sortino ratio.
-- `Sharpe`: Annualized Sharpe ratio.
-- `Calmar`: Annualized Calmar ratio.
-- `Profit factor`: profit / loss.
-- `Avg. stake amount`: Average stake amount, either `stake_amount` or the average when using dynamic stake amount.
-- `Total trade volume`: Volume generated on the exchange to reach the above profit.
-- `Best Pair` / `Worst Pair`: Best and worst performing pair, and it's corresponding `Tot Profit %`.
-- `Best Trade` / `Worst Trade`: Biggest single winning trade and biggest single losing trade.
-- `Best day` / `Worst day`: Best and worst day based on daily profit.
-- `Days win/draw/lose`: Winning / Losing days (draws are usually days without closed trade).
-- `Avg. Duration Winners` / `Avg. Duration Loser`: Average durations for winning and losing trades.
-- `Max Consecutive Wins / Loss`: Maximum consecutive wins/losses in a row.
-- `Rejected Entry signals`: Trade entry signals that could not be acted upon due to `max_open_trades` being reached.
-- `Entry/Exit Timeouts`: Entry/exit orders which did not fill (only applicable if custom pricing is used).
-- `Canceled Trade Entries`: Number of trades that have been canceled by user request via `adjust_entry_price`.
-- `Canceled Entry Orders`: Number of entry orders that have been canceled by user request via `adjust_entry_price`.
-- `Replaced Entry Orders`: Number of entry orders that have been replaced by user request via `adjust_entry_price`.
-- `Min balance` / `Max balance`: Lowest and Highest Wallet balance during the backtest period.
-- `Max % of account underwater`: Maximum percentage your account has decreased from the top since the simulation started.
-Calculated as the maximum of `(Max Balance - Current Balance) / (Max Balance)`.
-- `Absolute Drawdown (Account)`: Maximum Account Drawdown experienced. Calculated as `(Absolute Drawdown) / (DrawdownHigh + startingBalance)`.
-- `Drawdown`: Maximum, absolute drawdown experienced. Difference between Drawdown High and Subsequent Low point.
-- `Drawdown high` / `Drawdown low`: Profit at the beginning and end of the largest drawdown period. A negative low value means initial capital lost.
-- `Drawdown Start` / `Drawdown End`: Start and end datetime for this largest drawdown (can also be visualized via the `plot-dataframe` sub-command).
-- `Market change`: Change of the market during the backtest period. Calculated as average of all pairs changes from the first to the last candle using the "close" column.
-- `Long / Short`: Split long/short values (Only shown when short trades were made).
-- `Total profit Long %` / `Absolute profit Long`: Profit long trades only (Only shown when short trades were made).
-- `Total profit Short %` / `Absolute profit Short`: Profit short trades only (Only shown when short trades were made).
-
-### Daily / Weekly / Monthly breakdown
-
-You can get an overview over daily / weekly or monthly results by using the `--breakdown <>` switch.
-
-To visualize daily and weekly breakdowns, you can use the following:
-
-``` bash
-freqtrade backtesting --strategy MyAwesomeStrategy --breakdown day week
-```
-
-``` output
-======================== DAY BREAKDOWN =========================
-|        Day |   Tot Profit USDT |   Wins |   Draws |   Losses |
-|------------+-------------------+--------+---------+----------|
-| 03/07/2021 |           200.0   |      2 |       0 |        0 |
-| 04/07/2021 |           -50.31  |      0 |       0 |        2 |
-| 05/07/2021 |           220.611 |      3 |       2 |        0 |
-| 06/07/2021 |           150.974 |      3 |       0 |        2 |
-| 07/07/2021 |           -70.193 |      1 |       0 |        2 |
-| 08/07/2021 |           212.413 |      2 |       0 |        3 |
-
-```
-
-The output will show a table containing the realized absolute Profit (in stake currency) for the given timeperiod, as well as wins, draws and losses that materialized (closed) on this day. Below that there will be a second table for the summarized values of weeks indicated by the date of the closing Sunday. The same would apply to a monthly breakdown indicated by the last day of the month.
-
-### Backtest result caching
-
-To save time, by default backtest will reuse a cached result from within the last day when the backtested strategy and config match that of a previous backtest. To force a new backtest despite existing result for an identical run specify `--cache none` parameter.
-
-!!! Warning
-    Caching is automatically disabled for open-ended timeranges (`--timerange 20210101-`), as freqtrade cannot ensure reliably that the underlying data didn't change. It can also use cached results where it shouldn't if the original backtest had missing data at the end, which was fixed by downloading more data.
-    In this instance, please use `--cache none` once to force a fresh backtest.
-
-### Further backtest-result analysis
-
-To further analyze your backtest results, freqtrade will export the trades to file by default.
-You can then load the trades to perform further analysis as shown in the [data analysis](strategy_analysis_example.md#load-backtest-results-to-pandas-dataframe) backtesting section.
-
-## Assumptions made by backtesting
-
-Since backtesting lacks some detailed information about what happens within a candle, it needs to take a few assumptions:
-
-- Exchange [trading limits](#trading-limits-in-backtesting) are respected
-- Entries happen at open-price unless a custom price logic has been specified
-- All orders are filled at the requested price (no slippage) as long as the price is within the candle's high/low range
-- Exit-signal exits happen at open-price of the consecutive candle
-- Exits free their trade slot for a new trade with a different pair
-- Exit-signal is favored over Stoploss, because exit-signals are assumed to trigger on candle's open
-- ROI
-  - Exits are compared to high - but the ROI value is used (e.g. ROI = 2%, high=5% - so the exit will be at 2%)
-  - Exits are never "below the candle", so a ROI of 2% may result in a exit at 2.4% if low was at 2.4% profit
-  - ROI entries which came into effect on the triggering candle (e.g. `120: 0.02` for 1h candles, from `60: 0.05`) will use the candle's open as exit rate
-  - Force-exits caused by `<N>=-1` ROI entries use low as exit value, unless N falls on the candle open (e.g. `120: -1` for 1h candles)
-- Stoploss exits happen exactly at stoploss price, even if low was lower, but the loss will be `2 * fees` higher than the stoploss price
-- Stoploss is evaluated before ROI within one candle. So you can often see more trades with the `stoploss` exit reason comparing to the results obtained with the same strategy in the Dry Run/Live Trade modes
-- Low happens before high for stoploss, protecting capital first
-- Trailing stoploss
-  - Trailing Stoploss is only adjusted if it's below the candle's low (otherwise it would be triggered)
-  - On trade entry candles that trigger trailing stoploss, the "minimum offset" (`stop_positive_offset`) is assumed (instead of high) - and the stop is calculated from this point. This rule is NOT applicable to custom-stoploss scenarios, since there's no information about the stoploss logic available.
-  - High happens first - adjusting stoploss
-  - Low uses the adjusted stoploss (so exits with large high-low difference are backtested correctly)
-  - ROI applies before trailing-stop, ensuring profits are "top-capped" at ROI if both ROI and trailing stop applies
-- Exit-reason does not explain if a trade was positive or negative, just what triggered the exit (this can look odd if negative ROI values are used)
-- Evaluation sequence (if multiple signals happen on the same candle)
-  - Exit-signal
-  - Stoploss
-  - ROI
-  - Trailing stoploss
-
-Taking these assumptions, backtesting tries to mirror real trading as closely as possible. However, backtesting will **never** replace running a strategy in dry-run mode.
-Also, keep in mind that past results don't guarantee future success.
-
-In addition to the above assumptions, strategy authors should carefully read the [Common Mistakes](strategy-customization.md#common-mistakes-when-developing-strategies) section, to avoid using data in backtesting which is not available in real market conditions.
-
-### Trading limits in backtesting
-
-Exchanges have certain trading limits, like minimum (and maximum) base currency, or minimum/maximum stake (quote) currency.
-These limits are usually listed in the exchange documentation as "trading rules" or similar and can be quite different between different pairs.
-
-Backtesting (as well as live and dry-run) does honor these limits, and will ensure that a stoploss can be placed below this value - so the value will be slightly higher than what the exchange specifies.
-Freqtrade has however no information about historic limits.
-
-This can lead to situations where trading-limits are inflated by using a historic price, resulting in minimum amounts > 50$.
-
-For example:
-
-BTC minimum tradable amount is 0.001.
-BTC trades at 22.000\$ today (0.001 BTC is related to this) - but the backtesting period includes prices as high as 50.000\$.
-Today's minimum would be `0.001 * 22_000` - or 22\$.  
-However the limit could also be 50$ - based on `0.001 * 50_000` in some historic setting.
-
-#### Trading precision limits
-
-Most exchanges pose precision limits on both price and amounts, so you cannot buy 1.0020401 of a pair, or at a price of 1.24567123123.  
-Instead, these prices and amounts will be rounded or truncated (based on the exchange definition) to the defined trading precision.
-The above values may for example be rounded to an amount of 1.002, and a price of 1.24567.
-
-These precision values are based on current exchange limits (as described in the [above section](#trading-limits-in-backtesting)), as historic precision limits are not available.
-
-## Improved backtest accuracy
-
-One big limitation of backtesting is it's inability to know how prices moved intra-candle (was high before close, or vice-versa?).
-So assuming you run backtesting with a 1h timeframe, there will be 4 prices for that candle (Open, High, Low, Close).
-
-While backtesting does take some assumptions (read above) about this - this can never be perfect, and will always be biased in one way or the other.
-To mitigate this, freqtrade can use a lower (faster) timeframe to simulate intra-candle movements.
-
-To utilize this, you can append `--timeframe-detail 5m` to your regular backtesting command.
-
-``` bash
-freqtrade backtesting --strategy AwesomeStrategy --timeframe 1h --timeframe-detail 5m
-```
-
-This will load 1h data as well as 5m data for the timeframe. The strategy will be analyzed with the 1h timeframe, and Entry orders will only be placed at the main timeframe, however Order fills and exit signals will be evaluated at the 5m candle, simulating intra-candle movements.
-
-All callback functions (`custom_exit()`, `custom_stoploss()`, ... ) will be running for each 5m candle once the trade is opened (so 12 times in the above example of 1h timeframe, and 5m detailed timeframe).
-
-`--timeframe-detail` must be smaller than the original timeframe, otherwise backtesting will fail to start.
-
-Obviously this will require more memory (5m data is bigger than 1h data), and will also impact runtime (depending on the amount of trades and trade durations).
-Also, data must be available / downloaded already.
-
-!!! Tip
-    You can use this function as the last part of strategy development, to ensure your strategy is not exploiting one of the [backtesting assumptions](#assumptions-made-by-backtesting). Strategies that perform similarly well with this mode have a good chance to perform well in dry/live modes too (although only forward-testing (dry-mode) can really confirm a strategy).
-
-## Backtesting multiple strategies
-
-To compare multiple strategies, a list of Strategies can be provided to backtesting.
-
-This is limited to 1 timeframe value per run. However, data is only loaded once from disk so if you have multiple
-strategies you'd like to compare, this will give a nice runtime boost.
-
-All listed Strategies need to be in the same directory, unless also `--recursive-strategy-search` is specified, where sub-directories within the strategy directory are also considered.
-
-``` bash
-freqtrade backtesting --timerange 20180401-20180410 --timeframe 5m --strategy-list Strategy001 Strategy002 --export trades
-```
-
-This will save the results to `user_data/backtest_results/backtest-result-<datetime>.json`, including results for both `Strategy001` and `Strategy002`.
-There will be an additional table comparing win/losses of the different strategies (identical to the "Total" row in the first table).
-Detailed output for all strategies one after the other will be available, so make sure to scroll up to see the details per strategy.
-
-```
-================================================== STRATEGY SUMMARY ===================================================================
-| Strategy    |  Trades |   Avg Profit % |   Tot Profit BTC |   Tot Profit % | Avg Duration   |  Wins |  Draws | Losses | Drawdown % |
-|-------------+---------+----------------+------------------+----------------+----------------+-------+--------+--------+------------|
-| Strategy1   |     429 |           0.36 |       0.00762792 |          76.20 | 4:12:00        |   186 |      0 |    243 |       45.2 |
-| Strategy2   |    1487 |          -0.13 |      -0.00988917 |         -98.79 | 4:43:00        |   662 |      0 |    825 |     241.68 |
-```
-
-## Next step
-
-Great, your strategy is profitable. What if the bot can give your the optimal parameters to use for your strategy?
-Your next step is to learn [how to find optimal parameters with Hyperopt](hyperopt.md)

docs/bot-basics.md

@@ -1,101 +0,0 @@
-# Freqtrade basics
-
-This page provides you some basic concepts on how Freqtrade works and operates.
-
-## Freqtrade terminology
-
-* **Strategy**: Your trading strategy, telling the bot what to do.
-* **Trade**: Open position.
-* **Open Order**: Order which is currently placed on the exchange, and is not yet complete.
-* **Pair**: Tradable pair, usually in the format of Base/Quote (e.g. `XRP/USDT` for spot, `XRP/USDT:USDT` for futures).
-* **Timeframe**: Candle length to use (e.g. `"5m"`, `"1h"`, ...).
-* **Indicators**: Technical indicators (SMA, EMA, RSI, ...).
-* **Limit order**: Limit orders which execute at the defined limit price or better.
-* **Market order**: Guaranteed to fill, may move price depending on the order size.
-* **Current Profit**: Currently pending (unrealized) profit for this trade. This is mainly used throughout the bot and UI.
-* **Realized Profit**: Already realized profit. Only relevant in combination with [partial exits](strategy-callbacks.md#adjust-trade-position) - which also explains the calculation logic for this.
-* **Total Profit**: Combined realized and unrealized profit. The relative number (%) is calculated against the total investment in this trade.
-
-## Fee handling
-
-All profit calculations of Freqtrade include fees. For Backtesting / Hyperopt / Dry-run modes, the exchange default fee is used (lowest tier on the exchange). For live operations, fees are used as applied by the exchange (this includes BNB rebates etc.).
-
-## Pair naming
-
-Freqtrade follows the [ccxt naming convention](https://docs.ccxt.com/#/README?id=consistency-of-base-and-quote-currencies) for currencies.
-Using the wrong naming convention in the wrong market will usually result in the bot not recognizing the pair, usually resulting in errors like "this pair is not available".
-
-### Spot pair naming
-
-For spot pairs, naming will be `base/quote` (e.g. `ETH/USDT`).
-
-### Futures pair naming
-
-For futures pairs, naming will be `base/quote:settle` (e.g. `ETH/USDT:USDT`).
-
-## Bot execution logic
-
-Starting freqtrade in dry-run or live mode (using `freqtrade trade`) will start the bot and start the bot iteration loop.
-This will also run the `bot_start()` callback.
-
-By default, the bot loop runs every few seconds (`internals.process_throttle_secs`) and performs the following actions:
-
-* Fetch open trades from persistence.
-* Calculate current list of tradable pairs.
-* Download OHLCV data for the pairlist including all [informative pairs](strategy-customization.md#get-data-for-non-tradeable-pairs)  
-  This step is only executed once per Candle to avoid unnecessary network traffic.
-* Call `bot_loop_start()` strategy callback.
-* Analyze strategy per pair.
-  * Call `populate_indicators()`
-  * Call `populate_entry_trend()`
-  * Call `populate_exit_trend()`
-* Update trades open order state from exchange.
-  * Call `order_filled()` strategy callback for filled orders.
-  * Check timeouts for open orders.
-    * Calls `check_entry_timeout()` strategy callback for open entry orders.
-    * Calls `check_exit_timeout()` strategy callback for open exit orders.
-    * Calls `adjust_entry_price()` strategy callback for open entry orders.
-* Verifies existing positions and eventually places exit orders.
-  * Considers stoploss, ROI and exit-signal, `custom_exit()` and `custom_stoploss()`.
-  * Determine exit-price based on `exit_pricing` configuration setting or by using the `custom_exit_price()` callback.
-  * Before a exit order is placed, `confirm_trade_exit()` strategy callback is called.
-* Check position adjustments for open trades if enabled by calling `adjust_trade_position()` and place additional order if required.
-* Check if trade-slots are still available (if `max_open_trades` is reached).
-* Verifies entry signal trying to enter new positions.
-  * Determine entry-price based on `entry_pricing` configuration setting, or by using the `custom_entry_price()` callback.
-  * In Margin and Futures mode, `leverage()` strategy callback is called to determine the desired leverage.
-  * Determine stake size by calling the `custom_stake_amount()` callback.
-  * Before an entry order is placed, `confirm_trade_entry()` strategy callback is called.
-
-This loop will be repeated again and again until the bot is stopped.
-
-## Backtesting / Hyperopt execution logic
-
-[backtesting](backtesting.md) or [hyperopt](hyperopt.md) do only part of the above logic, since most of the trading operations are fully simulated.
-
-* Load historic data for configured pairlist.
-* Calls `bot_start()` once.
-* Calculate indicators (calls `populate_indicators()` once per pair).
-* Calculate entry / exit signals (calls `populate_entry_trend()` and `populate_exit_trend()` once per pair).
-* Loops per candle simulating entry and exit points.
-  * Calls `bot_loop_start()` strategy callback.
-  * Check for Order timeouts, either via the `unfilledtimeout` configuration, or via `check_entry_timeout()` / `check_exit_timeout()` strategy callbacks.
-  * Calls `adjust_entry_price()` strategy callback for open entry orders.
-  * Check for trade entry signals (`enter_long` / `enter_short` columns).
-  * Confirm trade entry / exits (calls `confirm_trade_entry()` and `confirm_trade_exit()` if implemented in the strategy).
-  * Call `custom_entry_price()` (if implemented in the strategy) to determine entry price (Prices are moved to be within the opening candle).
-  * In Margin and Futures mode, `leverage()` strategy callback is called to determine the desired leverage.
-  * Determine stake size by calling the `custom_stake_amount()` callback.
-  * Check position adjustments for open trades if enabled and call `adjust_trade_position()` to determine if an additional order is requested.
-  * Call `order_filled()` strategy callback for filled entry orders.
-  * Call `custom_stoploss()` and `custom_exit()` to find custom exit points.
-  * For exits based on exit-signal, custom-exit and partial exits: Call `custom_exit_price()` to determine exit price (Prices are moved to be within the closing candle).
-  * Call `order_filled()` strategy callback for filled exit orders.
-* Generate backtest report output
-
-!!! Note
-    Both Backtesting and Hyperopt include exchange default Fees in the calculation. Custom fees can be passed to backtesting / hyperopt by specifying the `--fee` argument.
-
-!!! Warning "Callback call frequency"
-    Backtesting will call each callback at max. once per candle (`--timeframe-detail` modifies this behavior to once per detailed candle).
-    Most callbacks will be called once per iteration in live (usually every ~5s) - which can cause backtesting mismatches.

docs/bot-usage.md

@@ -1,226 +0,0 @@
-# Start the bot
-
-This page explains the different parameters of the bot and how to run it.
-
-!!! Note
-    If you've used `setup.sh`, don't forget to activate your virtual environment (`source .venv/bin/activate`) before running freqtrade commands.
-
-!!! Warning "Up-to-date clock"
-    The clock on the system running the bot must be accurate, synchronized to a NTP server frequently enough to avoid problems with communication to the exchanges.
-
-## Bot commands
-
-```
-usage: freqtrade [-h] [-V]
-                 {trade,create-userdir,new-config,show-config,new-strategy,download-data,convert-data,convert-trade-data,trades-to-ohlcv,list-data,backtesting,backtesting-show,backtesting-analysis,edge,hyperopt,hyperopt-list,hyperopt-show,list-exchanges,list-markets,list-pairs,list-strategies,list-freqaimodels,list-timeframes,show-trades,test-pairlist,convert-db,install-ui,plot-dataframe,plot-profit,webserver,strategy-updater,lookahead-analysis,recursive-analysis}
-                 ...
-
-Free, open source crypto trading bot
-
-positional arguments:
-  {trade,create-userdir,new-config,show-config,new-strategy,download-data,convert-data,convert-trade-data,trades-to-ohlcv,list-data,backtesting,backtesting-show,backtesting-analysis,edge,hyperopt,hyperopt-list,hyperopt-show,list-exchanges,list-markets,list-pairs,list-strategies,list-freqaimodels,list-timeframes,show-trades,test-pairlist,convert-db,install-ui,plot-dataframe,plot-profit,webserver,strategy-updater,lookahead-analysis,recursive-analysis}
-    trade               Trade module.
-    create-userdir      Create user-data directory.
-    new-config          Create new config
-    show-config         Show resolved config
-    new-strategy        Create new strategy
-    download-data       Download backtesting data.
-    convert-data        Convert candle (OHLCV) data from one format to
-                        another.
-    convert-trade-data  Convert trade data from one format to another.
-    trades-to-ohlcv     Convert trade data to OHLCV data.
-    list-data           List downloaded data.
-    backtesting         Backtesting module.
-    backtesting-show    Show past Backtest results
-    backtesting-analysis
-                        Backtest Analysis module.
-    edge                Edge module.
-    hyperopt            Hyperopt module.
-    hyperopt-list       List Hyperopt results
-    hyperopt-show       Show details of Hyperopt results
-    list-exchanges      Print available exchanges.
-    list-markets        Print markets on exchange.
-    list-pairs          Print pairs on exchange.
-    list-strategies     Print available strategies.
-    list-freqaimodels   Print available freqAI models.
-    list-timeframes     Print available timeframes for the exchange.
-    show-trades         Show trades.
-    test-pairlist       Test your pairlist configuration.
-    convert-db          Migrate database to different system
-    install-ui          Install FreqUI
-    plot-dataframe      Plot candles with indicators.
-    plot-profit         Generate plot showing profits.
-    webserver           Webserver module.
-    strategy-updater    updates outdated strategy files to the current version
-    lookahead-analysis  Check for potential look ahead bias.
-    recursive-analysis  Check for potential recursive formula issue.
-
-options:
-  -h, --help            show this help message and exit
-  -V, --version         show program's version number and exit
-
-```
-
-### Bot trading commands
-
-```
-usage: freqtrade trade [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH]
-                       [--userdir PATH] [-s NAME] [--strategy-path PATH]
-                       [--db-url PATH] [--sd-notify] [--dry-run]
-                       [--dry-run-wallet DRY_RUN_WALLET]
-
-optional arguments:
-  -h, --help            show this help message and exit
-  --db-url PATH         Override trades database URL, this is useful in custom
-                        deployments (default: `sqlite:///tradesv3.sqlite` for
-                        Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for
-                        Dry Run).
-  --sd-notify           Notify systemd service manager.
-  --dry-run             Enforce dry-run for trading (removes Exchange secrets
-                        and simulates trades).
-  --dry-run-wallet DRY_RUN_WALLET, --starting-balance DRY_RUN_WALLET
-                        Starting balance, used for backtesting / hyperopt and
-                        dry-runs.
-
-Common arguments:
-  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
-  --logfile FILE        Log to the file specified. Special values are:
-                        'syslog', 'journald'. See the documentation for more
-                        details.
-  -V, --version         show program's version number and exit
-  -c PATH, --config PATH
-                        Specify configuration file (default:
-                        `userdir/config.json` or `config.json` whichever
-                        exists). Multiple --config options may be used. Can be
-                        set to `-` to read config from stdin.
-  -d PATH, --datadir PATH
-                        Path to directory with historical backtesting data.
-  --userdir PATH, --user-data-dir PATH
-                        Path to userdata directory.
-
-Strategy arguments:
-  -s NAME, --strategy NAME
-                        Specify strategy class name which will be used by the
-                        bot.
-  --strategy-path PATH  Specify additional strategy lookup path.
-
-```
-
-### How to specify which configuration file be used?
-
-The bot allows you to select which configuration file you want to use by means of
-the `-c/--config` command line option:
-
-```bash
-freqtrade trade -c path/far/far/away/config.json
-```
-
-Per default, the bot loads the `config.json` configuration file from the current
-working directory.
-
-### How to use multiple configuration files?
-
-The bot allows you to use multiple configuration files by specifying multiple
-`-c/--config` options in the command line. Configuration parameters
-defined in the latter configuration files override parameters with the same name
-defined in the previous configuration files specified in the command line earlier.
-
-For example, you can make a separate configuration file with your key and secret
-for the Exchange you use for trading, specify default configuration file with
-empty key and secret values while running in the Dry Mode (which does not actually
-require them):
-
-```bash
-freqtrade trade -c ./config.json
-```
-
-and specify both configuration files when running in the normal Live Trade Mode:
-
-```bash
-freqtrade trade -c ./config.json -c path/to/secrets/keys.config.json
-```
-
-This could help you hide your private Exchange key and Exchange secret on you local machine
-by setting appropriate file permissions for the file which contains actual secrets and, additionally,
-prevent unintended disclosure of sensitive private data when you publish examples
-of your configuration in the project issues or in the Internet.
-
-See more details on this technique with examples in the documentation page on
-[configuration](configuration.md).
-
-### Where to store custom data
-
-Freqtrade allows the creation of a user-data directory using `freqtrade create-userdir --userdir someDirectory`.
-This directory will look as follows:
-
-```
-user_data/
-├── backtest_results
-├── data
-├── hyperopts
-├── hyperopt_results
-├── plot
-└── strategies
-```
-
-You can add the entry "user_data_dir" setting to your configuration, to always point your bot to this directory.
-Alternatively, pass in `--userdir` to every command.
-The bot will fail to start if the directory does not exist, but will create necessary subdirectories.
-
-This directory should contain your custom strategies, custom hyperopts and hyperopt loss functions, backtesting historical data (downloaded using either backtesting command or the download script) and plot outputs.
-
-It is recommended to use version control to keep track of changes to your strategies.
-
-### How to use **--strategy**?
-
-This parameter will allow you to load your custom strategy class.
-To test the bot installation, you can use the `SampleStrategy` installed by the `create-userdir` subcommand (usually `user_data/strategy/sample_strategy.py`).
-
-The bot will search your strategy file within `user_data/strategies`.
-To use other directories, please read the next section about `--strategy-path`.
-
-To load a strategy, simply pass the class name (e.g.: `CustomStrategy`) in this parameter.
-
-**Example:**
-In `user_data/strategies` you have a file `my_awesome_strategy.py` which has
-a strategy class called `AwesomeStrategy` to load it:
-
-```bash
-freqtrade trade --strategy AwesomeStrategy
-```
-
-If the bot does not find your strategy file, it will display in an error
-message the reason (File not found, or errors in your code).
-
-Learn more about strategy file in
-[Strategy Customization](strategy-customization.md).
-
-### How to use **--strategy-path**?
-
-This parameter allows you to add an additional strategy lookup path, which gets
-checked before the default locations (The passed path must be a directory!):
-
-```bash
-freqtrade trade --strategy AwesomeStrategy --strategy-path /some/directory
-```
-
-#### How to install a strategy?
-
-This is very simple. Copy paste your strategy file into the directory
-`user_data/strategies` or use `--strategy-path`. And voila, the bot is ready to use it.
-
-### How to use **--db-url**?
-
-When you run the bot in Dry-run mode, per default no transactions are
-stored in a database. If you want to store your bot actions in a DB
-using `--db-url`. This can also be used to specify a custom database
-in production mode. Example command:
-
-```bash
-freqtrade trade -c config.json --db-url sqlite:///tradesv3.dry_run.sqlite
-```
-
-## Next step
-
-The optimal strategy of the bot will change with time depending of the market trends. The next step is to
-[Strategy Customization](strategy-customization.md).

docs/configuration.md

@@ -1,774 +0,0 @@
-# Configure the bot
-
-Freqtrade has many configurable features and possibilities.
-By default, these settings are configured via the configuration file (see below).
-
-## The Freqtrade configuration file
-
-The bot uses a set of configuration parameters during its operation that all together conform to the bot configuration. It normally reads its configuration from a file (Freqtrade configuration file).
-
-Per default, the bot loads the configuration from the `config.json` file, located in the current working directory.
-
-You can specify a different configuration file used by the bot with the `-c/--config` command-line option.
-
-If you used the [Quick start](docker_quickstart.md#docker-quick-start) method for installing
-the bot, the installation script should have already created the default configuration file (`config.json`) for you.
-
-If the default configuration file is not created we recommend to use `freqtrade new-config --config user_data/config.json` to generate a basic configuration file.
-
-The Freqtrade configuration file is to be written in JSON format.
-
-Additionally to the standard JSON syntax, you may use one-line `// ...` and multi-line `/* ... */` comments in your configuration files and trailing commas in the lists of parameters.
-
-Do not worry if you are not familiar with JSON format -- simply open the configuration file with an editor of your choice, make some changes to the parameters you need, save your changes and, finally, restart the bot or, if it was previously stopped, run it again with the changes you made to the configuration. The bot validates the syntax of the configuration file at startup and will warn you if you made any errors editing it, pointing out problematic lines.
-
-### Environment variables
-
-Set options in the Freqtrade configuration via environment variables.
-This takes priority over the corresponding value in configuration or strategy.
-
-Environment variables must be prefixed with  `FREQTRADE__` to be loaded to the freqtrade configuration.
-
-`__` serves as level separator, so the format used should correspond to `FREQTRADE__{section}__{key}`.
-As such - an environment variable defined as  `export FREQTRADE__STAKE_AMOUNT=200` would result in `{stake_amount: 200}`.
-
-A more complex example might be `export FREQTRADE__EXCHANGE__KEY=<yourExchangeKey>` to keep your exchange key secret. This will move the value to the `exchange.key` section of the configuration.
-Using this scheme, all configuration settings will also be available as environment variables.
-
-Please note that Environment variables will overwrite corresponding settings in your configuration, but command line Arguments will always win.
-
-Common example:
-
-```
-FREQTRADE__TELEGRAM__CHAT_ID=<telegramchatid>
-FREQTRADE__TELEGRAM__TOKEN=<telegramToken>
-FREQTRADE__EXCHANGE__KEY=<yourExchangeKey>
-FREQTRADE__EXCHANGE__SECRET=<yourExchangeSecret>
-```
-
-!!! Note
-    Environment variables detected are logged at startup - so if you can't find why a value is not what you think it should be based on the configuration, make sure it's not loaded from an environment variable.
-
-!!! Tip "Validate combined result"
-    You can use the [show-config subcommand](utils.md#show-config) to see the final, combined configuration.
-
-??? Warning "Loading sequence"
-    Environment variables are loaded after the initial configuration. As such, you cannot provide the path to the configuration through environment variables. Please use `--config path/to/config.json` for that.
-    This also applies to user_dir to some degree. while the user directory can be set through environment variables - the configuration will **not** be loaded from that location.
-
-### Multiple configuration files
-
-Multiple configuration files can be specified and used by the bot or the bot can read its configuration parameters from the process standard input stream.
-
-You can specify additional configuration files in `add_config_files`. Files specified in this parameter will be loaded and merged with the initial config file. The files are resolved relative to the initial configuration file.
-This is similar to using multiple `--config` parameters, but simpler in usage as you don't have to specify all files for all commands.
-
-!!! Tip "Validate combined result"
-    You can use the [show-config subcommand](utils.md#show-config) to see the final, combined configuration.
-
-!!! Tip "Use multiple configuration files to keep secrets secret"
-    You can use a 2nd configuration file containing your secrets. That way you can share your "primary" configuration file, while still keeping your API keys for yourself.
-    The 2nd file should only specify what you intend to override.
-    If a key is in more than one of the configurations, then the "last specified configuration" wins (in the above example, `config-private.json`).
-
-    For one-off commands, you can also use the below syntax by specifying multiple "--config" parameters.
-
-    ``` bash
-    freqtrade trade --config user_data/config1.json --config user_data/config-private.json <...>
-    ```
-
-    The below is equivalent to the example above - but having 2 configuration files in the configuration, for easier reuse.
-
-    ``` json title="user_data/config.json"
-    "add_config_files": [
-        "config1.json",
-        "config-private.json"
-    ]
-    ```
-
-    ``` bash
-    freqtrade trade --config user_data/config.json <...>
-    ```
-
-??? Note "config collision handling"
-    If the same configuration setting takes place in both `config.json` and `config-import.json`, then the parent configuration wins.
-    In the below case, `max_open_trades` would be 3 after the merging - as the reusable "import" configuration has this key overwritten.
-
-    ``` json title="user_data/config.json"
-    {
-        "max_open_trades": 3,
-        "stake_currency": "USDT",
-        "add_config_files": [
-            "config-import.json"
-        ]
-    }
-    ```
-
-    ``` json title="user_data/config-import.json"
-    {
-        "max_open_trades": 10,
-        "stake_amount": "unlimited",
-    }
-    ```
-
-    Resulting combined configuration:
-
-    ``` json title="Result"
-    {
-        "max_open_trades": 3,
-        "stake_currency": "USDT",
-        "stake_amount": "unlimited"
-    }
-    ```
-
-    If multiple files are in the `add_config_files` section, then they will be assumed to be at identical levels, having the last occurrence override the earlier config (unless a parent already defined such a key).
-
-## Editor autocomplete and validation
-
-If you are using an editor that supports JSON schema, you can use the schema provided by Freqtrade to get autocompletion and validation of your configuration file by adding the following line to the top of your configuration file:
-
-``` json
-{
-    "$schema": "https://schema.freqtrade.io/schema.json",
-}
-```
-
-??? Note "Develop version"
-    The develop schema is available as `https://schema.freqtrade.io/schema_dev.json` - though we recommend to stick to the stable version for the best experience.
-
-## Configuration parameters
-
-The table below will list all configuration parameters available.
-
-Freqtrade can also load many options via command line (CLI) arguments (check out the commands `--help` output for details).
-
-### Configuration option prevalence
-
-The prevalence for all Options is as follows:
-
-- CLI arguments override any other option
-- [Environment Variables](#environment-variables)
-- Configuration files are used in sequence (the last file wins) and override Strategy configurations.
-- Strategy configurations are only used if they are not set via configuration or command-line arguments. These options are marked with [Strategy Override](#parameters-in-the-strategy) in the below table.
-
-### Parameters table
-
-Mandatory parameters are marked as **Required**, which means that they are required to be set in one of the possible ways.
-
-|  Parameter | Description |
-|------------|-------------|
-| `max_open_trades` | **Required.** Number of open trades your bot is allowed to have. Only one open trade per pair is possible, so the length of your pairlist is another limitation that can apply. If -1 then it is ignored (i.e. potentially unlimited open trades, limited by the pairlist). [More information below](#configuring-amount-per-trade). [Strategy Override](#parameters-in-the-strategy).<br> **Datatype:** Positive integer or -1.
-| `stake_currency` | **Required.** Crypto-currency used for trading. <br> **Datatype:** String
-| `stake_amount` | **Required.** Amount of crypto-currency your bot will use for each trade. Set it to `"unlimited"` to allow the bot to use all available balance. [More information below](#configuring-amount-per-trade). <br> **Datatype:** Positive float or `"unlimited"`.
-| `tradable_balance_ratio` | Ratio of the total account balance the bot is allowed to trade. [More information below](#configuring-amount-per-trade). <br>*Defaults to `0.99` 99%).*<br> **Datatype:** Positive float between `0.1` and `1.0`.
-| `available_capital` | Available starting capital for the bot. Useful when running multiple bots on the same exchange account. [More information below](#configuring-amount-per-trade). <br> **Datatype:** Positive float.
-| `amend_last_stake_amount` | Use reduced last stake amount if necessary. [More information below](#configuring-amount-per-trade). <br>*Defaults to `false`.* <br> **Datatype:** Boolean
-| `last_stake_amount_min_ratio` | Defines minimum stake amount that has to be left and executed. Applies only to the last stake amount when it's amended to a reduced value (i.e. if `amend_last_stake_amount` is set to `true`). [More information below](#configuring-amount-per-trade). <br>*Defaults to `0.5`.* <br> **Datatype:** Float (as ratio)
-| `amount_reserve_percent` | Reserve some amount in min pair stake amount. The bot will reserve `amount_reserve_percent` + stoploss value when calculating min pair stake amount in order to avoid possible trade refusals. <br>*Defaults to `0.05` (5%).* <br> **Datatype:** Positive Float as ratio.
-| `timeframe` | The timeframe to use (e.g `1m`, `5m`, `15m`, `30m`, `1h` ...). Usually missing in configuration, and specified in the strategy. [Strategy Override](#parameters-in-the-strategy). <br> **Datatype:** String
-| `fiat_display_currency` | Fiat currency used to show your profits. [More information below](#what-values-can-be-used-for-fiat_display_currency). <br> **Datatype:** String
-| `dry_run` | **Required.** Define if the bot must be in Dry Run or production mode. <br>*Defaults to `true`.* <br> **Datatype:** Boolean
-| `dry_run_wallet` | Define the starting amount in stake currency for the simulated wallet used by the bot running in Dry Run mode.<br>*Defaults to `1000`.* <br> **Datatype:** Float
-| `cancel_open_orders_on_exit` | Cancel open orders when the `/stop` RPC command is issued, `Ctrl+C` is pressed or the bot dies unexpectedly. When set to `true`, this allows you to use `/stop` to cancel unfilled and partially filled orders in the event of a market crash. It does not impact open positions. <br>*Defaults to `false`.* <br> **Datatype:** Boolean
-| `process_only_new_candles` | Enable processing of indicators only when new candles arrive. If false each loop populates the indicators, this will mean the same candle is processed many times creating system load but can be useful of your strategy depends on tick data not only candle. [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `true`.*  <br> **Datatype:** Boolean
-| `minimal_roi` | **Required.** Set the threshold as ratio the bot will use to exit a trade. [More information below](#understand-minimal_roi). [Strategy Override](#parameters-in-the-strategy). <br> **Datatype:** Dict
-| `stoploss` |  **Required.** Value as ratio of the stoploss used by the bot. More details in the [stoploss documentation](stoploss.md). [Strategy Override](#parameters-in-the-strategy).  <br> **Datatype:** Float (as ratio)
-| `trailing_stop` | Enables trailing stoploss (based on `stoploss` in either configuration or strategy file). More details in the [stoploss documentation](stoploss.md#trailing-stop-loss). [Strategy Override](#parameters-in-the-strategy). <br> **Datatype:** Boolean
-| `trailing_stop_positive` | Changes stoploss once profit has been reached. More details in the [stoploss documentation](stoploss.md#trailing-stop-loss-custom-positive-loss). [Strategy Override](#parameters-in-the-strategy). <br> **Datatype:** Float
-| `trailing_stop_positive_offset` | Offset on when to apply `trailing_stop_positive`. Percentage value which should be positive. More details in the [stoploss documentation](stoploss.md#trailing-stop-loss-only-once-the-trade-has-reached-a-certain-offset). [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `0.0` (no offset).* <br> **Datatype:** Float
-| `trailing_only_offset_is_reached` | Only apply trailing stoploss when the offset is reached. [stoploss documentation](stoploss.md). [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `false`.*  <br> **Datatype:** Boolean
-| `fee` | Fee used during backtesting / dry-runs. Should normally not be configured, which has freqtrade fall back to the exchange default fee. Set as ratio (e.g. 0.001 = 0.1%). Fee is applied twice for each trade, once when buying, once when selling. <br> **Datatype:** Float (as ratio)
-| `futures_funding_rate` | User-specified funding rate to be used when historical funding rates are not available from the exchange. This does not overwrite real historical rates. It is recommended that this be set to 0 unless you are testing a specific coin and you understand how the funding rate will affect freqtrade's profit calculations. [More information here](leverage.md#unavailable-funding-rates) <br>*Defaults to `None`.*<br> **Datatype:** Float
-| `trading_mode` | Specifies if you want to trade regularly, trade with leverage, or trade contracts whose prices are derived from matching cryptocurrency prices. [leverage documentation](leverage.md). <br>*Defaults to `"spot"`.*  <br> **Datatype:** String
-| `margin_mode` | When trading with leverage, this determines if the collateral owned by the trader will be shared or isolated to each trading pair [leverage documentation](leverage.md). <br> **Datatype:** String
-| `liquidation_buffer` | A ratio specifying how large of a safety net to place between the liquidation price and the stoploss to prevent a position from reaching the liquidation price [leverage documentation](leverage.md). <br>*Defaults to `0.05`.*  <br> **Datatype:** Float
-| | **Unfilled timeout**
-| `unfilledtimeout.entry` | **Required.** How long (in minutes or seconds) the bot will wait for an unfilled entry order to complete, after which the order will be cancelled and repeated at current (new) price, as long as there is a signal. [Strategy Override](#parameters-in-the-strategy).<br> **Datatype:** Integer
-| `unfilledtimeout.exit` | **Required.** How long (in minutes or seconds) the bot will wait for an unfilled exit order to complete, after which the order will be cancelled and repeated at current (new) price, as long as there is a signal. [Strategy Override](#parameters-in-the-strategy).<br> **Datatype:** Integer
-| `unfilledtimeout.unit` | Unit to use in unfilledtimeout setting. Note: If you set unfilledtimeout.unit to "seconds", "internals.process_throttle_secs" must be inferior or equal to timeout [Strategy Override](#parameters-in-the-strategy). <br> *Defaults to `"minutes"`.* <br> **Datatype:** String
-| `unfilledtimeout.exit_timeout_count` | How many times can exit orders time out. Once this number of timeouts is reached, an emergency exit is triggered. 0 to disable and allow unlimited order cancels. [Strategy Override](#parameters-in-the-strategy).<br>*Defaults to `0`.* <br> **Datatype:** Integer
-| | **Pricing**
-| `entry_pricing.price_side` | Select the side of the spread the bot should look at to get the entry rate. [More information below](#entry-price).<br> *Defaults to `"same"`.* <br> **Datatype:** String (either `ask`, `bid`, `same` or `other`).
-| `entry_pricing.price_last_balance` | **Required.** Interpolate the bidding price. More information [below](#entry-price-without-orderbook-enabled).
-| `entry_pricing.use_order_book` | Enable entering using the rates in [Order Book Entry](#entry-price-with-orderbook-enabled). <br> *Defaults to `true`.*<br> **Datatype:** Boolean
-| `entry_pricing.order_book_top` | Bot will use the top N rate in Order Book "price_side" to enter a trade. I.e. a value of 2 will allow the bot to pick the 2nd entry in [Order Book Entry](#entry-price-with-orderbook-enabled). <br>*Defaults to `1`.*  <br> **Datatype:** Positive Integer
-| `entry_pricing. check_depth_of_market.enabled` | Do not enter if the difference of buy orders and sell orders is met in Order Book. [Check market depth](#check-depth-of-market). <br>*Defaults to `false`.* <br> **Datatype:** Boolean
-| `entry_pricing. check_depth_of_market.bids_to_ask_delta` | The difference ratio of buy orders and sell orders found in Order Book. A value below 1 means sell order size is greater, while value greater than 1 means buy order size is higher. [Check market depth](#check-depth-of-market) <br> *Defaults to `0`.*  <br> **Datatype:** Float (as ratio)
-| `exit_pricing.price_side` | Select the side of the spread the bot should look at to get the exit rate. [More information below](#exit-price-side).<br> *Defaults to `"same"`.* <br> **Datatype:** String (either `ask`, `bid`, `same` or `other`).
-| `exit_pricing.price_last_balance` | Interpolate the exiting price. More information [below](#exit-price-without-orderbook-enabled).
-| `exit_pricing.use_order_book` | Enable exiting of open trades using [Order Book Exit](#exit-price-with-orderbook-enabled). <br> *Defaults to `true`.*<br> **Datatype:** Boolean
-| `exit_pricing.order_book_top` | Bot will use the top N rate in Order Book "price_side" to exit. I.e. a value of 2 will allow the bot to pick the 2nd ask rate in [Order Book Exit](#exit-price-with-orderbook-enabled)<br>*Defaults to `1`.* <br> **Datatype:** Positive Integer
-| `custom_price_max_distance_ratio` | Configure maximum distance ratio between current and custom entry or exit price. <br>*Defaults to `0.02` 2%).*<br> **Datatype:** Positive float
-| | **TODO**
-| `use_exit_signal` | Use exit signals produced by the strategy in addition to the `minimal_roi`. <br>Setting this to false disables the usage of `"exit_long"` and `"exit_short"` columns. Has no influence on other exit methods (Stoploss, ROI, callbacks). [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `true`.* <br> **Datatype:** Boolean
-| `exit_profit_only` | Wait until the bot reaches `exit_profit_offset` before taking an exit decision. [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `false`.* <br> **Datatype:** Boolean
-| `exit_profit_offset` | Exit-signal is only active above this value. Only active in combination with `exit_profit_only=True`. [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `0.0`.* <br> **Datatype:** Float (as ratio)
-| `ignore_roi_if_entry_signal` | Do not exit if the entry signal is still active. This setting takes preference over `minimal_roi` and `use_exit_signal`. [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `false`.* <br> **Datatype:** Boolean
-| `ignore_buying_expired_candle_after` | Specifies the number of seconds until a buy signal is no longer used. <br> **Datatype:** Integer
-| `order_types` | Configure order-types depending on the action (`"entry"`, `"exit"`, `"stoploss"`, `"stoploss_on_exchange"`). [More information below](#understand-order_types). [Strategy Override](#parameters-in-the-strategy).<br> **Datatype:** Dict
-| `order_time_in_force` | Configure time in force for entry and exit orders. [More information below](#understand-order_time_in_force). [Strategy Override](#parameters-in-the-strategy). <br> **Datatype:** Dict
-| `position_adjustment_enable` | Enables the strategy to use position adjustments (additional buys or sells). [More information here](strategy-callbacks.md#adjust-trade-position). <br> [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `false`.*<br> **Datatype:** Boolean
-| `max_entry_position_adjustment` | Maximum additional order(s) for each open trade on top of the first entry Order. Set it to `-1` for unlimited additional orders. [More information here](strategy-callbacks.md#adjust-trade-position). <br> [Strategy Override](#parameters-in-the-strategy). <br>*Defaults to `-1`.*<br> **Datatype:** Positive Integer or -1
-| | **Exchange**
-| `exchange.name` | **Required.** Name of the exchange class to use. <br> **Datatype:** String
-| `exchange.key` | API key to use for the exchange. Only required when you are in production mode.<br>**Keep it in secret, do not disclose publicly.** <br> **Datatype:** String
-| `exchange.secret` | API secret to use for the exchange. Only required when you are in production mode.<br>**Keep it in secret, do not disclose publicly.** <br> **Datatype:** String
-| `exchange.password` | API password to use for the exchange. Only required when you are in production mode and for exchanges that use password for API requests.<br>**Keep it in secret, do not disclose publicly.** <br> **Datatype:** String
-| `exchange.uid` | API uid to use for the exchange. Only required when you are in production mode and for exchanges that use uid for API requests.<br>**Keep it in secret, do not disclose publicly.** <br> **Datatype:** String
-| `exchange.pair_whitelist` | List of pairs to use by the bot for trading and to check for potential trades during backtesting. Supports regex pairs as `.*/BTC`. Not used by VolumePairList. [More information](plugins.md#pairlists-and-pairlist-handlers). <br> **Datatype:** List
-| `exchange.pair_blacklist` | List of pairs the bot must absolutely avoid for trading and backtesting. [More information](plugins.md#pairlists-and-pairlist-handlers). <br> **Datatype:** List
-| `exchange.ccxt_config` | Additional CCXT parameters passed to both ccxt instances (sync and async). This is usually the correct place for additional ccxt configurations. Parameters may differ from exchange to exchange and are documented in the [ccxt documentation](https://docs.ccxt.com/#/README?id=overriding-exchange-properties-upon-instantiation). Please avoid adding exchange secrets here (use the dedicated fields instead), as they may be contained in logs. <br> **Datatype:** Dict
-| `exchange.ccxt_sync_config` | Additional CCXT parameters passed to the regular (sync) ccxt instance. Parameters may differ from exchange to exchange and are documented in the [ccxt documentation](https://docs.ccxt.com/#/README?id=overriding-exchange-properties-upon-instantiation) <br> **Datatype:** Dict
-| `exchange.ccxt_async_config` | Additional CCXT parameters passed to the async ccxt instance. Parameters may differ from exchange to exchange  and are documented in the [ccxt documentation](https://docs.ccxt.com/#/README?id=overriding-exchange-properties-upon-instantiation) <br> **Datatype:** Dict
-| `exchange.enable_ws` | Enable the usage of Websockets for the exchange. <br>[More information](#consuming-exchange-websockets).<br>*Defaults to `true`.* <br> **Datatype:** Boolean
-| `exchange.markets_refresh_interval` | The interval in minutes in which markets are reloaded. <br>*Defaults to `60` minutes.* <br> **Datatype:** Positive Integer
-| `exchange.skip_open_order_update` | Skips open order updates on startup should the exchange cause problems. Only relevant in live conditions.<br>*Defaults to `false`*<br> **Datatype:** Boolean
-| `exchange.unknown_fee_rate` | Fallback value to use when calculating trading fees. This can be useful for exchanges which have fees in non-tradable currencies. The value provided here will be multiplied with the "fee cost".<br>*Defaults to `None`<br> **Datatype:** float
-| `exchange.log_responses` | Log relevant exchange responses. For debug mode only - use with care.<br>*Defaults to `false`*<br> **Datatype:** Boolean
-| `experimental.block_bad_exchanges` | Block exchanges known to not work with freqtrade. Leave on default unless you want to test if that exchange works now. <br>*Defaults to `true`.* <br> **Datatype:** Boolean
-| | **Plugins**
-| `edge.*` | Please refer to [edge configuration document](edge.md) for detailed explanation of all possible configuration options.
-| `pairlists` | Define one or more pairlists to be used. [More information](plugins.md#pairlists-and-pairlist-handlers). <br>*Defaults to `StaticPairList`.*  <br> **Datatype:** List of Dicts
-| `protections` | Define one or more protections to be used. [More information](plugins.md#protections). <br> **Datatype:** List of Dicts
-| | **Telegram**
-| `telegram.enabled` | Enable the usage of Telegram. <br> **Datatype:** Boolean
-| `telegram.token` | Your Telegram bot token. Only required if `telegram.enabled` is `true`. <br>**Keep it in secret, do not disclose publicly.** <br> **Datatype:** String
-| `telegram.chat_id` | Your personal Telegram account id. Only required if `telegram.enabled` is `true`. <br>**Keep it in secret, do not disclose publicly.** <br> **Datatype:** String
-| `telegram.balance_dust_level` | Dust-level (in stake currency) - currencies with a balance below this will not be shown by `/balance`. <br> **Datatype:** float
-| `telegram.reload` | Allow "reload" buttons on telegram messages. <br>*Defaults to `true`.<br> **Datatype:** boolean
-| `telegram.notification_settings.*` | Detailed notification settings. Refer to the [telegram documentation](telegram-usage.md) for details.<br> **Datatype:** dictionary
-| `telegram.allow_custom_messages` | Enable the sending of Telegram messages from strategies via the dataprovider.send_msg() function. <br> **Datatype:** Boolean
-| | **Webhook**
-| `webhook.enabled` | Enable usage of Webhook notifications <br> **Datatype:** Boolean
-| `webhook.url` | URL for the webhook. Only required if `webhook.enabled` is `true`. See the [webhook documentation](webhook-config.md) for more details. <br> **Datatype:** String
-| `webhook.entry` | Payload to send on entry. Only required if `webhook.enabled` is `true`. See the [webhook documentation](webhook-config.md) for more details. <br> **Datatype:** String
-| `webhook.entry_cancel` | Payload to send on entry order cancel. Only required if `webhook.enabled` is `true`. See the [webhook documentation](webhook-config.md) for more details. <br> **Datatype:** String
-| `webhook.entry_fill` | Payload to send on entry order filled. Only required if `webhook.enabled` is `true`. See the [webhook documentation](webhook-config.md) for more details. <br> **Datatype:** String
-| `webhook.exit` | Payload to send on exit. Only required if `webhook.enabled` is `true`. See the [webhook documentation](webhook-config.md) for more details. <br> **Datatype:** String
-| `webhook.exit_cancel` | Payload to send on exit order cancel. Only required if `webhook.enabled` is `true`. See the [webhook documentation](webhook-config.md) for more details. <br> **Datatype:** String
-| `webhook.exit_fill` | Payload to send on exit order filled. Only required if `webhook.enabled` is `true`. See the [webhook documentation](webhook-config.md) for more details. <br> **Datatype:** String
-| `webhook.status` | Payload to send on status calls. Only required if `webhook.enabled` is `true`. See the [webhook documentation](webhook-config.md) for more details. <br> **Datatype:** String
-| `webhook.allow_custom_messages` | Enable the sending of Webhook messages from strategies via the dataprovider.send_msg() function. <br> **Datatype:** Boolean
-| | **Rest API / FreqUI / Producer-Consumer**
-| `api_server.enabled` | Enable usage of API Server. See the [API Server documentation](rest-api.md) for more details. <br> **Datatype:** Boolean
-| `api_server.listen_ip_address` | Bind IP address. See the [API Server documentation](rest-api.md) for more details. <br> **Datatype:** IPv4
-| `api_server.listen_port` | Bind Port. See the [API Server documentation](rest-api.md) for more details. <br>**Datatype:** Integer between 1024 and 65535
-| `api_server.verbosity` | Logging verbosity. `info` will print all RPC Calls, while "error" will only display errors. <br>**Datatype:** Enum, either `info` or `error`. Defaults to `info`.
-| `api_server.username` | Username for API server. See the [API Server documentation](rest-api.md) for more details. <br>**Keep it in secret, do not disclose publicly.**<br> **Datatype:** String
-| `api_server.password` | Password for API server. See the [API Server documentation](rest-api.md) for more details. <br>**Keep it in secret, do not disclose publicly.**<br> **Datatype:** String
-| `api_server.ws_token` | API token for the Message WebSocket. See the [API Server documentation](rest-api.md) for more details.  <br>**Keep it in secret, do not disclose publicly.** <br> **Datatype:** String
-| `bot_name` | Name of the bot. Passed via API to a client - can be shown to distinguish / name bots.<br> *Defaults to `freqtrade`*<br> **Datatype:** String
-| `external_message_consumer` | Enable [Producer/Consumer mode](producer-consumer.md) for more details. <br> **Datatype:** Dict
-| | **Other**
-| `initial_state` | Defines the initial application state. If set to stopped, then the bot has to be explicitly started via `/start` RPC command. <br>*Defaults to `stopped`.* <br> **Datatype:** Enum, either `stopped` or `running`
-| `force_entry_enable` | Enables the RPC Commands to force a Trade entry. More information below. <br> **Datatype:** Boolean
-| `disable_dataframe_checks` | Disable checking the OHLCV dataframe returned from the strategy methods for correctness. Only use when intentionally changing the dataframe and understand what you are doing. [Strategy Override](#parameters-in-the-strategy).<br> *Defaults to `False`*. <br> **Datatype:** Boolean
-| `internals.process_throttle_secs` | Set the process throttle, or minimum loop duration for one bot iteration loop. Value in second. <br>*Defaults to `5` seconds.* <br> **Datatype:** Positive Integer
-| `internals.heartbeat_interval` | Print heartbeat message every N seconds. Set to 0 to disable heartbeat messages. <br>*Defaults to `60` seconds.* <br> **Datatype:** Positive Integer or 0
-| `internals.sd_notify` | Enables use of the sd_notify protocol to tell systemd service manager about changes in the bot state and issue keep-alive pings. See [here](advanced-setup.md#configure-the-bot-running-as-a-systemd-service) for more details. <br> **Datatype:** Boolean
-| `strategy` | **Required** Defines Strategy class to use. Recommended to be set via `--strategy NAME`. <br> **Datatype:** ClassName
-| `strategy_path` | Adds an additional strategy lookup path (must be a directory). <br> **Datatype:** String
-| `recursive_strategy_search` | Set to `true` to recursively search sub-directories inside `user_data/strategies` for a strategy. <br> **Datatype:** Boolean
-| `user_data_dir` | Directory containing user data. <br> *Defaults to `./user_data/`*. <br> **Datatype:** String
-| `db_url` | Declares database URL to use. NOTE: This defaults to `sqlite:///tradesv3.dryrun.sqlite` if `dry_run` is `true`, and to `sqlite:///tradesv3.sqlite` for production instances. <br> **Datatype:** String, SQLAlchemy connect string
-| `logfile` | Specifies logfile name. Uses a rolling strategy for log file rotation for 10 files with the 1MB limit per file. <br> **Datatype:** String
-| `add_config_files` | Additional config files. These files will be loaded and merged with the current config file. The files are resolved relative to the initial file.<br> *Defaults to `[]`*. <br> **Datatype:** List of strings
-| `dataformat_ohlcv` | Data format to use to store historical candle (OHLCV) data. <br> *Defaults to `feather`*. <br> **Datatype:** String
-| `dataformat_trades` | Data format to use to store historical trades data. <br> *Defaults to `feather`*. <br> **Datatype:** String
-| `reduce_df_footprint` | Recast all numeric columns to float32/int32, with the objective of reducing ram/disk usage (and decreasing train/inference timing in FreqAI). (Currently only affects FreqAI use-cases) <br> **Datatype:** Boolean. <br> Default: `False`.
-
-### Parameters in the strategy
-
-The following parameters can be set in the configuration file or strategy.
-Values set in the configuration file always overwrite values set in the strategy.
-
-* `minimal_roi`
-* `timeframe`
-* `stoploss`
-* `max_open_trades`
-* `trailing_stop`
-* `trailing_stop_positive`
-* `trailing_stop_positive_offset`
-* `trailing_only_offset_is_reached`
-* `use_custom_stoploss`
-* `process_only_new_candles`
-* `order_types`
-* `order_time_in_force`
-* `unfilledtimeout`
-* `disable_dataframe_checks`
-- `use_exit_signal`
-* `exit_profit_only`
-- `exit_profit_offset`
-- `ignore_roi_if_entry_signal`
-* `ignore_buying_expired_candle_after`
-* `position_adjustment_enable`
-* `max_entry_position_adjustment`
-
-### Configuring amount per trade
-
-There are several methods to configure how much of the stake currency the bot will use to enter a trade. All methods respect the [available balance configuration](#tradable-balance) as explained below.
-
-#### Minimum trade stake
-
-The minimum stake amount will depend on exchange and pair and is usually listed in the exchange support pages.
-
-Assuming the minimum tradable amount for XRP/USD is 20 XRP (given by the exchange), and the price is 0.6$, the minimum stake amount to buy this pair is `20 * 0.6 ~= 12`.
-This exchange has also a limit on USD - where all orders must be > 10$ - which however does not apply in this case.
-
-To guarantee safe execution, freqtrade will not allow buying with a stake-amount of 10.1$, instead, it'll make sure that there's enough space to place a stoploss below the pair (+ an offset, defined by `amount_reserve_percent`, which defaults to 5%).
-
-With a reserve of 5%, the minimum stake amount would be ~12.6$ (`12 * (1 + 0.05)`). If we take into account a stoploss of 10% on top of that - we'd end up with a value of ~14$ (`12.6 / (1 - 0.1)`).
-
-To limit this calculation in case of large stoploss values, the calculated minimum stake-limit will never be more than 50% above the real limit.
-
-!!! Warning
-    Since the limits on exchanges are usually stable and are not updated often, some pairs can show pretty high minimum limits, simply because the price increased a lot since the last limit adjustment by the exchange. Freqtrade adjusts the stake-amount to this value, unless it's > 30% more than the calculated/desired stake-amount - in which case the trade is rejected.
-
-#### Tradable balance
-
-By default, the bot assumes that the `complete amount - 1%` is at it's disposal, and when using [dynamic stake amount](#dynamic-stake-amount), it will split the complete balance into `max_open_trades` buckets per trade.
-Freqtrade will reserve 1% for eventual fees when entering a trade and will therefore not touch that by default.
-
-You can configure the "untouched" amount by using the `tradable_balance_ratio` setting.
-
-For example, if you have 10 ETH available in your wallet on the exchange and `tradable_balance_ratio=0.5` (which is 50%), then the bot will use a maximum amount of 5 ETH for trading and considers this as an available balance. The rest of the wallet is untouched by the trades.
-
-!!! Danger
-    This setting should **not** be used when running multiple bots on the same account. Please look at [Available Capital to the bot](#assign-available-capital) instead.
-
-!!! Warning
-    The `tradable_balance_ratio` setting applies to the current balance (free balance + tied up in trades). Therefore, assuming the starting balance of 1000, a configuration with `tradable_balance_ratio=0.99` will not guarantee that 10 currency units will always remain available on the exchange. For example, the free amount may reduce to 5 units if the total balance is reduced to 500 (either by a losing streak or by withdrawing balance).
-
-#### Assign available Capital
-
-To fully utilize compounding profits when using multiple bots on the same exchange account, you'll want to limit each bot to a certain starting balance.
-This can be accomplished by setting `available_capital` to the desired starting balance.
-
-Assuming your account has 10000 USDT and you want to run 2 different strategies on this exchange.
-You'd set `available_capital=5000` - granting each bot an initial capital of 5000 USDT.
-The bot will then split this starting balance equally into `max_open_trades` buckets.
-Profitable trades will result in increased stake-sizes for this bot - without affecting the stake-sizes of the other bot.
-
-Adjusting `available_capital` requires reloading the configuration to take effect. Adjusting the `available_capital` adds the difference between the previous `available_capital` and the new `available_capital`. Decreasing the available capital when trades are open doesn't exit the trades. The difference is returned to the wallet when the trades conclude. The outcome of this differs depending on the price movement between the adjustment and exiting the trades.
-
-!!! Warning "Incompatible with `tradable_balance_ratio`"
-    Setting this option will replace any configuration of `tradable_balance_ratio`.
-
-#### Amend last stake amount
-
-Assuming we have the tradable balance of 1000 USDT, `stake_amount=400`, and `max_open_trades=3`.
-The bot would open 2 trades and will be unable to fill the last trading slot, since the requested 400 USDT are no longer available since 800 USDT are already tied in other trades.
-
-To overcome this, the option `amend_last_stake_amount` can be set to `True`, which will enable the bot to reduce stake_amount to the available balance to fill the last trade slot.
-
-In the example above this would mean:
-
-- Trade1: 400 USDT
-- Trade2: 400 USDT
-- Trade3: 200 USDT
-
-!!! Note
-    This option only applies with [Static stake amount](#static-stake-amount) - since [Dynamic stake amount](#dynamic-stake-amount) divides the balances evenly.
-
-!!! Note
-    The minimum last stake amount can be configured using `last_stake_amount_min_ratio` - which defaults to 0.5 (50%). This means that the minimum stake amount that's ever used is `stake_amount * 0.5`. This avoids very low stake amounts, that are close to the minimum tradable amount for the pair and can be refused by the exchange.
-
-#### Static stake amount
-
-The `stake_amount` configuration statically configures the amount of stake-currency your bot will use for each trade.
-
-The minimal configuration value is 0.0001, however, please check your exchange's trading minimums for the stake currency you're using to avoid problems.
-
-This setting works in combination with `max_open_trades`. The maximum capital engaged in trades is `stake_amount * max_open_trades`.
-For example, the bot will at most use (0.05 BTC x 3) = 0.15 BTC, assuming a configuration of `max_open_trades=3` and `stake_amount=0.05`.
-
-!!! Note
-    This setting respects the [available balance configuration](#tradable-balance).
-
-#### Dynamic stake amount
-
-Alternatively, you can use a dynamic stake amount, which will use the available balance on the exchange, and divide that equally by the number of allowed trades (`max_open_trades`).
-
-To configure this, set `stake_amount="unlimited"`. We also recommend to set `tradable_balance_ratio=0.99` (99%) - to keep a minimum balance for eventual fees.
-
-In this case a trade amount is calculated as:
-
-```python
-currency_balance / (max_open_trades - current_open_trades)
-```
-
-To allow the bot to trade all the available `stake_currency` in your account (minus `tradable_balance_ratio`) set
-
-```json
-"stake_amount" : "unlimited",
-"tradable_balance_ratio": 0.99,
-```
-
-!!! Tip "Compounding profits"
-    This configuration will allow increasing/decreasing stakes depending on the performance of the bot (lower stake if the bot is losing, higher stakes if the bot has a winning record since higher balances are available), and will result in profit compounding.
-
-!!! Note "When using Dry-Run Mode"
-    When using `"stake_amount" : "unlimited",` in combination with Dry-Run, Backtesting or Hyperopt, the balance will be simulated starting with a stake of `dry_run_wallet` which will evolve.
-    It is therefore important to set `dry_run_wallet` to a sensible value (like 0.05 or 0.01 for BTC and 1000 or 100 for USDT, for example), otherwise, it may simulate trades with 100 BTC (or more) or 0.05 USDT (or less) at once - which may not correspond to your real available balance or is less than the exchange minimal limit for the order amount for the stake currency.
-
-#### Dynamic stake amount with position adjustment
-
-When you want to use position adjustment with unlimited stakes, you must also implement `custom_stake_amount` to a return a value depending on your strategy.
-Typical value would be in the range of 25% - 50% of the proposed stakes, but depends highly on your strategy and how much you wish to leave into the wallet as position adjustment buffer.
-
-For example if your position adjustment assumes it can do 2 additional buys with the same stake amounts then your buffer should be 66.6667% of the initially proposed unlimited stake amount.
-
-Or another example if your position adjustment assumes it can do 1 additional buy with 3x the original stake amount then `custom_stake_amount` should return 25% of proposed stake amount and leave 75% for possible later position adjustments.
-
---8<-- "includes/pricing.md"
-
-## Further Configuration details
-
-### Understand minimal_roi
-
-The `minimal_roi` configuration parameter is a JSON object where the key is a duration
-in minutes and the value is the minimum ROI as a ratio.
-See the example below:
-
-```json
-"minimal_roi": {
-    "40": 0.0,    # Exit after 40 minutes if the profit is not negative
-    "30": 0.01,   # Exit after 30 minutes if there is at least 1% profit
-    "20": 0.02,   # Exit after 20 minutes if there is at least 2% profit
-    "0":  0.04    # Exit immediately if there is at least 4% profit
-},
-```
-
-Most of the strategy files already include the optimal `minimal_roi` value.
-This parameter can be set in either Strategy or Configuration file. If you use it in the configuration file, it will override the
-`minimal_roi` value from the strategy file.
-If it is not set in either Strategy or Configuration, a default of 1000% `{"0": 10}` is used, and minimal ROI is disabled unless your trade generates 1000% profit.
-
-!!! Note "Special case to forceexit after a specific time"
-    A special case presents using `"<N>": -1` as ROI. This forces the bot to exit a trade after N Minutes, no matter if it's positive or negative, so represents a time-limited force-exit.
-
-### Understand force_entry_enable
-
-The `force_entry_enable` configuration parameter enables the usage of force-enter (`/forcelong`, `/forceshort`) commands via Telegram and REST API.
-For security reasons, it's disabled by default, and freqtrade will show a warning message on startup if enabled.
-For example, you can send `/forceenter ETH/BTC` to the bot, which will result in freqtrade buying the pair and holds it until a regular exit-signal (ROI, stoploss, /forceexit) appears.
-
-This can be dangerous with some strategies, so use with care.
-
-See [the telegram documentation](telegram-usage.md) for details on usage.
-
-### Ignoring expired candles
-
-When working with larger timeframes (for example 1h or more) and using a low `max_open_trades` value, the last candle can be processed as soon as a trade slot becomes available. When processing the last candle, this can lead to a situation where it may not be desirable to use the buy signal on that candle. For example, when using a condition in your strategy where you use a cross-over, that point may have passed too long ago for you to start a trade on it.
-
-In these situations, you can enable the functionality to ignore candles that are beyond a specified period by setting `ignore_buying_expired_candle_after` to a positive number, indicating the number of seconds after which the buy signal becomes expired.
-
-For example, if your strategy is using a 1h timeframe, and you only want to buy within the first 5 minutes when a new candle comes in, you can add the following configuration to your strategy:
-
-``` json
-  {
-    //...
-    "ignore_buying_expired_candle_after": 300,
-    // ...
-  }
-```
-
-!!! Note
-    This setting resets with each new candle, so it will not prevent sticking-signals from executing on the 2nd or 3rd candle they're active. Best use a "trigger" selector for buy signals, which are only active for one candle.
-
-### Understand order_types
-
-The `order_types` configuration parameter maps actions (`entry`, `exit`, `stoploss`, `emergency_exit`, `force_exit`, `force_entry`) to order-types (`market`, `limit`, ...) as well as configures stoploss to be on the exchange and defines stoploss on exchange update interval in seconds.
-
-This allows to enter using limit orders, exit using limit-orders, and create stoplosses using market orders.
-It also allows to set the
-stoploss "on exchange" which means stoploss order would be placed immediately once the buy order is fulfilled.
-
-`order_types` set in the configuration file overwrites values set in the strategy as a whole, so you need to configure the whole `order_types` dictionary in one place.
-
-If this is configured, the following 4 values (`entry`, `exit`, `stoploss` and `stoploss_on_exchange`) need to be present, otherwise, the bot will fail to start.
-
-For information on (`emergency_exit`,`force_exit`, `force_entry`, `stoploss_on_exchange`,`stoploss_on_exchange_interval`,`stoploss_on_exchange_limit_ratio`) please see stop loss documentation [stop loss on exchange](stoploss.md)
-
-Syntax for Strategy:
-
-```python
-order_types = {
-    "entry": "limit",
-    "exit": "limit",
-    "emergency_exit": "market",
-    "force_entry": "market",
-    "force_exit": "market",
-    "stoploss": "market",
-    "stoploss_on_exchange": False,
-    "stoploss_on_exchange_interval": 60,
-    "stoploss_on_exchange_limit_ratio": 0.99,
-}
-```
-
-Configuration:
-
-```json
-"order_types": {
-    "entry": "limit",
-    "exit": "limit",
-    "emergency_exit": "market",
-    "force_entry": "market",
-    "force_exit": "market",
-    "stoploss": "market",
-    "stoploss_on_exchange": false,
-    "stoploss_on_exchange_interval": 60
-}
-```
-
-!!! Note "Market order support"
-    Not all exchanges support "market" orders.
-    The following message will be shown if your exchange does not support market orders:
-    `"Exchange <yourexchange> does not support market orders."` and the bot will refuse to start.
-
-!!! Warning "Using market orders"
-    Please carefully read the section [Market order pricing](#market-order-pricing) section when using market orders.
-
-!!! Note "Stoploss on exchange"
-    `order_types.stoploss_on_exchange_interval` is not mandatory. Do not change its value if you are
-    unsure of what you are doing. For more information about how stoploss works please
-    refer to [the stoploss documentation](stoploss.md).
-
-    If `order_types.stoploss_on_exchange` is enabled and the stoploss is cancelled manually on the exchange, then the bot will create a new stoploss order.
-
-!!! Warning "Warning: order_types.stoploss_on_exchange failures"
-    If stoploss on exchange creation fails for some reason, then an "emergency exit" is initiated. By default, this will exit the trade using a market order. The order-type for the emergency-exit can be changed by setting the `emergency_exit` value in the `order_types` dictionary - however, this is not advised.
-
-### Understand order_time_in_force
-
-The `order_time_in_force` configuration parameter defines the policy by which the order
-is executed on the exchange. Three commonly used time in force are:
-
-**GTC (Good Till Canceled):**
-
-This is most of the time the default time in force. It means the order will remain
-on exchange till it is cancelled by the user. It can be fully or partially fulfilled.
-If partially fulfilled, the remaining will stay on the exchange till cancelled.
-
-**FOK (Fill Or Kill):**
-
-It means if the order is not executed immediately AND fully then it is cancelled by the exchange.
-
-**IOC (Immediate Or Canceled):**
-
-It is the same as FOK (above) except it can be partially fulfilled. The remaining part
-is automatically cancelled by the exchange.
-
-**PO (Post only):**
-
-Post only order. The order is either placed as a maker order, or it is canceled.
-This means the order must be placed on orderbook for at least time in an unfilled state.
-
-#### time_in_force config
-
-The `order_time_in_force` parameter contains a dict with entry and exit time in force policy values.
-This can be set in the configuration file or in the strategy.
-Values set in the configuration file overwrites values set in the strategy.
-
-The possible values are: `GTC` (default), `FOK` or `IOC`.
-
-``` python
-"order_time_in_force": {
-    "entry": "GTC",
-    "exit": "GTC"
-},
-```
-
-!!! Warning
-    This is ongoing work. For now, it is supported only for binance, gate and kucoin.
-    Please don't change the default value unless you know what you are doing and have researched the impact of using different values for your particular exchange.
-
-### Fiat conversion
-
-Freqtrade uses the Coingecko API to convert the coin value to it's corresponding fiat value for the Telegram reports.
-The FIAT currency can be set in the configuration file as `fiat_display_currency`.
-
-Removing `fiat_display_currency` completely from the configuration will skip initializing coingecko, and will not show any FIAT currency conversion. This has no importance for the correct functioning of the bot.
-
-#### What values can be used for fiat_display_currency?
-
-The `fiat_display_currency` configuration parameter sets the base currency to use for the
-conversion from coin to fiat in the bot Telegram reports.
-
-The valid values are:
-
-```json
-"AUD", "BRL", "CAD", "CHF", "CLP", "CNY", "CZK", "DKK", "EUR", "GBP", "HKD", "HUF", "IDR", "ILS", "INR", "JPY", "KRW", "MXN", "MYR", "NOK", "NZD", "PHP", "PKR", "PLN", "RUB", "SEK", "SGD", "THB", "TRY", "TWD", "ZAR", "USD"
-```
-
-In addition to fiat currencies, a range of crypto currencies is supported.
-
-The valid values are:
-
-```json
-"BTC", "ETH", "XRP", "LTC", "BCH", "BNB"
-```
-
-#### Coingecko Rate limit problems
-
-On some IP ranges, coingecko is heavily rate-limiting.
-In such cases, you may want to add your coingecko API key to the configuration.
-
-``` json
-{
-    "fiat_display_currency": "USD",
-    "coingecko": {
-        "api_key": "your-api",
-        "is_demo": true
-    }
-}
-```
-
-Freqtrade supports both Demo and Pro coingecko API keys.
-
-The Coingecko API key is NOT required for the bot to function correctly.
-It is only used for the conversion of coin to fiat in the Telegram reports, which usually also work without API key.
-
-## Consuming exchange Websockets
-
-Freqtrade can consume websockets through ccxt.pro.
-
-Freqtrade aims ensure data is available at all times.
-Should the websocket connection fail (or be disabled), the bot will fall back to REST API calls.
-
-Should you experience problems you suspect are caused by websockets, you can disable these via the setting `exchange.enable_ws`, which defaults to true.
-
-```jsonc
-"exchange": {
-    // ...
-    "enable_ws": false,
-    // ...
-}
-```
-
-Should you be required to use a proxy, please refer to the [proxy section](#using-proxy-with-freqtrade) for more information.
-
-!!! Info "Rollout"
-    We're implementing this out slowly, ensuring stability of your bots.
-    Currently, usage is limited to ohlcv data streams.
-    It's also limited to a few exchanges, with new exchanges being added on an ongoing basis.
-
-## Using Dry-run mode
-
-We recommend starting the bot in the Dry-run mode to see how your bot will
-behave and what is the performance of your strategy. In the Dry-run mode, the
-bot does not engage your money. It only runs a live simulation without
-creating trades on the exchange.
-
-1. Edit your `config.json` configuration file.
-2. Switch `dry-run` to `true` and specify `db_url` for a persistence database.
-
-```json
-"dry_run": true,
-"db_url": "sqlite:///tradesv3.dryrun.sqlite",
-```
-
-3. Remove your Exchange API key and secret (change them by empty values or fake credentials):
-
-```json
-"exchange": {
-    "name": "binance",
-    "key": "key",
-    "secret": "secret",
-    ...
-}
-```
-
-Once you will be happy with your bot performance running in the Dry-run mode, you can switch it to production mode.
-
-!!! Note
-    A simulated wallet is available during dry-run mode and will assume a starting capital of `dry_run_wallet` (defaults to 1000).
-
-### Considerations for dry-run
-
-* API-keys may or may not be provided. Only Read-Only operations (i.e. operations that do not alter account state) on the exchange are performed in dry-run mode.
-* Wallets (`/balance`) are simulated based on `dry_run_wallet`.
-* Orders are simulated, and will not be posted to the exchange.
-* Market orders fill based on orderbook volume the moment the order is placed, with a maximum slippage of 5%.
-* Limit orders fill once the price reaches the defined level - or time out based on `unfilledtimeout` settings.
-* Limit orders will be converted to market orders if they cross the price by more than 1%, and will be filled immediately based regular market order rules (see point about Market orders above).
-* In combination with `stoploss_on_exchange`, the stop_loss price is assumed to be filled.
-* Open orders (not trades, which are stored in the database) are kept open after bot restarts, with the assumption that they were not filled while being offline.
-
-## Switch to production mode
-
-In production mode, the bot will engage your money. Be careful, since a wrong strategy can lose all your money.
-Be aware of what you are doing when you run it in production mode.
-
-When switching to Production mode, please make sure to use a different / fresh database to avoid dry-run trades messing with your exchange money and eventually tainting your statistics.
-
-### Setup your exchange account
-
-You will need to create API Keys (usually you get `key` and `secret`, some exchanges require an additional `password`) from the Exchange website and you'll need to insert this into the appropriate fields in the configuration or when asked by the `freqtrade new-config` command.
-API Keys are usually only required for live trading (trading for real money, bot running in "production mode", executing real orders on the exchange) and are not required for the bot running in dry-run (trade simulation) mode. When you set up the bot in dry-run mode, you may fill these fields with empty values.
-
-### To switch your bot in production mode
-
-**Edit your `config.json`  file.**
-
-**Switch dry-run to false and don't forget to adapt your database URL if set:**
-
-```json
-"dry_run": false,
-```
-
-**Insert your Exchange API key (change them by fake API keys):**
-
-```json
-{
-    "exchange": {
-        "name": "binance",
-        "key": "af8ddd35195e9dc500b9a6f799f6f5c93d89193b",
-        "secret": "08a9dc6db3d7b53e1acebd9275677f4b0a04f1a5",
-        //"password": "", // Optional, not needed by all exchanges)
-        // ...
-    }
-    //...
-}
-```
-
-You should also make sure to read the [Exchanges](exchanges.md) section of the documentation to be aware of potential configuration details specific to your exchange.
-
-!!! Hint "Keep your secrets secret"
-    To keep your secrets secret, we recommend using a 2nd configuration for your API keys.
-    Simply use the above snippet in a new configuration file (e.g. `config-private.json`) and keep your settings in this file.
-    You can then start the bot with `freqtrade trade --config user_data/config.json --config user_data/config-private.json <...>` to have your keys loaded.
-
-    **NEVER** share your private configuration file or your exchange keys with anyone!
-
-## Using a proxy with Freqtrade
-
-To use a proxy with freqtrade, export your proxy settings using the variables `"HTTP_PROXY"` and `"HTTPS_PROXY"` set to the appropriate values.
-This will have the proxy settings applied to everything (telegram, coingecko, ...) **except** for exchange requests.
-
-``` bash
-export HTTP_PROXY="http://addr:port"
-export HTTPS_PROXY="http://addr:port"
-freqtrade
-```
-
-### Proxy exchange requests
-
-To use a proxy for exchange connections - you will have to define the proxies as part of the ccxt configuration.
-
-``` json
-{ 
-  "exchange": {
-    "ccxt_config": {
-      "httpsProxy": "http://addr:port",
-      "wsProxy": "http://addr:port",
-    }
-  }
-}
-```
-
-For more information on available proxy types, please consult the [ccxt proxy documentation](https://docs.ccxt.com/#/README?id=proxy).
-
-## Next step
-
-Now you have configured your config.json, the next step is to [start your bot](bot-usage.md).

docs/data-analysis.md

@@ -1,127 +0,0 @@
-# Analyzing bot data with Jupyter notebooks
-
-You can analyze the results of backtests and trading history easily using Jupyter notebooks. Sample notebooks are located at `user_data/notebooks/` after initializing the user directory with `freqtrade create-userdir --userdir user_data`.
-
-## Quick start with docker
-
-Freqtrade provides a docker-compose file which starts up a jupyter lab server.
-You can run this server using the following command: `docker compose -f docker/docker-compose-jupyter.yml up`
-
-This will create a dockercontainer running jupyter lab, which will be accessible using `https://127.0.0.1:8888/lab`.
-Please use the link that's printed in the console after startup for simplified login.
-
-For more information, Please visit the [Data analysis with Docker](docker_quickstart.md#data-analysis-using-docker-compose) section.
-
-### Pro tips
-
-* See [jupyter.org](https://jupyter.org/documentation) for usage instructions.
-* Don't forget to start a Jupyter notebook server from within your conda or venv environment or use [nb_conda_kernels](https://github.com/Anaconda-Platform/nb_conda_kernels)*
-* Copy the example notebook before use so your changes don't get overwritten with the next freqtrade update.
-
-### Using virtual environment with system-wide Jupyter installation
-
-Sometimes it can be desired to use a system-wide installation of Jupyter notebook, and use a jupyter kernel from the virtual environment.
-This prevents you from installing the full jupyter suite multiple times per system, and provides an easy way to switch between tasks (freqtrade / other analytics tasks).
-
-For this to work, first activate your virtual environment and run the following commands:
-
-``` bash
-# Activate virtual environment
-source .venv/bin/activate
-
-pip install ipykernel
-ipython kernel install --user --name=freqtrade
-# Restart jupyter (lab / notebook)
-# select kernel "freqtrade" in the notebook
-```
-
-!!! Note
-    This section is provided for completeness, the Freqtrade Team won't provide full support for problems with this setup and will recommend to install Jupyter in the virtual environment directly, as that is the easiest way to get jupyter notebooks up and running. For help with this setup please refer to the [Project Jupyter](https://jupyter.org/) [documentation](https://jupyter.org/documentation) or [help channels](https://jupyter.org/community).
-
-!!! Warning
-    Some tasks don't work especially well in notebooks. For example, anything using asynchronous execution is a problem for Jupyter. Also, freqtrade's primary entry point is the shell cli, so using pure python in a notebook bypasses arguments that provide required objects and parameters to helper functions. You may need to set those values or create expected objects manually.
-
-## Recommended workflow
-
-| Task | Tool |
-  --- | ---
-Bot operations | CLI
-Repetitive tasks | Shell scripts
-Data analysis & visualization | Notebook
-
-1. Use the CLI to
-
-    * download historical data
-    * run a backtest
-    * run with real-time data
-    * export results
-
-1. Collect these actions in shell scripts
-
-    * save complicated commands with arguments
-    * execute multi-step operations
-    * automate testing strategies and preparing data for analysis
-
-1. Use a notebook to
-
-    * visualize data
-    * mangle and plot to generate insights
-
-## Example utility snippets
-
-### Change directory to root
-
-Jupyter notebooks execute from the notebook directory. The following snippet searches for the project root, so relative paths remain consistent.
-
-```python
-import os
-from pathlib import Path
-
-# Change directory
-# Modify this cell to insure that the output shows the correct path.
-# Define all paths relative to the project root shown in the cell output
-project_root = "somedir/freqtrade"
-i=0
-try:
-    os.chdir(project_root)
-    assert Path('LICENSE').is_file()
-except:
-    while i<4 and (not Path('LICENSE').is_file()):
-        os.chdir(Path(Path.cwd(), '../'))
-        i+=1
-    project_root = Path.cwd()
-print(Path.cwd())
-```
-
-### Load multiple configuration files
-
-This option can be useful to inspect the results of passing in multiple configs.
-This will also run through the whole Configuration initialization, so the configuration is completely initialized to be passed to other methods.
-
-``` python
-import json
-from freqtrade.configuration import Configuration
-
-# Load config from multiple files
-config = Configuration.from_files(["config1.json", "config2.json"])
-
-# Show the config in memory
-print(json.dumps(config['original_config'], indent=2))
-```
-
-For Interactive environments, have an additional configuration specifying `user_data_dir` and pass this in last, so you don't have to change directories while running the bot.
-Best avoid relative paths, since this starts at the storage location of the jupyter notebook, unless the directory is changed.
-
-``` json
-{
-    "user_data_dir": "~/.freqtrade/"
-}
-```
-
-### Further Data analysis documentation
-
-* [Strategy debugging](strategy_analysis_example.md) - also available as Jupyter notebook (`user_data/notebooks/strategy_analysis_example.ipynb`)
-* [Plotting](plotting.md)
-* [Tag Analysis](advanced-backtesting.md)
-
-Feel free to submit an issue or Pull Request enhancing this document if you would like to share ideas on how to best analyze the data.

docs/data-download.md

@@ -1,526 +0,0 @@
-# Data Downloading
-
-## Getting data for backtesting and hyperopt
-
-To download data (candles / OHLCV) needed for backtesting and hyperoptimization use the `freqtrade download-data` command.
-
-If no additional parameter is specified, freqtrade will download data for `"1m"` and `"5m"` timeframes for the last 30 days.
-Exchange and pairs will come from `config.json` (if specified using `-c/--config`).
-Without provided configuration, `--exchange` becomes mandatory.
-
-You can use a relative timerange (`--days 20`) or an absolute starting point (`--timerange 20200101-`). For incremental downloads, the relative approach should be used.
-
-!!! Tip "Tip: Updating existing data"
-    If you already have backtesting data available in your data-directory and would like to refresh this data up to today, freqtrade will automatically calculate the data missing for the existing pairs and the download will occur from the latest available point until "now", neither --days or --timerange parameters are required. Freqtrade will keep the available data and only download the missing data.
-    If you are updating existing data after inserting new pairs that you have no data for, use `--new-pairs-days xx` parameter. Specified number of days will be downloaded for new pairs while old pairs will be updated with missing data only.
-    If you use `--days xx` parameter alone - data for specified number of days will be downloaded for _all_ pairs. Be careful, if specified number of days is smaller than gap between now and last downloaded candle - freqtrade will delete all existing data to avoid gaps in candle data.
-
-### Usage
-
-```
-usage: freqtrade download-data [-h] [-v] [--logfile FILE] [-V] [-c PATH]
-                               [-d PATH] [--userdir PATH]
-                               [-p PAIRS [PAIRS ...]] [--pairs-file FILE]
-                               [--days INT] [--new-pairs-days INT]
-                               [--include-inactive-pairs]
-                               [--timerange TIMERANGE] [--dl-trades]
-                               [--convert] [--exchange EXCHANGE]
-                               [-t TIMEFRAMES [TIMEFRAMES ...]] [--erase]
-                               [--data-format-ohlcv {json,jsongz,hdf5,feather,parquet}]
-                               [--data-format-trades {json,jsongz,hdf5,feather,parquet}]
-                               [--trading-mode {spot,margin,futures}]
-                               [--prepend]
-
-options:
-  -h, --help            show this help message and exit
-  -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
-                        Limit command to these pairs. Pairs are space-
-                        separated.
-  --pairs-file FILE     File containing a list of pairs. Takes precedence over
-                        --pairs or pairs configured in the configuration.
-  --days INT            Download data for given number of days.
-  --new-pairs-days INT  Download data of new pairs for given number of days.
-                        Default: `None`.
-  --include-inactive-pairs
-                        Also download data from inactive pairs.
-  --timerange TIMERANGE
-                        Specify what timerange of data to use.
-  --dl-trades           Download trades instead of OHLCV data. The bot will
-                        resample trades to the desired timeframe as specified
-                        as --timeframes/-t.
-  --convert             Convert downloaded trades to OHLCV data. Only
-                        applicable in combination with `--dl-trades`. Will be
-                        automatic for exchanges which don't have historic
-                        OHLCV (e.g. Kraken). If not provided, use `trades-to-
-                        ohlcv` to convert trades data to OHLCV data.
-  --exchange EXCHANGE   Exchange name. Only valid if no config is provided.
-  -t TIMEFRAMES [TIMEFRAMES ...], --timeframes TIMEFRAMES [TIMEFRAMES ...]
-                        Specify which tickers to download. Space-separated
-                        list. Default: `1m 5m`.
-  --erase               Clean all existing data for the selected
-                        exchange/pairs/timeframes.
-  --data-format-ohlcv {json,jsongz,hdf5,feather,parquet}
-                        Storage format for downloaded candle (OHLCV) data.
-                        (default: `feather`).
-  --data-format-trades {json,jsongz,hdf5,feather,parquet}
-                        Storage format for downloaded trades data. (default:
-                        `feather`).
-  --trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures}
-                        Select Trading mode
-  --prepend             Allow data prepending. (Data-appending is disabled)
-
-Common arguments:
-  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
-  --logfile FILE, --log-file FILE
-                        Log to the file specified. Special values are:
-                        'syslog', 'journald'. See the documentation for more
-                        details.
-  -V, --version         show program's version number and exit
-  -c PATH, --config PATH
-                        Specify configuration file (default:
-                        `userdir/config.json` or `config.json` whichever
-                        exists). Multiple --config options may be used. Can be
-                        set to `-` to read config from stdin.
-  -d PATH, --datadir PATH, --data-dir PATH
-                        Path to directory with historical backtesting data.
-  --userdir PATH, --user-data-dir PATH
-                        Path to userdata directory.
-
-```
-
-!!! Tip "Downloading all data for one quote currency"
-    Often, you'll want to download data for all pairs of a specific quote-currency. In such cases, you can use the following shorthand:
-    `freqtrade download-data --exchange binance --pairs .*/USDT <...>`. The provided "pairs" string will be expanded to contain all active pairs on the exchange.
-    To also download data for inactive (delisted) pairs, add `--include-inactive-pairs` to the command.
-
-!!! Note "Startup period"
-    `download-data` is a strategy-independent command. The idea is to download a big chunk of data once, and then iteratively increase the amount of data stored.
-
-    For that reason, `download-data` does not care about the "startup-period" defined in a strategy. It's up to the user to download additional days if the backtest should start at a specific point in time (while respecting startup period).
-
-### Start download
-
-A very simple command (assuming an available `config.json` file) can look as follows.
-
-```bash
-freqtrade download-data --exchange binance
-```
-
-This will download historical candle (OHLCV) data for all the currency pairs defined in the configuration.
-
-Alternatively, specify the pairs directly
-
-```bash
-freqtrade download-data --exchange binance --pairs ETH/USDT XRP/USDT BTC/USDT
-```
-
-or as regex (in this case, to download all active USDT pairs)
-
-```bash
-freqtrade download-data --exchange binance --pairs .*/USDT
-```
-
-### Other Notes
-
-* To use a different directory than the exchange specific default, use `--datadir user_data/data/some_directory`.
-* To change the exchange used to download the historical data from, please use a different configuration file (you'll probably need to adjust rate limits etc.)
-* To use `pairs.json` from some other directory, use `--pairs-file some_other_dir/pairs.json`.
-* To download historical candle (OHLCV) data for only 10 days, use `--days 10` (defaults to 30 days).
-* To download historical candle (OHLCV) data from a fixed starting point, use `--timerange 20200101-` - which will download all data from January 1st, 2020.
-* Use `--timeframes` to specify what timeframe download the historical candle (OHLCV) data for. Default is `--timeframes 1m 5m` which will download 1-minute and 5-minute data.
-* To use exchange, timeframe and list of pairs as defined in your configuration file, use the `-c/--config` option. With this, the script uses the whitelist defined in the config as the list of currency pairs to download data for and does not require the pairs.json file. You can combine `-c/--config` with most other options.
-
-??? Note "Permission denied errors"
-    If your configuration directory `user_data` was made by docker, you may get the following error:
-
-    ```
-    cp: cannot create regular file 'user_data/data/binance/pairs.json': Permission denied
-    ```
-
-    You can fix the permissions of your user-data directory as follows:
-
-    ```
-    sudo chown -R $UID:$GID user_data
-    ```
-
-### Download additional data before the current timerange
-
-Assuming you downloaded all data from 2022 (`--timerange 20220101-`) - but you'd now like to also backtest with earlier data.
-You can do so by using the `--prepend` flag, combined with `--timerange` - specifying an end-date.
-
-``` bash
-freqtrade download-data --exchange binance --pairs ETH/USDT XRP/USDT BTC/USDT --prepend --timerange 20210101-20220101
-```
-
-!!! Note
-    Freqtrade will ignore the end-date in this mode if data is available, updating the end-date to the existing data start point.
-
-### Data format
-
-Freqtrade currently supports the following data-formats:
-
-* `feather` - a dataformat based on Apache Arrow
-* `json` -  plain "text" json files
-* `jsongz` - a gzip-zipped version of json files
-* `hdf5` - a high performance datastore
-* `parquet` - columnar datastore (OHLCV only)
-
-By default, both OHLCV data and trades data are stored in the `feather` format.
-
-This can be changed via the `--data-format-ohlcv` and `--data-format-trades` command line arguments respectively.
-To persist this change, you should also add the following snippet to your configuration, so you don't have to insert the above arguments each time:
-
-``` jsonc
-    // ...
-    "dataformat_ohlcv": "hdf5",
-    "dataformat_trades": "hdf5",
-    // ...
-```
-
-If the default data-format has been changed during download, then the keys `dataformat_ohlcv` and `dataformat_trades` in the configuration file need to be adjusted to the selected dataformat as well.
-
-!!! Note
-    You can convert between data-formats using the [convert-data](#sub-command-convert-data) and [convert-trade-data](#sub-command-convert-trade-data) methods.
-
-#### Dataformat comparison
-
-The following comparisons have been made with the following data, and by using the linux `time` command.
-
-```
-Found 6 pair / timeframe combinations.
-+----------+-------------+--------+---------------------+---------------------+
-|     Pair |   Timeframe |   Type |                From |                  To |
-|----------+-------------+--------+---------------------+---------------------|
-| BTC/USDT |          5m |   spot | 2017-08-17 04:00:00 | 2022-09-13 19:25:00 |
-| ETH/USDT |          1m |   spot | 2017-08-17 04:00:00 | 2022-09-13 19:26:00 |
-| BTC/USDT |          1m |   spot | 2017-08-17 04:00:00 | 2022-09-13 19:30:00 |
-| XRP/USDT |          5m |   spot | 2018-05-04 08:10:00 | 2022-09-13 19:15:00 |
-| XRP/USDT |          1m |   spot | 2018-05-04 08:11:00 | 2022-09-13 19:22:00 |
-| ETH/USDT |          5m |   spot | 2017-08-17 04:00:00 | 2022-09-13 19:20:00 |
-+----------+-------------+--------+---------------------+---------------------+
-```
-
-Timings have been taken in a not very scientific way with the following command, which forces reading the data into memory.
-
-``` bash
-time freqtrade list-data --show-timerange --data-format-ohlcv <dataformat>
-```
-
-|  Format | Size | timing |
-|------------|-------------|-------------|
-| `feather` | 72Mb | 3.5s |
-| `json` | 149Mb | 25.6s |
-| `jsongz` | 39Mb | 27s |
-| `hdf5` | 145Mb | 3.9s |
-| `parquet` | 83Mb | 3.8s |
-
-Size has been taken from the BTC/USDT 1m spot combination for the timerange specified above.
-
-To have a best performance/size mix, we recommend using the default feather format, or parquet.
-
-### Pairs file
-
-In alternative to the whitelist from `config.json`, a `pairs.json` file can be used.
-If you are using Binance for example:
-
-* create a directory `user_data/data/binance` and copy or create the `pairs.json` file in that directory.
-* update the `pairs.json` file to contain the currency pairs you are interested in.
-
-```bash
-mkdir -p user_data/data/binance
-touch user_data/data/binance/pairs.json
-```
-
-The format of the `pairs.json` file is a simple json list.
-Mixing different stake-currencies is allowed for this file, since it's only used for downloading.
-
-``` json
-[
-    "ETH/BTC",
-    "ETH/USDT",
-    "BTC/USDT",
-    "XRP/ETH"
-]
-```
-
-!!! Note
-    The `pairs.json` file is only used when no configuration is loaded (implicitly by naming, or via `--config` flag).
-    You can force the usage of this file via `--pairs-file pairs.json` - however we recommend to use the pairlist from within the configuration, either via `exchange.pair_whitelist` or `pairs` setting in the configuration.
-
-## Sub-command convert data
-
-```
-usage: freqtrade convert-data [-h] [-v] [--logfile FILE] [-V] [-c PATH]
-                              [-d PATH] [--userdir PATH]
-                              [-p PAIRS [PAIRS ...]] --format-from
-                              {json,jsongz,hdf5,feather,parquet} --format-to
-                              {json,jsongz,hdf5,feather,parquet} [--erase]
-                              [--exchange EXCHANGE]
-                              [-t TIMEFRAMES [TIMEFRAMES ...]]
-                              [--trading-mode {spot,margin,futures}]
-                              [--candle-types {spot,futures,mark,index,premiumIndex,funding_rate} [{spot,futures,mark,index,premiumIndex,funding_rate} ...]]
-
-options:
-  -h, --help            show this help message and exit
-  -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
-                        Limit command to these pairs. Pairs are space-
-                        separated.
-  --format-from {json,jsongz,hdf5,feather,parquet}
-                        Source format for data conversion.
-  --format-to {json,jsongz,hdf5,feather,parquet}
-                        Destination format for data conversion.
-  --erase               Clean all existing data for the selected
-                        exchange/pairs/timeframes.
-  --exchange EXCHANGE   Exchange name. Only valid if no config is provided.
-  -t TIMEFRAMES [TIMEFRAMES ...], --timeframes TIMEFRAMES [TIMEFRAMES ...]
-                        Specify which tickers to download. Space-separated
-                        list. Default: `1m 5m`.
-  --trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures}
-                        Select Trading mode
-  --candle-types {spot,futures,mark,index,premiumIndex,funding_rate} [{spot,futures,mark,index,premiumIndex,funding_rate} ...]
-                        Select candle type to convert. Defaults to all
-                        available types.
-
-Common arguments:
-  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
-  --logfile FILE, --log-file FILE
-                        Log to the file specified. Special values are:
-                        'syslog', 'journald'. See the documentation for more
-                        details.
-  -V, --version         show program's version number and exit
-  -c PATH, --config PATH
-                        Specify configuration file (default:
-                        `userdir/config.json` or `config.json` whichever
-                        exists). Multiple --config options may be used. Can be
-                        set to `-` to read config from stdin.
-  -d PATH, --datadir PATH, --data-dir PATH
-                        Path to directory with historical backtesting data.
-  --userdir PATH, --user-data-dir PATH
-                        Path to userdata directory.
-```
-
-### Example converting data
-
-The following command will convert all candle (OHLCV) data available in `~/.freqtrade/data/binance` from json to jsongz, saving diskspace in the process.
-It'll also remove original json data files (`--erase` parameter).
-
-``` bash
-freqtrade convert-data --format-from json --format-to jsongz --datadir ~/.freqtrade/data/binance -t 5m 15m --erase
-```
-
-## Sub-command convert trade data
-
-```
-usage: freqtrade convert-trade-data [-h] [-v] [--logfile FILE] [-V] [-c PATH]
-                                    [-d PATH] [--userdir PATH]
-                                    [-p PAIRS [PAIRS ...]] --format-from
-                                    {json,jsongz,hdf5,feather,parquet}
-                                    --format-to
-                                    {json,jsongz,hdf5,feather,parquet}
-                                    [--erase] [--exchange EXCHANGE]
-
-options:
-  -h, --help            show this help message and exit
-  -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
-                        Limit command to these pairs. Pairs are space-
-                        separated.
-  --format-from {json,jsongz,hdf5,feather,parquet}
-                        Source format for data conversion.
-  --format-to {json,jsongz,hdf5,feather,parquet}
-                        Destination format for data conversion.
-  --erase               Clean all existing data for the selected
-                        exchange/pairs/timeframes.
-  --exchange EXCHANGE   Exchange name. Only valid if no config is provided.
-
-Common arguments:
-  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
-  --logfile FILE, --log-file FILE
-                        Log to the file specified. Special values are:
-                        'syslog', 'journald'. See the documentation for more
-                        details.
-  -V, --version         show program's version number and exit
-  -c PATH, --config PATH
-                        Specify configuration file (default:
-                        `userdir/config.json` or `config.json` whichever
-                        exists). Multiple --config options may be used. Can be
-                        set to `-` to read config from stdin.
-  -d PATH, --datadir PATH, --data-dir PATH
-                        Path to directory with historical backtesting data.
-  --userdir PATH, --user-data-dir PATH
-                        Path to userdata directory.
-
-```
-
-### Example converting trades
-
-The following command will convert all available trade-data in `~/.freqtrade/data/kraken` from jsongz to json.
-It'll also remove original jsongz data files (`--erase` parameter).
-
-``` bash
-freqtrade convert-trade-data --format-from jsongz --format-to json --datadir ~/.freqtrade/data/kraken --erase
-```
-
-## Sub-command trades to ohlcv
-
-When you need to use `--dl-trades` (kraken only) to download data, conversion of trades data to ohlcv data is the last step.
-This command will allow you to repeat this last step for additional timeframes without re-downloading the data.
-
-```
-usage: freqtrade trades-to-ohlcv [-h] [-v] [--logfile FILE] [-V] [-c PATH]
-                                 [-d PATH] [--userdir PATH]
-                                 [-p PAIRS [PAIRS ...]]
-                                 [-t TIMEFRAMES [TIMEFRAMES ...]]
-                                 [--exchange EXCHANGE]
-                                 [--data-format-ohlcv {json,jsongz,hdf5,feather,parquet}]
-                                 [--data-format-trades {json,jsongz,hdf5,feather}]
-
-options:
-  -h, --help            show this help message and exit
-  -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
-                        Limit command to these pairs. Pairs are space-
-                        separated.
-  -t TIMEFRAMES [TIMEFRAMES ...], --timeframes TIMEFRAMES [TIMEFRAMES ...]
-                        Specify which tickers to download. Space-separated
-                        list. Default: `1m 5m`.
-  --exchange EXCHANGE   Exchange name. Only valid if no config is provided.
-  --data-format-ohlcv {json,jsongz,hdf5,feather,parquet}
-                        Storage format for downloaded candle (OHLCV) data.
-                        (default: `feather`).
-  --data-format-trades {json,jsongz,hdf5,feather}
-                        Storage format for downloaded trades data. (default:
-                        `feather`).
-
-Common arguments:
-  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
-  --logfile FILE, --log-file FILE
-                        Log to the file specified. Special values are:
-                        'syslog', 'journald'. See the documentation for more
-                        details.
-  -V, --version         show program's version number and exit
-  -c PATH, --config PATH
-                        Specify configuration file (default:
-                        `userdir/config.json` or `config.json` whichever
-                        exists). Multiple --config options may be used. Can be
-                        set to `-` to read config from stdin.
-  -d PATH, --datadir PATH, --data-dir PATH
-                        Path to directory with historical backtesting data.
-  --userdir PATH, --user-data-dir PATH
-                        Path to userdata directory.
-
-```
-
-### Example trade-to-ohlcv conversion
-
-``` bash
-freqtrade trades-to-ohlcv --exchange kraken -t 5m 1h 1d --pairs BTC/EUR ETH/EUR
-```
-
-## Sub-command list-data
-
-You can get a list of downloaded data using the `list-data` sub-command.
-
-```
-usage: freqtrade list-data [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH]
-                           [--userdir PATH] [--exchange EXCHANGE]
-                           [--data-format-ohlcv {json,jsongz,hdf5,feather,parquet}]
-                           [--data-format-trades {json,jsongz,hdf5,feather,parquet}]
-                           [--trades] [-p PAIRS [PAIRS ...]]
-                           [--trading-mode {spot,margin,futures}]
-                           [--show-timerange]
-
-options:
-  -h, --help            show this help message and exit
-  --exchange EXCHANGE   Exchange name. Only valid if no config is provided.
-  --data-format-ohlcv {json,jsongz,hdf5,feather,parquet}
-                        Storage format for downloaded candle (OHLCV) data.
-                        (default: `feather`).
-  --data-format-trades {json,jsongz,hdf5,feather,parquet}
-                        Storage format for downloaded trades data. (default:
-                        `feather`).
-  --trades              Work on trades data instead of OHLCV data.
-  -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
-                        Limit command to these pairs. Pairs are space-
-                        separated.
-  --trading-mode {spot,margin,futures}, --tradingmode {spot,margin,futures}
-                        Select Trading mode
-  --show-timerange      Show timerange available for available data. (May take
-                        a while to calculate).
-
-Common arguments:
-  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
-  --logfile FILE, --log-file FILE
-                        Log to the file specified. Special values are:
-                        'syslog', 'journald'. See the documentation for more
-                        details.
-  -V, --version         show program's version number and exit
-  -c PATH, --config PATH
-                        Specify configuration file (default:
-                        `userdir/config.json` or `config.json` whichever
-                        exists). Multiple --config options may be used. Can be
-                        set to `-` to read config from stdin.
-  -d PATH, --datadir PATH, --data-dir PATH
-                        Path to directory with historical backtesting data.
-  --userdir PATH, --user-data-dir PATH
-                        Path to userdata directory.
-
-```
-
-### Example list-data
-
-```bash
-> freqtrade list-data --userdir ~/.freqtrade/user_data/
-
-              Found 33 pair / timeframe combinations.
-┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━┓
-┃          Pair ┃                                 Timeframe ┃ Type ┃
-┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━┩
-│       ADA/BTC │     5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d │ spot │
-│       ADA/ETH │     5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d │ spot │
-│       ETH/BTC │     5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d │ spot │
-│      ETH/USDT │                  5m, 15m, 30m, 1h, 2h, 4h │ spot │
-└───────────────┴───────────────────────────────────────────┴──────┘
-
-```
-
-Show all trades data including from/to timerange
-
-``` bash
-> freqtrade list-data --show --trades
-                     Found trades data for 1 pair.                     
-┏━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┓
-┃    Pair ┃ Type ┃                From ┃                  To ┃ Trades ┃
-┡━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━┩
-│ XRP/ETH │ spot │ 2019-10-11 00:00:11 │ 2019-10-13 11:19:28 │  12477 │
-└─────────┴──────┴─────────────────────┴─────────────────────┴────────┘
-
-```
-
-## Trades (tick) data
-
-By default, `download-data` sub-command downloads Candles (OHLCV) data. Most exchanges also provide historic trade-data via their API.
-This data can be useful if you need many different timeframes, since it is only downloaded once, and then resampled locally to the desired timeframes.
-
-Since this data is large by default, the files use the feather file format by default. They are stored in your data-directory with the naming convention of `<pair>-trades.feather` (`ETH_BTC-trades.feather`). Incremental mode is also supported, as for historic OHLCV data, so downloading the data once per week with `--days 8` will create an incremental data-repository.
-
-To use this mode, simply add `--dl-trades` to your call. This will swap the download method to download trades.
-If `--convert` is also provided, the resample step will happen automatically and overwrite eventually existing OHLCV data for the given pair/timeframe combinations.
-
-!!! Warning "Do not use"
-    You should not use this unless you're a kraken user (Kraken does not provide historic OHLCV data).  
-    Most other exchanges provide OHLCV data with sufficient history, so downloading multiple timeframes through that method will still proof to be a lot faster than downloading trades data.
-
-!!! Note "Kraken user"
-    Kraken users should read [this](exchanges.md#historic-kraken-data) before starting to download data.
-
-Example call:
-
-```bash
-freqtrade download-data --exchange kraken --pairs XRP/EUR ETH/EUR --days 20 --dl-trades
-```
-
-!!! Note
-    While this method uses async calls, it will be slow, since it requires the result of the previous call to generate the next request to the exchange.
-
-## Next step
-
-Great, you now have some data downloaded, so you can now start [backtesting](backtesting.md) your strategy.

docs/deprecated.md

@@ -1,81 +0,0 @@
-# Deprecated features
-
-This page contains description of the command line arguments, configuration parameters
-and the bot features that were declared as DEPRECATED by the bot development team
-and are no longer supported. Please avoid their usage in your configuration.
-
-## Removed features
-
-### the `--refresh-pairs-cached` command line option
-
-`--refresh-pairs-cached` in the context of backtesting, hyperopt and edge allows to refresh candle data for backtesting.
-Since this leads to much confusion, and slows down backtesting (while not being part of backtesting) this has been singled out as a separate freqtrade sub-command `freqtrade download-data`.
-
-This command line option was deprecated in 2019.7-dev (develop branch) and removed in 2019.9.
-
-### The **--dynamic-whitelist** command line option
-
-This command line option was deprecated in 2018 and removed freqtrade 2019.6-dev (develop branch) and in freqtrade 2019.7.
-Please refer to [pairlists](plugins.md#pairlists-and-pairlist-handlers) instead.
-
-### the `--live` command line option
-
-`--live` in the context of backtesting allowed to download the latest tick data for backtesting.
-Did only download the latest 500 candles, so was ineffective in getting good backtest data.
-Removed in 2019-7-dev (develop branch) and in freqtrade 2019.8.
-
-### `ticker_interval` (now `timeframe`)
-
-Support for `ticker_interval` terminology was deprecated in 2020.6 in favor of `timeframe` - and compatibility code was removed in 2022.3.
-
-### Allow running multiple pairlists in sequence
-
-The former `"pairlist"` section in the configuration has been removed, and is replaced by `"pairlists"` - being a list to specify a sequence of pairlists.
-
-The old section of configuration parameters (`"pairlist"`) has been deprecated in 2019.11 and has been removed in 2020.4.
-
-### deprecation of bidVolume and askVolume from volume-pairlist
-
-Since only quoteVolume can be compared between assets, the other options (bidVolume, askVolume) have been deprecated in 2020.4, and have been removed in 2020.9.
-
-### Using order book steps for exit price
-
-Using `order_book_min` and `order_book_max` used to allow stepping the orderbook and trying to find the next ROI slot - trying to place sell-orders early.
-As this does however increase risk and provides no benefit, it's been removed for maintainability purposes in 2021.7.
-
-### Legacy Hyperopt mode
-
-Using separate hyperopt files was deprecated in 2021.4 and was removed in 2021.9.
-Please switch to the new [Parametrized Strategies](hyperopt.md) to benefit from the new hyperopt interface.
-
-## Strategy changes between V2 and V3
-
-Isolated Futures / short trading was introduced in 2022.4. This required major changes to configuration settings, strategy interfaces, ...
-
-We have put a great effort into keeping compatibility with existing strategies, so if you just want to continue using freqtrade in spot markets, there are no changes necessary.
-While we may drop support for the current interface sometime in the future, we will announce this separately and have an appropriate transition period.
-
-Please follow the [Strategy migration](strategy_migration.md) guide to migrate your strategy to the new format to start using the new functionalities.
-
-### webhooks - changes with 2022.4
-
-#### `buy_tag` has been renamed to `enter_tag`
-
-This should apply only to your strategy and potentially to webhooks.
-We will keep a compatibility layer for 1-2 versions (so both `buy_tag` and `enter_tag` will still work), but support for this in webhooks will disappear after that.
-
-#### Naming changes
-
-Webhook terminology changed from "sell" to "exit", and from "buy" to "entry", removing "webhook" in the process.
-
-* `webhookbuy`, `webhookentry` -> `entry`
-* `webhookbuyfill`, `webhookentryfill` -> `entry_fill`
-* `webhookbuycancel`, `webhookentrycancel` -> `entry_cancel`
-* `webhooksell`, `webhookexit` -> `exit`
-* `webhooksellfill`, `webhookexitfill` -> `exit_fill`
-* `webhooksellcancel`, `webhookexitcancel` -> `exit_cancel`
-
-
-## Removal of `populate_any_indicators`
-
-version 2023.3 saw the removal of `populate_any_indicators` in favor of split methods for feature engineering and targets. Please read the [migration document](strategy_migration.md#freqai-strategy) for full details.

docs/developer.md

@@ -1,504 +0,0 @@
-# Development Help
-
-This page is intended for developers of Freqtrade, people who want to contribute to the Freqtrade codebase or documentation, or people who want to understand the source code of the application they're running.
-
-All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome. We [track issues](https://github.com/freqtrade/freqtrade/issues) on [GitHub](https://github.com) and also have a dev channel on [discord](https://discord.gg/p7nuUNVfP7) where you can ask questions.
-
-## Documentation
-
-Documentation is available at [https://freqtrade.io](https://www.freqtrade.io/) and needs to be provided with every new feature PR.
-
-Special fields for the documentation (like Note boxes, ...) can be found [here](https://squidfunk.github.io/mkdocs-material/reference/admonitions/).
-
-To test the documentation locally use the following commands.
-
-``` bash
-pip install -r docs/requirements-docs.txt
-mkdocs serve
-```
-
-This will spin up a local server (usually on port 8000) so you can see if everything looks as you'd like it to.
-
-## Developer setup
-
-To configure a development environment, you can either use the provided [DevContainer](#devcontainer-setup), or use the `setup.sh` script and answer "y" when asked "Do you want to install dependencies for dev [y/N]? ".
-Alternatively (e.g. if your system is not supported by the setup.sh script), follow the manual installation process and run `pip3 install -r requirements-dev.txt` - followed by `pip3 install -e .[all]`.
-
-This will install all required tools for development, including `pytest`, `ruff`, `mypy`, and `coveralls`.
-
-Then install the git hook scripts by running `pre-commit install`, so your changes will be verified locally before committing.
-This avoids a lot of waiting for CI already, as some basic formatting checks are done locally on your machine.
-
-Before opening a pull request, please familiarize yourself with our [Contributing Guidelines](https://github.com/freqtrade/freqtrade/blob/develop/CONTRIBUTING.md).
-
-### Devcontainer setup
-
-The fastest and easiest way to get started is to use [VSCode](https://code.visualstudio.com/) with the Remote container extension.
-This gives developers the ability to start the bot with all required dependencies *without* needing to install any freqtrade specific dependencies on your local machine.
-
-#### Devcontainer dependencies
-
-* [VSCode](https://code.visualstudio.com/)
-* [docker](https://docs.docker.com/install/)
-* [Remote container extension documentation](https://code.visualstudio.com/docs/remote)
-
-For more information about the [Remote container extension](https://code.visualstudio.com/docs/remote), best consult the documentation.
-
-### Tests
-
-New code should be covered by basic unittests. Depending on the complexity of the feature, Reviewers may request more in-depth unittests.
-If necessary, the Freqtrade team can assist and give guidance with writing good tests (however please don't expect anyone to write the tests for you).
-
-#### How to run tests
-
-Use `pytest` in root folder to run all available testcases and confirm your local environment is setup correctly
-
-!!! Note "feature branches"
-    Tests are expected to pass on the `develop` and `stable` branches. Other branches may be work in progress with tests not working yet.
-
-#### Checking log content in tests
-
-Freqtrade uses 2 main methods to check log content in tests, `log_has()` and `log_has_re()` (to check using regex, in case of dynamic log-messages).
-These are available from `conftest.py` and can be imported in any test module.
-
-A sample check looks as follows:
-
-``` python
-from tests.conftest import log_has, log_has_re
-
-def test_method_to_test(caplog):
-    method_to_test()
-
-    assert log_has("This event happened", caplog)
-    # Check regex with trailing number ...
-    assert log_has_re(r"This dynamic event happened and produced \d+", caplog)
-
-```
-
-### Debug configuration
-
-To debug freqtrade, we recommend VSCode (with the Python extension) with the following launch configuration (located in `.vscode/launch.json`).
-Details will obviously vary between setups - but this should work to get you started.
-
-``` json
-{
-    "name": "freqtrade trade",
-    "type": "debugpy",
-    "request": "launch",
-    "module": "freqtrade",
-    "console": "integratedTerminal",
-    "args": [
-        "trade",
-        // Optional:
-        // "--userdir", "user_data",
-        "--strategy", 
-        "MyAwesomeStrategy",
-    ]
-},
-```
-
-Command line arguments can be added in the `"args"` array.
-This method can also be used to debug a strategy, by setting the breakpoints within the strategy.
-
-A similar setup can also be taken for Pycharm - using `freqtrade` as module name, and setting the command line arguments as "parameters".
-
-??? Tip "Correct venv usage"
-    When using a virtual environment (which you should), make sure that your Editor is using the correct virtual environment to avoid problems or "unknown import" errors.
-
-    #### Vscode
-
-    You can select the correct environment in VSCode with the command "Python: Select Interpreter" - which will show you environments the extension detected.
-    If your environment has not been detected, you can also pick a path manually.
-
-    #### Pycharm
-
-    In pycharm, you can select the appropriate Environment in the "Run/Debug Configurations" window.
-    ![Pycharm debug configuration](assets/pycharm_debug.png)
-
-!!! Note "Startup directory"
-    This assumes that you have the repository checked out, and the editor is started at the repository root level (so setup.py is at the top level of your repository).
-
-## ErrorHandling
-
-Freqtrade Exceptions all inherit from `FreqtradeException`.
-This general class of error should however not be used directly. Instead, multiple specialized sub-Exceptions exist.
-
-Below is an outline of exception inheritance hierarchy:
-
-```
-+ FreqtradeException
-|
-+---+ OperationalException
-|   |
-|   +---+ ConfigurationError
-|
-+---+ DependencyException
-|   |
-|   +---+ PricingError
-|   |
-|   +---+ ExchangeError
-|       |
-|       +---+ TemporaryError
-|       |
-|       +---+ DDosProtection
-|       |
-|       +---+ InvalidOrderException
-|           |
-|           +---+ RetryableOrderError
-|           |
-|           +---+ InsufficientFundsError
-|
-+---+ StrategyError
-```
-
----
-
-## Plugins
-
-### Pairlists
-
-You have a great idea for a new pair selection algorithm you would like to try out? Great.
-Hopefully you also want to contribute this back upstream.
-
-Whatever your motivations are - This should get you off the ground in trying to develop a new Pairlist Handler.
-
-First of all, have a look at the [VolumePairList](https://github.com/freqtrade/freqtrade/blob/develop/freqtrade/pairlist/VolumePairList.py) Handler, and best copy this file with a name of your new Pairlist Handler.
-
-This is a simple Handler, which however serves as a good example on how to start developing.
-
-Next, modify the class-name of the Handler (ideally align this with the module filename).
-
-The base-class provides an instance of the exchange (`self._exchange`) the pairlist manager (`self._pairlistmanager`), as well as the main configuration (`self._config`), the pairlist dedicated configuration (`self._pairlistconfig`) and the absolute position within the list of pairlists.
-
-```python
-        self._exchange = exchange
-        self._pairlistmanager = pairlistmanager
-        self._config = config
-        self._pairlistconfig = pairlistconfig
-        self._pairlist_pos = pairlist_pos
-```
-
-!!! Tip
-    Don't forget to register your pairlist in `constants.py` under the variable `AVAILABLE_PAIRLISTS` - otherwise it will not be selectable.
-
-Now, let's step through the methods which require actions:
-
-#### Pairlist configuration
-
-Configuration for the chain of Pairlist Handlers is done in the bot configuration file in the element `"pairlists"`, an array of configuration parameters for each Pairlist Handlers in the chain.
-
-By convention, `"number_assets"` is used to specify the maximum number of pairs to keep in the pairlist. Please follow this to ensure a consistent user experience.
-
-Additional parameters can be configured as needed. For instance, `VolumePairList` uses `"sort_key"` to specify the sorting value - however feel free to specify whatever is necessary for your great algorithm to be successful and dynamic.
-
-#### short_desc
-
-Returns a description used for Telegram messages.
-
-This should contain the name of the Pairlist Handler, as well as a short description containing the number of assets. Please follow the format `"PairlistName - top/bottom X pairs"`.
-
-#### gen_pairlist
-
-Override this method if the Pairlist Handler can be used as the leading Pairlist Handler in the chain, defining the initial pairlist which is then handled by all Pairlist Handlers in the chain. Examples are `StaticPairList` and `VolumePairList`.
-
-This is called with each iteration of the bot (only if the Pairlist Handler is at the first location) - so consider implementing caching for compute/network heavy calculations.
-
-It must return the resulting pairlist (which may then be passed into the chain of Pairlist Handlers).
-
-Validations are optional, the parent class exposes a `verify_blacklist(pairlist)` and `_whitelist_for_active_markets(pairlist)` to do default filtering. Use this if you limit your result to a certain number of pairs - so the end-result is not shorter than expected.
-
-#### filter_pairlist
-
-This method is called for each Pairlist Handler in the chain by the pairlist manager.
-
-This is called with each iteration of the bot - so consider implementing caching for compute/network heavy calculations.
-
-It gets passed a pairlist (which can be the result of previous pairlists) as well as `tickers`, a pre-fetched version of `get_tickers()`.
-
-The default implementation in the base class simply calls the `_validate_pair()` method for each pair in the pairlist, but you may override it. So you should either implement the `_validate_pair()` in your Pairlist Handler or override `filter_pairlist()` to do something else.
-
-If overridden, it must return the resulting pairlist (which may then be passed into the next Pairlist Handler in the chain).
-
-Validations are optional, the parent class exposes a `verify_blacklist(pairlist)` and `_whitelist_for_active_markets(pairlist)` to do default filters. Use this if you limit your result to a certain number of pairs - so the end result is not shorter than expected.
-
-In `VolumePairList`, this implements different methods of sorting, does early validation so only the expected number of pairs is returned.
-
-##### sample
-
-``` python
-    def filter_pairlist(self, pairlist: List[str], tickers: Dict) -> List[str]:
-        # Generate dynamic whitelist
-        pairs = self._calculate_pairlist(pairlist, tickers)
-        return pairs
-```
-
-### Protections
-
-Best read the [Protection documentation](plugins.md#protections) to understand protections.
-This Guide is directed towards Developers who want to develop a new protection.
-
-No protection should use datetime directly, but use the provided `date_now` variable for date calculations. This preserves the ability to backtest protections.
-
-!!! Tip "Writing a new Protection"
-    Best copy one of the existing Protections to have a good example.
-    Don't forget to register your protection in `constants.py` under the variable `AVAILABLE_PROTECTIONS` - otherwise it will not be selectable.
-
-#### Implementation of a new protection
-
-All Protection implementations must have `IProtection` as parent class.
-For that reason, they must implement the following methods:
-
-* `short_desc()`
-* `global_stop()`
-* `stop_per_pair()`.
-
-`global_stop()` and `stop_per_pair()` must return a ProtectionReturn object, which consists of:
-
-* lock pair - boolean
-* lock until - datetime - until when should the pair be locked (will be rounded up to the next new candle)
-* reason - string, used for logging and storage in the database
-* lock_side - long, short or '*'.
-
-The `until` portion should be calculated using the provided `calculate_lock_end()` method.
-
-All Protections should use `"stop_duration"` / `"stop_duration_candles"` to define how long a pair (or all pairs) should be locked.
-The content of this is made available as `self._stop_duration` to the each Protection.
-
-If your protection requires a look-back period, please use `"lookback_period"` / `"lockback_period_candles"` to keep all protections aligned.
-
-#### Global vs. local stops
-
-Protections can have 2 different ways to stop trading for a limited :
-
-* Per pair (local)
-* For all Pairs (globally)
-
-##### Protections - per pair
-
-Protections that implement the per pair approach must set `has_local_stop=True`.
-The method `stop_per_pair()` will be called whenever a trade closed (exit order completed).
-
-##### Protections - global protection
-
-These Protections should do their evaluation across all pairs, and consequently will also lock all pairs from trading (called a global PairLock).
-Global protection must set `has_global_stop=True` to be evaluated for global stops.
-The method `global_stop()` will be called whenever a trade closed (exit order completed).
-
-##### Protections - calculating lock end time
-
-Protections should calculate the lock end time based on the last trade it considers.
-This avoids re-locking should the lookback-period be longer than the actual lock period.
-
-The `IProtection` parent class provides a helper method for this in `calculate_lock_end()`.
-
----
-
-## Implement a new Exchange (WIP)
-
-!!! Note
-    This section is a Work in Progress and is not a complete guide on how to test a new exchange with Freqtrade.
-
-!!! Note
-    Make sure to use an up-to-date version of CCXT before running any of the below tests.
-    You can get the latest version of ccxt by running `pip install -U ccxt` with activated virtual environment.
-    Native docker is not supported for these tests, however the available dev-container will support all required actions and eventually necessary changes.
-
-Most exchanges supported by CCXT should work out of the box.
-
-To quickly test the public endpoints of an exchange, add a configuration for your exchange to `tests/exchange_online/conftest.py` and run these tests with `pytest --longrun tests/exchange_online/test_ccxt_compat.py`.
-Completing these tests successfully a good basis point (it's a requirement, actually), however these won't guarantee correct exchange functioning, as this only tests public endpoints, but no private endpoint (like generate order or similar).
-
-Also try to use `freqtrade download-data` for an extended timerange (multiple months) and verify that the data downloaded correctly (no holes, the specified timerange was actually downloaded).
-
-These are prerequisites to have an exchange listed as either Supported or Community tested (listed on the homepage).
-The below are "extras", which will make an exchange better (feature-complete) - but are not absolutely necessary for either of the 2 categories.
-
-Additional tests / steps to complete:
-
-* Verify data provided by `fetch_ohlcv()` - and eventually adjust `ohlcv_candle_limit` for this exchange
-* Check L2 orderbook limit range (API documentation) - and eventually set as necessary
-* Check if balance shows correctly (*)
-* Create market order (*)
-* Create limit order (*)
-* Cancel order (*)
-* Complete trade (enter + exit) (*)
-  * Compare result calculation between exchange and bot
-  * Ensure fees are applied correctly (check the database against the exchange)
-
-(*) Requires API keys and Balance on the exchange.
-
-### Stoploss On Exchange
-
-Check if the new exchange supports Stoploss on Exchange orders through their API.
-
-Since CCXT does not provide unification for Stoploss On Exchange yet, we'll need to implement the exchange-specific parameters ourselves. Best look at `binance.py` for an example implementation of this. You'll need to dig through the documentation of the Exchange's API on how exactly this can be done. [CCXT Issues](https://github.com/ccxt/ccxt/issues) may also provide great help, since others may have implemented something similar for their projects.
-
-### Incomplete candles
-
-While fetching candle (OHLCV) data, we may end up getting incomplete candles (depending on the exchange).
-To demonstrate this, we'll use daily candles (`"1d"`) to keep things simple.
-We query the api (`ct.fetch_ohlcv()`) for the timeframe and look at the date of the last entry. If this entry changes or shows the date of a "incomplete" candle, then we should drop this since having incomplete candles is problematic because indicators assume that only complete candles are passed to them, and will generate a lot of false buy signals. By default, we're therefore removing the last candle assuming it's incomplete.
-
-To check how the new exchange behaves, you can use the following snippet:
-
-``` python
-import ccxt
-from datetime import datetime, timezone
-from freqtrade.data.converter import ohlcv_to_dataframe
-ct = ccxt.binance()  # Use the exchange you're testing
-timeframe = "1d"
-pair = "BTC/USDT"  # Make sure to use a pair that exists on that exchange!
-raw = ct.fetch_ohlcv(pair, timeframe=timeframe)
-
-# convert to dataframe
-df1 = ohlcv_to_dataframe(raw, timeframe, pair=pair, drop_incomplete=False)
-
-print(df1.tail(1))
-print(datetime.now(timezone.utc))
-```
-
-``` output
-                         date      open      high       low     close  volume  
-499 2019-06-08 00:00:00+00:00  0.000007  0.000007  0.000007  0.000007   26264344.0  
-2019-06-09 12:30:27.873327
-```
-
-The output will show the last entry from the Exchange as well as the current UTC date.
-If the day shows the same day, then the last candle can be assumed as incomplete and should be dropped (leave the setting `"ohlcv_partial_candle"` from the exchange-class untouched / True). Otherwise, set `"ohlcv_partial_candle"` to `False` to not drop Candles (shown in the example above).
-Another way is to run this command multiple times in a row and observe if the volume is changing (while the date remains the same).
-
-### Update binance cached leverage tiers
-
-Updating leveraged tiers should be done regularly - and requires an authenticated account with futures enabled.
-
-``` python
-import ccxt
-import json
-from pathlib import Path
-
-exchange = ccxt.binance({
-    'apiKey': '<apikey>',
-    'secret': '<secret>',
-    'options': {'defaultType': 'swap'}
-    })
-_ = exchange.load_markets()
-
-lev_tiers = exchange.fetch_leverage_tiers()
-
-# Assumes this is running in the root of the repository.
-file = Path('freqtrade/exchange/binance_leverage_tiers.json')
-json.dump(dict(sorted(lev_tiers.items())), file.open('w'), indent=2)
-
-```
-
-This file should then be contributed upstream, so others can benefit from this, too.
-
-## Updating example notebooks
-
-To keep the jupyter notebooks aligned with the documentation, the following should be ran after updating a example notebook.
-
-``` bash
-jupyter nbconvert --ClearOutputPreprocessor.enabled=True --inplace freqtrade/templates/strategy_analysis_example.ipynb
-jupyter nbconvert --ClearOutputPreprocessor.enabled=True --to markdown freqtrade/templates/strategy_analysis_example.ipynb --stdout > docs/strategy_analysis_example.md
-```
-
-## Continuous integration
-
-This documents some decisions taken for the CI Pipeline.
-
-* CI runs on all OS variants, Linux (ubuntu), macOS and Windows.
-* Docker images are build for the branches `stable` and `develop`, and are built as multiarch builds, supporting multiple platforms via the same tag.
-* Docker images containing Plot dependencies are also available as `stable_plot` and `develop_plot`.
-* Docker images contain a file, `/freqtrade/freqtrade_commit` containing the commit this image is based of.
-* Full docker image rebuilds are run once a week via schedule.
-* Deployments run on ubuntu.
-* ta-lib binaries are contained in the build_helpers directory to avoid fails related to external unavailability.
-* All tests must pass for a PR to be merged to `stable` or `develop`.
-
-## Creating a release
-
-This part of the documentation is aimed at maintainers, and shows how to create a release.
-
-### Create release branch
-
-!!! Note
-    Make sure that the `stable` branch is up-to-date!
-
-First, pick a commit that's about one week old (to not include latest additions to releases).
-
-``` bash
-# create new branch
-git checkout -b new_release <commitid>
-```
-
-Determine if crucial bugfixes have been made between this commit and the current state, and eventually cherry-pick these.
-
-* Merge the release branch (stable) into this branch.
-* Edit `freqtrade/__init__.py` and add the version matching the current date (for example `2019.7` for July 2019). Minor versions can be `2019.7.1` should we need to do a second release that month. Version numbers must follow allowed versions from PEP0440 to avoid failures pushing to pypi.
-* Commit this part.
-* Push that branch to the remote and create a PR against the **stable branch**.
-* Update develop version to next version following the pattern `2019.8-dev`.
-
-### Create changelog from git commits
-
-``` bash
-# Needs to be done before merging / pulling that branch.
-git log --oneline --no-decorate --no-merges stable..new_release
-```
-
-To keep the release-log short, best wrap the full git changelog into a collapsible details section.
-
-```markdown
-<details>
-<summary>Expand full changelog</summary>
-
-... Full git changelog
-
-</details>
-```
-
-### FreqUI release
-
-If FreqUI has been updated substantially, make sure to create a release before merging the release branch.
-Make sure that freqUI CI on the release is finished and passed before merging the release.
-
-### Create github release / tag
-
-Once the PR against stable is merged (best right after merging):
-
-* Use the button "Draft a new release" in the Github UI (subsection releases).
-* Use the version-number specified as tag.
-* Use "stable" as reference (this step comes after the above PR is merged).
-* Use the above changelog as release comment (as codeblock).
-* Use the below snippet for the new release
-
-??? Tip "Release template"
-    ````
-    --8<-- "includes/release_template.md"
-    ````
-
-## Releases
-
-### pypi
-
-!!! Warning "Manual Releases"
-    This process is automated as part of Github Actions.  
-    Manual pypi pushes should not be necessary.
-
-??? example "Manual release"
-    To manually create a pypi release, please run the following commands:
-
-    Additional requirement: `wheel`, `twine` (for uploading), account on pypi with proper permissions.
-
-    ``` bash
-    pip install -U build
-    python -m build --sdist --wheel
-
-    # For pypi test (to check if some change to the installation did work)
-    twine upload --repository-url https://test.pypi.org/legacy/ dist/*
-
-    # For production:
-    twine upload dist/*
-    ```
-
-    Please don't push non-releases to the productive / real pypi instance.

docs/docker_quickstart.md

@@ -1,226 +0,0 @@
-# Using Freqtrade with Docker
-
-This page explains how to run the bot with Docker. It is not meant to work out of the box. You'll still need to read through the documentation and understand how to properly configure it.
-
-## Install Docker
-
-Start by downloading and installing Docker / Docker Desktop for your platform:
-
-* [Mac](https://docs.docker.com/docker-for-mac/install/)
-* [Windows](https://docs.docker.com/docker-for-windows/install/)
-* [Linux](https://docs.docker.com/install/)
-
-!!! Info "Docker compose install"
-    Freqtrade documentation assumes the use of Docker desktop (or the docker compose plugin).  
-    While the docker-compose standalone installation still works, it will require changing all `docker compose` commands from `docker compose` to `docker-compose` to work (e.g. `docker compose up -d` will become `docker-compose up -d`).
-
-??? Warning "Docker on windows"
-    If you just installed docker on a windows system, make sure to reboot your system, otherwise you might encounter unexplainable Problems related to network connectivity to docker containers.
-
-## Freqtrade with docker
-
-Freqtrade provides an official Docker image on [Dockerhub](https://hub.docker.com/r/freqtradeorg/freqtrade/), as well as a [docker compose file](https://github.com/freqtrade/freqtrade/blob/stable/docker-compose.yml) ready for usage.
-
-!!! Note
-    - The following section assumes that `docker` is installed and available to the logged in user.
-    - All below commands use relative directories and will have to be executed from the directory containing the `docker-compose.yml` file.
-
-### Docker quick start
-
-Create a new directory and place the [docker-compose file](https://raw.githubusercontent.com/freqtrade/freqtrade/stable/docker-compose.yml) in this directory.
-
-``` bash
-mkdir ft_userdata
-cd ft_userdata/
-# Download the docker-compose file from the repository
-curl https://raw.githubusercontent.com/freqtrade/freqtrade/stable/docker-compose.yml -o docker-compose.yml
-
-# Pull the freqtrade image
-docker compose pull
-
-# Create user directory structure
-docker compose run --rm freqtrade create-userdir --userdir user_data
-
-# Create configuration - Requires answering interactive questions
-docker compose run --rm freqtrade new-config --config user_data/config.json
-```
-
-The above snippet creates a new directory called `ft_userdata`, downloads the latest compose file and pulls the freqtrade image.
-The last 2 steps in the snippet create the directory with `user_data`, as well as (interactively) the default configuration based on your selections.
-
-!!! Question "How to edit the bot configuration?"
-    You can edit the configuration at any time, which is available as `user_data/config.json` (within the directory `ft_userdata`) when using the above configuration.
-
-    You can also change the both Strategy and commands by editing the command section of your `docker-compose.yml` file.
-
-#### Adding a custom strategy
-
-1. The configuration is now available as `user_data/config.json`
-2. Copy a custom strategy to the directory `user_data/strategies/`
-3. Add the Strategy' class name to the `docker-compose.yml` file
-
-The `SampleStrategy` is run by default.
-
-!!! Danger "`SampleStrategy` is just a demo!"
-    The `SampleStrategy` is there for your reference and give you ideas for your own strategy.
-    Please always backtest your strategy and use dry-run for some time before risking real money!
-    You will find more information about Strategy development in the [Strategy documentation](strategy-customization.md).
-
-Once this is done, you're ready to launch the bot in trading mode (Dry-run or Live-trading, depending on your answer to the corresponding question you made above).
-
-``` bash
-docker compose up -d
-```
-
-!!! Warning "Default configuration"
-    While the configuration generated will be mostly functional, you will still need to verify that all options correspond to what you want (like Pricing, pairlist, ...) before starting the bot.
-
-#### Accessing the UI
-
-If you've selected to enable FreqUI in the `new-config` step, you will have freqUI available at port `localhost:8080`.
-
-You can now access the UI by typing localhost:8080 in your browser.
-
-??? Note "UI Access on a remote server"
-    If you're running on a VPS, you should consider using either a ssh tunnel, or setup a VPN (openVPN, wireguard) to connect to your bot.
-    This will ensure that freqUI is not directly exposed to the internet, which is not recommended for security reasons (freqUI does not support https out of the box).
-    Setup of these tools is not part of this tutorial, however many good tutorials can be found on the internet.
-    Please also read the [API configuration with docker](rest-api.md#configuration-with-docker) section to learn more about this configuration.
-
-#### Monitoring the bot
-
-You can check for running instances with `docker compose ps`.
-This should list the service `freqtrade` as `running`. If that's not the case, best check the logs (see next point).
-
-#### Docker compose logs
-
-Logs will be written to: `user_data/logs/freqtrade.log`.  
-You can also check the latest log with the command `docker compose logs -f`.
-
-#### Database
-
-The database will be located at: `user_data/tradesv3.sqlite`
-
-#### Updating freqtrade with docker
-
-Updating freqtrade when using `docker` is as simple as running the following 2 commands:
-
-``` bash
-# Download the latest image
-docker compose pull
-# Restart the image
-docker compose up -d
-```
-
-This will first pull the latest image, and will then restart the container with the just pulled version.
-
-!!! Warning "Check the Changelog"
-    You should always check the changelog for breaking changes / manual interventions required and make sure the bot starts correctly after the update.
-
-### Editing the docker-compose file
-
-Advanced users may edit the docker-compose file further to include all possible options or arguments.
-
-All freqtrade arguments will be available by running `docker compose run --rm freqtrade <command> <optional arguments>`.
-
-!!! Warning "`docker compose` for trade commands"
-    Trade commands (`freqtrade trade <...>`) should not be ran via `docker compose run` - but should use `docker compose up -d` instead.
-    This makes sure that the container is properly started (including port forwardings) and will make sure that the container will restart after a system reboot.
-    If you intend to use freqUI, please also ensure to adjust the [configuration accordingly](rest-api.md#configuration-with-docker), otherwise the UI will not be available.
-
-!!! Note "`docker compose run --rm`"
-    Including `--rm` will remove the container after completion, and is highly recommended for all modes except trading mode (running with `freqtrade trade` command).
-
-??? Note "Using docker without docker compose"
-    "`docker compose run --rm`" will require a compose file to be provided.
-    Some freqtrade commands that don't require authentication such as `list-pairs` can be run with "`docker run --rm`" instead.  
-    For example `docker run --rm freqtradeorg/freqtrade:stable list-pairs --exchange binance --quote BTC --print-json`.  
-    This can be useful for fetching exchange information to add to your `config.json` without affecting your running containers.
-
-#### Example: Download data with docker
-
-Download backtesting data for 5 days for the pair ETH/BTC and 1h timeframe from Binance. The data will be stored in the directory `user_data/data/` on the host.
-
-``` bash
-docker compose run --rm freqtrade download-data --pairs ETH/BTC --exchange binance --days 5 -t 1h
-```
-
-Head over to the [Data Downloading Documentation](data-download.md) for more details on downloading data.
-
-#### Example: Backtest with docker
-
-Run backtesting in docker-containers for SampleStrategy and specified timerange of historical data, on 5m timeframe:
-
-``` bash
-docker compose run --rm freqtrade backtesting --config user_data/config.json --strategy SampleStrategy --timerange 20190801-20191001 -i 5m
-```
-
-Head over to the [Backtesting Documentation](backtesting.md) to learn more.
-
-### Additional dependencies with docker
-
-If your strategy requires dependencies not included in the default image - it will be necessary to build the image on your host.
-For this, please create a Dockerfile containing installation steps for the additional dependencies (have a look at [docker/Dockerfile.custom](https://github.com/freqtrade/freqtrade/blob/develop/docker/Dockerfile.custom) for an example).
-
-You'll then also need to modify the `docker-compose.yml` file and uncomment the build step, as well as rename the image to avoid naming collisions.
-
-``` yaml
-    image: freqtrade_custom
-    build:
-      context: .
-      dockerfile: "./Dockerfile.<yourextension>"
-```
-
-You can then run `docker compose build --pull` to build the docker image, and run it using the commands described above.
-
-### Plotting with docker
-
-Commands `freqtrade plot-profit` and `freqtrade plot-dataframe` ([Documentation](plotting.md)) are available by changing the image to `*_plot` in your `docker-compose.yml` file.
-You can then use these commands as follows:
-
-``` bash
-docker compose run --rm freqtrade plot-dataframe --strategy AwesomeStrategy -p BTC/ETH --timerange=20180801-20180805
-```
-
-The output will be stored in the `user_data/plot` directory, and can be opened with any modern browser.
-
-### Data analysis using docker compose
-
-Freqtrade provides a docker-compose file which starts up a jupyter lab server.
-You can run this server using the following command:
-
-``` bash
-docker compose -f docker/docker-compose-jupyter.yml up
-```
-
-This will create a docker-container running jupyter lab, which will be accessible using `https://127.0.0.1:8888/lab`.
-Please use the link that's printed in the console after startup for simplified login.
-
-Since part of this image is built on your machine, it is recommended to rebuild the image from time to time to keep freqtrade (and dependencies) up-to-date.
-
-``` bash
-docker compose -f docker/docker-compose-jupyter.yml build --no-cache
-```
-
-## Troubleshooting
-
-### Docker on Windows
-
-* Error: `"Timestamp for this request is outside of the recvWindow."`  
-  The market api requests require a synchronized clock but the time in the docker container shifts a bit over time into the past.
-  To fix this issue temporarily you need to run `wsl --shutdown` and restart docker again (a popup on windows 10 will ask you to do so).
-  A permanent solution is either to host the docker container on a linux host or restart the wsl from time to time with the scheduler.
-
-  ``` bash
-  taskkill /IM "Docker Desktop.exe" /F
-  wsl --shutdown
-  start "" "C:\Program Files\Docker\Docker\Docker Desktop.exe"
-  ```
-
-* Cannot connect to the API (Windows)  
-  If you're on windows and just installed Docker (desktop), make sure to reboot your System. Docker can have problems with network connectivity without a restart.
-  You should obviously also make sure to have your [settings](#accessing-the-ui) accordingly.
-
-!!! Warning
-    Due to the above, we do not recommend the usage of docker on windows for production setups, but only for experimentation, datadownload and backtesting.
-    Best use a linux-VPS for running freqtrade reliably.

docs/edge.md

@@ -1,357 +0,0 @@
-# Edge positioning
-
-The `Edge Positioning` module uses probability to calculate your win rate and risk reward ratio. It will use these statistics to control your strategy trade entry points, position size and, stoploss.
-
-!!! Danger "Deprecated functionality"
-    `Edge positioning` (or short Edge) is currently in maintenance mode only (we keep existing functionality alive) and should be considered as deprecated.
-    It will currently not receive new features until either someone stepped forward to take up ownership of that module - or we'll decide to remove edge from freqtrade.
-
-!!! Warning
-    When using `Edge positioning` with a dynamic whitelist (VolumePairList), make sure to also use `AgeFilter` and set it to at least `calculate_since_number_of_days` to avoid problems with missing data.
-
-!!! Note
-    `Edge Positioning` only considers *its own* buy/sell/stoploss signals. It ignores the stoploss, trailing stoploss, and ROI settings in the strategy configuration file.
-    `Edge Positioning` improves the performance of some trading strategies and *decreases* the performance of others.
-
-
-## Introduction
-
-Trading strategies are not perfect. They are frameworks that are susceptible to the market and its indicators. Because the market is not at all predictable, sometimes a strategy will win and sometimes the same strategy will lose.
-
-To obtain an edge in the market, a strategy has to make more money than it loses. Making money in trading is not only about *how often* the strategy makes or loses money.
-
-!!! tip "It doesn't matter how often, but how much!"
-    A bad strategy might make 1 penny in *ten* transactions but lose 1 dollar in *one* transaction. If one only checks the number of winning trades, it would be misleading to think that the strategy is actually making a profit.
-
-The Edge Positioning module seeks to improve a strategy's winning probability and the money that the strategy will make *on the long run*. 
-
-We raise the following question[^1]:
-
-!!! Question "Which trade is a better option?"
-    a) A trade with 80% of chance of losing 100\$ and 20% chance of winning 200\$<br/>
-    b) A trade with 100% of chance of losing 30\$
-
-???+ Info "Answer"
-    The expected value of *a)* is smaller than the expected value of *b)*.<br/>
-    Hence, *b*) represents a smaller loss in the long run.<br/>
-    However, the answer is: *it depends*
-
-Another way to look at it is to ask a similar question:
-
-!!! Question "Which trade is a better option?"
-    a) A trade with 80% of chance of winning 100\$ and 20% chance of losing 200\$<br/>
-    b) A trade with 100% of chance of winning 30\$
-
-Edge positioning tries to answer the hard questions about risk/reward and position size automatically, seeking to minimizes the chances of losing of a given strategy.
-
-### Trading, winning and losing
-
-Let's call $o$ the return of a single transaction $o$ where $o \in \mathbb{R}$. The collection $O = \{o_1, o_2, ..., o_N\}$ is the set of all returns of transactions made during a trading session. We say that $N$ is the cardinality of $O$, or, in lay terms, it is the number of transactions made in a trading session.
-
-!!! Example
-    In a session where a strategy made three transactions we can say that $O = \{3.5, -1, 15\}$. That means that $N = 3$ and $o_1 = 3.5$, $o_2 = -1$, $o_3 = 15$.
-
-A winning trade is a trade where a strategy *made* money. Making money means that the strategy closed the position in a value that returned a profit, after all deducted fees. Formally, a winning trade will have a return $o_i > 0$. Similarly, a losing trade will have a return $o_j \leq 0$. With that, we can discover the set of all winning trades, $T_{win}$, as follows:
-
-$$ T_{win} = \{ o \in O | o > 0 \} $$
-
-Similarly, we can discover the set of losing trades $T_{lose}$ as follows:
-
-$$ T_{lose} = \{o \in O | o \leq 0\} $$
-
-!!! Example
-    In a section where a strategy made four transactions $O = \{3.5, -1, 15, 0\}$:<br>
-    $T_{win} = \{3.5, 15\}$<br>
-    $T_{lose} = \{-1, 0\}$<br>
-
-### Win Rate and Lose Rate
-
-The win rate $W$ is the proportion of winning trades with respect to all the trades made by a strategy. We use the following function to compute the win rate:
-
-$$W = \frac{|T_{win}|}{N}$$
-
-Where $W$ is the win rate, $N$ is the number of trades and, $T_{win}$ is the set of all trades where the strategy made money.
-
-Similarly, we can compute the rate of losing trades:
-
-$$ 
-    L = \frac{|T_{lose}|}{N} 
-$$
-
-Where $L$ is the lose rate, $N$ is the amount of trades made and, $T_{lose}$ is the set of all trades where the strategy lost money. Note that the above formula is the same as calculating $L = 1 – W$ or $W = 1 – L$
-
-### Risk Reward Ratio
-
-Risk Reward Ratio ($R$) is a formula used to measure the expected gains of a given investment against the risk of loss. It is basically what you potentially win divided by what you potentially lose. Formally:
-
-$$ R = \frac{\text{potential_profit}}{\text{potential_loss}} $$
-
-???+ Example "Worked example of $R$ calculation"
-    Let's say that you think that the price of *stonecoin* today is 10.0\$. You believe that, because they will start mining stonecoin, it will go up to 15.0\$ tomorrow. There is the risk that the stone is too hard, and the GPUs can't mine it, so the price might go to 0\$ tomorrow. You are planning to invest 100\$, which will give you 10 shares (100 / 10).
-
-    Your potential profit is calculated as:
-
-    $\begin{aligned} 
-        \text{potential_profit} &= (\text{potential_price} - \text{entry_price}) * \frac{\text{investment}}{\text{entry_price}} \\
-                                &= (15 - 10) * (100 / 10) \\
-                                &= 50
-    \end{aligned}$
-
-    Since the price might go to 0\$, the 100\$ dollars invested could turn into 0.
-
-    We do however use a stoploss of 15% - so in the worst case, we'll sell 15% below entry price (or at 8.5$\).
-
-    $\begin{aligned}
-        \text{potential_loss} &= (\text{entry_price} - \text{stoploss}) * \frac{\text{investment}}{\text{entry_price}} \\
-                                &= (10 - 8.5) * (100 / 10)\\
-                                &= 15
-    \end{aligned}$
-
-    We can compute the Risk Reward Ratio as follows:
-
-    $\begin{aligned}
-        R   &= \frac{\text{potential_profit}}{\text{potential_loss}}\\
-            &= \frac{50}{15}\\
-            &= 3.33
-    \end{aligned}$<br>
-    What it effectively means is that the strategy have the potential to make 3.33\$ for each 1\$ invested.
-
-On a long horizon, that is, on many trades, we can calculate the risk reward by dividing the strategy' average profit on winning trades by the strategy' average loss on losing trades. We can calculate the average profit, $\mu_{win}$, as follows:
-
-$$ \text{average_profit} = \mu_{win} = \frac{\text{sum_of_profits}}{\text{count_winning_trades}} = \frac{\sum^{o \in T_{win}} o}{|T_{win}|} $$
-
-Similarly, we can calculate the average loss, $\mu_{lose}$, as follows:
-
-$$ \text{average_loss} = \mu_{lose} = \frac{\text{sum_of_losses}}{\text{count_losing_trades}} = \frac{\sum^{o \in T_{lose}} o}{|T_{lose}|} $$
-
-Finally, we can calculate the Risk Reward ratio, $R$, as follows:
-
-$$ R = \frac{\text{average_profit}}{\text{average_loss}} = \frac{\mu_{win}}{\mu_{lose}}\\ $$
-
-
-???+ Example "Worked example of $R$ calculation using mean profit/loss"
-    Let's say the strategy that we are using makes an average win $\mu_{win} = 2.06$ and an average loss $\mu_{loss} = 4.11$.<br>
-    We calculate the risk reward ratio as follows:<br>
-    $R = \frac{\mu_{win}}{\mu_{loss}} = \frac{2.06}{4.11} = 0.5012...$
-    
-
-### Expectancy
-
-By combining the Win Rate $W$ and the Risk Reward ratio $R$ to create an expectancy ratio $E$. A expectance ratio is the expected return of the investment made in a trade. We can compute the value of $E$ as follows:
-
-$$E = R * W - L$$
-
-!!! Example "Calculating $E$"
-    Let's say that a strategy has a win rate $W = 0.28$ and a risk reward ratio $R = 5$. What this means is that the strategy is expected to make 5 times the investment around on 28% of the trades it makes. Working out the example:<br>
-    $E = R * W - L = 5 * 0.28 - 0.72 = 0.68$
-    <br>
-
-The expectancy worked out in the example above means that, on average, this strategy' trades will return 1.68 times the size of its losses. Said another way, the strategy makes 1.68\$ for every 1\$ it loses, on average. 
-
-This is important for two reasons: First, it may seem obvious, but you know right away that you have a positive return. Second, you now have a number you can compare to other candidate systems to make decisions about which ones you employ.
-
-It is important to remember that any system with an expectancy greater than 0 is profitable using past data. The key is finding one that will be profitable in the future.
-
-You can also use this value to evaluate the effectiveness of modifications to this system.
-
-!!! Note
-    It's important to keep in mind that Edge is testing your expectancy using historical data, there's no guarantee that you will have a similar edge in the future. It's still vital to do this testing in order to build confidence in your methodology but be wary of "curve-fitting" your approach to the historical data as things are unlikely to play out the exact same way for future trades.
-
-## How does it work?
-
-Edge combines dynamic stoploss, dynamic positions, and whitelist generation into one isolated module which is then applied to the trading strategy. If enabled in config, Edge will go through historical data with a range of stoplosses in order to find buy and sell/stoploss signals. It then calculates win rate and expectancy over *N* trades for each stoploss. Here is an example:
-
-| Pair   |      Stoploss      |  Win Rate | Risk Reward Ratio | Expectancy |
-|----------|:-------------:|-------------:|------------------:|-----------:|
-| XZC/ETH  |  -0.01        |   0.50       |1.176384           | 0.088      |
-| XZC/ETH  |  -0.02        |   0.51       |1.115941           | 0.079      |
-| XZC/ETH  |  -0.03        |   0.52       |1.359670           | 0.228      |
-| XZC/ETH  |  -0.04        |   0.51       |1.234539           | 0.117      |
-
-The goal here is to find the best stoploss for the strategy in order to have the maximum expectancy. In the above example stoploss at $3%$ leads to the maximum expectancy according to historical data.
-
-Edge module then forces stoploss value it evaluated to your strategy dynamically.
-
-### Position size
-
-Edge dictates the amount at stake for each trade to the bot according to the following factors:
-
-- Allowed capital at risk
-- Stoploss
-
-Allowed capital at risk is calculated as follows:
-
-```
-Allowed capital at risk = (Capital available_percentage) X (Allowed risk per trade)
-```
-
-Stoploss is calculated as described above with respect to historical data.
-
-The position size is calculated as follows:
-
-```
-Position size = (Allowed capital at risk) / Stoploss
-```
-
-Example:
-
-Let's say the stake currency is **ETH** and there is $10$ **ETH** on the wallet. The capital available percentage is $50%$ and the allowed risk per trade is $1\%$. Thus, the available capital for trading is $10 * 0.5 = 5$ **ETH** and the allowed capital at risk would be $5 * 0.01 = 0.05$ **ETH**.
-
--   **Trade 1:** The strategy detects a new buy signal in the **XLM/ETH** market. `Edge Positioning` calculates a stoploss of $2\%$ and a position of $0.05 / 0.02 = 2.5$ **ETH**. The bot takes a position of $2.5$ **ETH** in the **XLM/ETH** market.
-
--   **Trade 2:** The strategy detects a buy signal on the **BTC/ETH** market while **Trade 1** is still open. `Edge Positioning` calculates the stoploss of $4\%$ on this market. Thus, **Trade 2** position size is $0.05 / 0.04 = 1.25$ **ETH**.
-
-!!! Tip "Available Capital $\neq$ Available in wallet"
-    The available capital for trading didn't change in **Trade 2** even with **Trade 1** still open. The available capital **is not** the free amount in the wallet.
-
--   **Trade 3:** The strategy detects a buy signal in the **ADA/ETH** market. `Edge Positioning` calculates a stoploss of $1\%$ and a position of $0.05 / 0.01 = 5$ **ETH**. Since **Trade 1** has $2.5$ **ETH** blocked and **Trade 2** has $1.25$ **ETH** blocked, there is only $5 - 1.25 - 2.5 = 1.25$ **ETH** available. Hence, the position size of **Trade 3** is $1.25$ **ETH**. 
-
-!!! Tip "Available Capital Updates"
-    The available capital does not change before a position is sold. After a trade is closed the Available Capital goes up if the trade was profitable or goes down if the trade was a loss.
-
--   The strategy detects a sell signal in the **XLM/ETH** market. The bot exits **Trade 1** for a profit of $1$ **ETH**. The total capital in the wallet becomes $11$ **ETH** and the available capital for trading becomes $5.5$ **ETH**.
-
--   **Trade 4** The strategy detects a new buy signal int the **XLM/ETH** market. `Edge Positioning` calculates the stoploss of $2\%$, and the position size of $0.055 / 0.02 = 2.75$ **ETH**.
-
-## Edge command reference
-
-```
-usage: freqtrade edge [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH]
-                      [--userdir PATH] [-s NAME] [--strategy-path PATH]
-                      [-i TIMEFRAME] [--timerange TIMERANGE]
-                      [--data-format-ohlcv {json,jsongz,hdf5}]
-                      [--max-open-trades INT] [--stake-amount STAKE_AMOUNT]
-                      [--fee FLOAT] [-p PAIRS [PAIRS ...]]
-                      [--stoplosses STOPLOSS_RANGE]
-
-optional arguments:
-  -h, --help            show this help message and exit
-  -i TIMEFRAME, --timeframe TIMEFRAME
-                        Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
-  --timerange TIMERANGE
-                        Specify what timerange of data to use.
-  --data-format-ohlcv {json,jsongz,hdf5}
-                        Storage format for downloaded candle (OHLCV) data.
-                        (default: `None`).
-  --max-open-trades INT
-                        Override the value of the `max_open_trades`
-                        configuration setting.
-  --stake-amount STAKE_AMOUNT
-                        Override the value of the `stake_amount` configuration
-                        setting.
-  --fee FLOAT           Specify fee ratio. Will be applied twice (on trade
-                        entry and exit).
-  -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
-                        Limit command to these pairs. Pairs are space-
-                        separated.
-  --stoplosses STOPLOSS_RANGE
-                        Defines a range of stoploss values against which edge
-                        will assess the strategy. The format is "min,max,step"
-                        (without any space). Example:
-                        `--stoplosses=-0.01,-0.1,-0.001`
-
-Common arguments:
-  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
-  --logfile FILE        Log to the file specified. Special values are:
-                        'syslog', 'journald'. See the documentation for more
-                        details.
-  -V, --version         show program's version number and exit
-  -c PATH, --config PATH
-                        Specify configuration file (default:
-                        `userdir/config.json` or `config.json` whichever
-                        exists). Multiple --config options may be used. Can be
-                        set to `-` to read config from stdin.
-  -d PATH, --datadir PATH
-                        Path to directory with historical backtesting data.
-  --userdir PATH, --user-data-dir PATH
-                        Path to userdata directory.
-
-Strategy arguments:
-  -s NAME, --strategy NAME
-                        Specify strategy class name which will be used by the
-                        bot.
-  --strategy-path PATH  Specify additional strategy lookup path.
-
-```
-
-## Configurations
-
-Edge module has following configuration options:
-
-|  Parameter | Description |
-|------------|-------------|
-| `enabled` | If true, then Edge will run periodically. <br>*Defaults to `false`.* <br> **Datatype:** Boolean
-| `process_throttle_secs` | How often should Edge run in seconds. <br>*Defaults to `3600` (once per hour).* <br> **Datatype:** Integer
-| `calculate_since_number_of_days` | Number of days of data against which Edge calculates Win Rate, Risk Reward and Expectancy. <br> **Note** that it downloads historical data so increasing this number would lead to slowing down the bot. <br>*Defaults to `7`.* <br> **Datatype:** Integer
-| `allowed_risk` | Ratio of allowed risk per trade. <br>*Defaults to `0.01` (1%)).* <br> **Datatype:** Float
-| `stoploss_range_min` | Minimum stoploss. <br>*Defaults to `-0.01`.* <br> **Datatype:** Float
-| `stoploss_range_max` | Maximum stoploss. <br>*Defaults to `-0.10`.* <br> **Datatype:** Float
-| `stoploss_range_step` | As an example if this is set to -0.01 then Edge will test the strategy for `[-0.01, -0,02, -0,03 ..., -0.09, -0.10]` ranges. <br> **Note** than having a smaller step means having a bigger range which could lead to slow calculation. <br> If you set this parameter to -0.001, you then slow down the Edge calculation by a factor of 10. <br>*Defaults to `-0.001`.* <br> **Datatype:** Float
-| `minimum_winrate` | It filters out pairs which don't have at least minimum_winrate. <br>This comes handy if you want to be conservative and don't comprise win rate in favour of risk reward ratio. <br>*Defaults to `0.60`.* <br> **Datatype:** Float
-| `minimum_expectancy` | It filters out pairs which have the expectancy lower than this number. <br>Having an expectancy of 0.20 means if you put 10\$ on a trade you expect a 12\$ return. <br>*Defaults to `0.20`.* <br> **Datatype:** Float
-| `min_trade_number` | When calculating *W*, *R* and *E* (expectancy) against historical data, you always want to have a minimum number of trades. The more this number is the more Edge is reliable. <br>Having a win rate of 100% on a single trade doesn't mean anything at all. But having a win rate of 70% over past 100 trades means clearly something. <br>*Defaults to `10` (it is highly recommended not to decrease this number).* <br> **Datatype:** Integer
-| `max_trade_duration_minute` | Edge will filter out trades with long duration. If a trade is profitable after 1 month, it is hard to evaluate the strategy based on it. But if most of trades are profitable and they have maximum duration of 30 minutes, then it is clearly a good sign.<br>**NOTICE:** While configuring this value, you should take into consideration your timeframe. As an example filtering out trades having duration less than one day for a strategy which has 4h interval does not make sense. Default value is set assuming your strategy interval is relatively small (1m or 5m, etc.).<br>*Defaults to `1440` (one day).* <br> **Datatype:** Integer
-| `remove_pumps` | Edge will remove sudden pumps in a given market while going through historical data. However, given that pumps happen very often in crypto markets, we recommend you keep this off.<br>*Defaults to `false`.* <br> **Datatype:** Boolean
-
-## Running Edge independently
-
-You can run Edge independently in order to see in details the result. Here is an example:
-
-``` bash
-freqtrade edge
-```
-
-An example of its output:
-
-| **pair**     |   **stoploss** |   **win rate** |   **risk reward ratio** |   **required risk reward** |   **expectancy** |   **total number of trades** |   **average duration (min)** |
-|:----------|-----------:|-----------:|--------------------:|-----------------------:|-------------:|-----------------:|---------------:|
-| **AGI/BTC**   |      -0.02 |       0.64 |                5.86 |                   0.56 |         3.41 |                       14 |                       54 |
-| **NXS/BTC**   |      -0.03 |       0.64 |                2.99 |                   0.57 |         1.54 |                       11 |                       26 |
-| **LEND/BTC**  |      -0.02 |       0.82 |                2.05 |                   0.22 |         1.50 |                       11 |                       36 |
-| **VIA/BTC**   |      -0.01 |       0.55 |                3.01 |                   0.83 |         1.19 |                       11 |                       48 |
-| **MTH/BTC**   |      -0.09 |       0.56 |                2.82 |                   0.80 |         1.12 |                       18 |                       52 |
-| **ARDR/BTC**  |      -0.04 |       0.42 |                3.14 |                   1.40 |         0.73 |                       12 |                       42 |
-| **BCPT/BTC**  |      -0.01 |       0.71 |                1.34 |                   0.40 |         0.67 |                       14 |                       30 |
-| **WINGS/BTC** |      -0.02 |       0.56 |                1.97 |                   0.80 |         0.65 |                       27 |                       42 |
-| **VIBE/BTC**  |      -0.02 |       0.83 |                0.91 |                   0.20 |         0.59 |                       12 |                       35 |
-| **MCO/BTC**   |      -0.02 |       0.79 |                0.97 |                   0.27 |         0.55 |                       14 |                       31 |
-| **GNT/BTC**   |      -0.02 |       0.50 |                2.06 |                   1.00 |         0.53 |                       18 |                       24 |
-| **HOT/BTC**   |      -0.01 |       0.17 |                7.72 |                   4.81 |         0.50 |                      209 |                        7 |
-| **SNM/BTC**   |      -0.03 |       0.71 |                1.06 |                   0.42 |         0.45 |                       17 |                       38 |
-| **APPC/BTC**  |      -0.02 |       0.44 |                2.28 |                   1.27 |         0.44 |                       25 |                       43 |
-| **NEBL/BTC**  |      -0.03 |       0.63 |                1.29 |                   0.58 |         0.44 |                       19 |                       59 |
-
-Edge produced the above table by comparing `calculate_since_number_of_days` to `minimum_expectancy` to find `min_trade_number` historical information based on the config file. The timerange Edge uses for its comparisons can be further limited by using the `--timerange` switch.
-
-In live and dry-run modes, after the `process_throttle_secs` has passed, Edge will again process `calculate_since_number_of_days` against `minimum_expectancy` to find `min_trade_number`. If no `min_trade_number` is found, the bot will return "whitelist empty". Depending on the trade strategy being deployed, "whitelist empty" may be return much of the time - or *all* of the time. The use of Edge may also cause trading to occur in bursts, though this is rare.
-
-If you encounter "whitelist empty" a lot, condsider tuning `calculate_since_number_of_days`, `minimum_expectancy`  and `min_trade_number` to align to the trading frequency of your strategy.
-
-### Update cached pairs with the latest data
-
-Edge requires historic data the same way as backtesting does.
-Please refer to the [Data Downloading](data-download.md) section of the documentation for details.
-
-### Precising stoploss range
-
-```bash
-freqtrade edge --stoplosses=-0.01,-0.1,-0.001 #min,max,step
-```
-
-### Advanced use of timerange
-
-```bash
-freqtrade edge --timerange=20181110-20181113
-```
-
-Doing `--timerange=-20190901` will get all available data until September 1st (excluding September 1st 2019).
-
-The full timerange specification:
-
-* Use tickframes till 2018/01/31: `--timerange=-20180131`
-* Use tickframes since 2018/01/31: `--timerange=20180131-`
-* Use tickframes since 2018/01/31 till 2018/03/01 : `--timerange=20180131-20180301`
-* Use tickframes between POSIX timestamps 1527595200 1527618600: `--timerange=1527595200-1527618600`
-
-
-[^1]: Question extracted from MIT Opencourseware S096 - Mathematics with applications in Finance: https://ocw.mit.edu/courses/mathematics/18-s096-topics-in-mathematics-with-applications-in-finance-fall-2013/

docs/exchanges.md

@@ -1,341 +0,0 @@
-# Exchange-specific Notes
-
-This page combines common gotchas and Information which are exchange-specific and most likely don't apply to other exchanges.
-
-## Exchange configuration
-
-Freqtrade is based on [CCXT library](https://github.com/ccxt/ccxt) that supports over 100 cryptocurrency
-exchange markets and trading APIs. The complete up-to-date list can be found in the
-[CCXT repo homepage](https://github.com/ccxt/ccxt/tree/master/python).
-However, the bot was tested by the development team with only a few exchanges.
-A current list of these can be found in the "Home" section of this documentation.
-
-Feel free to test other exchanges and submit your feedback or PR to improve the bot or confirm exchanges that work flawlessly..
-
-Some exchanges require special configuration, which can be found below.
-
-### Sample exchange configuration
-
-A exchange configuration for "binance" would look as follows:
-
-```json
-"exchange": {
-    "name": "binance",
-    "key": "your_exchange_key",
-    "secret": "your_exchange_secret",
-    "ccxt_config": {},
-    "ccxt_async_config": {},
-    // ... 
-```
-
-### Setting rate limits
-
-Usually, rate limits set by CCXT are reliable and work well.
-In case of problems related to rate-limits (usually DDOS Exceptions in your logs), it's easy to change rateLimit settings to other values.
-
-```json
-"exchange": {
-    "name": "kraken",
-    "key": "your_exchange_key",
-    "secret": "your_exchange_secret",
-    "ccxt_config": {"enableRateLimit": true},
-    "ccxt_async_config": {
-        "enableRateLimit": true,
-        "rateLimit": 3100
-    },
-```
-
-This configuration enables kraken, as well as rate-limiting to avoid bans from the exchange.
-`"rateLimit": 3100` defines a wait-event of 3.1s between each call. This can also be completely disabled by setting `"enableRateLimit"` to false.
-
-!!! Note
-    Optimal settings for rate-limiting depend on the exchange and the size of the whitelist, so an ideal parameter will vary on many other settings.
-    We try to provide sensible defaults per exchange where possible, if you encounter bans please make sure that `"enableRateLimit"` is enabled and increase the `"rateLimit"` parameter step by step.
-
-## Binance
-
-!!! Warning "Server location and geo-ip restrictions"
-    Please be aware that Binance restricts API access regarding the server country. The current and non-exhaustive countries blocked are Canada, Malaysia, Netherlands and United States. Please go to [binance terms > b. Eligibility](https://www.binance.com/en/terms) to find up to date list.
-
-Binance supports [time_in_force](configuration.md#understand-order_time_in_force).
-
-!!! Tip "Stoploss on Exchange"
-    Binance supports `stoploss_on_exchange` and uses `stop-loss-limit` orders. It provides great advantages, so we recommend to benefit from it by enabling stoploss on exchange.
-    On futures, Binance supports both `stop-limit` as well as `stop-market` orders. You can use either `"limit"` or `"market"` in the `order_types.stoploss` configuration setting to decide which type to use.
-
-### Binance Blacklist recommendation
-
-For Binance, it is suggested to add `"BNB/<STAKE>"` to your blacklist to avoid issues, unless you are willing to maintain enough extra `BNB` on the account or unless you're willing to disable using `BNB` for fees.
-Binance accounts may use `BNB` for fees, and if a trade happens to be on `BNB`, further trades may consume this position and make the initial BNB trade unsellable as the expected amount is not there anymore.
-
-If not enough `BNB` is available to cover transaction fees, then fees will not be covered by `BNB` and no fee reduction will occur. Freqtrade will never buy BNB to cover for fees. BNB needs to be bought and monitored manually to this end.
-
-### Binance sites
-
-Binance has been split into 2, and users must use the correct ccxt exchange ID for their exchange, otherwise API keys are not recognized.
-
-* [binance.com](https://www.binance.com/) - International users. Use exchange id: `binance`.
-* [binance.us](https://www.binance.us/) - US based users. Use exchange id: `binanceus`.
-
-### Binance RSA keys
-
-Freqtrade supports binance RSA API keys.
-
-We recommend to use them as environment variable.
-
-``` bash
-export FREQTRADE__EXCHANGE__SECRET="$(cat ./rsa_binance.private)"
-```
-
-They can however also be configured via configuration file. Since json doesn't support multi-line strings, you'll have to replace all newlines with `\n` to have a valid json file.
-
-``` json
-// ...
- "key": "<someapikey>",
- "secret": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBABACAFQA<...>s8KX8=\n-----END PRIVATE KEY-----"
-// ...
-```
-
-### Binance Futures
-
-Binance has specific (unfortunately complex) [Futures Trading Quantitative Rules](https://www.binance.com/en/support/faq/4f462ebe6ff445d4a170be7d9e897272) which need to be followed, and which prohibit a too low stake-amount (among others) for too many orders.
-Violating these rules will result in a trading restriction.
-
-When trading on Binance Futures market, orderbook must be used because there is no price ticker data for futures.
-
-``` jsonc
-  "entry_pricing": {
-      "use_order_book": true,
-      "order_book_top": 1,
-      "check_depth_of_market": {
-          "enabled": false,
-          "bids_to_ask_delta": 1
-      }
-  },
-  "exit_pricing": {
-      "use_order_book": true,
-      "order_book_top": 1
-  },
-```
-
-#### Binance futures settings
-
-Users will also have to have the futures-setting "Position Mode" set to "One-way Mode", and "Asset Mode" set to "Single-Asset Mode".
-These settings will be checked on startup, and freqtrade will show an error if this setting is wrong.
-
-![Binance futures settings](assets/binance_futures_settings.png)
-
-Freqtrade will not attempt to change these settings.
-
-## Bingx
-
-BingX supports [time_in_force](configuration.md#understand-order_time_in_force) with settings "GTC" (good till cancelled), "IOC" (immediate-or-cancel) and "PO" (Post only) settings.
-
-!!! Tip "Stoploss on Exchange"
-    Bingx supports `stoploss_on_exchange` and can use both stop-limit and stop-market orders. It provides great advantages, so we recommend to benefit from it by enabling stoploss on exchange.
-
-## Kraken
-
-Kraken supports [time_in_force](configuration.md#understand-order_time_in_force) with settings "GTC" (good till cancelled), "IOC" (immediate-or-cancel) and "PO" (Post only) settings.
-
-!!! Tip "Stoploss on Exchange"
-    Kraken supports `stoploss_on_exchange` and can use both stop-loss-market and stop-loss-limit orders. It provides great advantages, so we recommend to benefit from it.
-    You can use either `"limit"` or `"market"` in the `order_types.stoploss` configuration setting to decide which type to use.
-
-### Historic Kraken data
-
-The Kraken API does only provide 720 historic candles, which is sufficient for Freqtrade dry-run and live trade modes, but is a problem for backtesting.
-To download data for the Kraken exchange, using `--dl-trades` is mandatory, otherwise the bot will download the same 720 candles over and over, and you'll not have enough backtest data.
-
-To speed up downloading, you can download the [trades zip files](https://support.kraken.com/hc/en-us/articles/360047543791-Downloadable-historical-market-data-time-and-sales-) kraken provides.
-These are usually updated once per quarter. Freqtrade expects these files to be placed in `user_data/data/kraken/trades_csv`.
-
-A structure as follows can make sense if using incremental files, with the "full" history in one directory, and incremental files in different directories.
-The assumption for this mode is that the data is downloaded and unzipped keeping filenames as they are.
-Duplicate content will be ignored (based on timestamp) - though the assumption is that there is no gap in the data.
-
-This means, if your "full" history ends in Q4 2022 - then both incremental updates Q1 2023 and Q2 2023 are available.
-Not having this will lead to incomplete data, and therefore invalid results while using the data.
-
-```
-└── trades_csv
-    ├── Kraken_full_history
-    │   ├── BCHEUR.csv
-    │   └── XBTEUR.csv
-    ├── Kraken_Trading_History_Q1_2023
-    │   ├── BCHEUR.csv
-    │   └── XBTEUR.csv
-    └── Kraken_Trading_History_Q2_2023
-        ├── BCHEUR.csv
-        └── XBTEUR.csv
-```
-
-You can convert these files into freqtrade files:
-
-``` bash
-freqtrade convert-trade-data --exchange kraken --format-from kraken_csv --format-to feather
-# Convert trade data to different ohlcv timeframes
-freqtrade trades-to-ohlcv -p BTC/EUR BCH/EUR --exchange kraken -t 1m 5m 15m 1h
-```
-
-The converted data also makes downloading data possible, and will start the download after the latest loaded trade.
-
-``` bash
-freqtrade download-data --exchange kraken --dl-trades -p BTC/EUR BCH/EUR 
-```
-
-!!! Warning "Downloading data from kraken"
-    Downloading kraken data will require significantly more memory (RAM) than any other exchange, as the trades-data needs to be converted into candles on your machine.
-    It will also take a long time, as freqtrade will need to download every single trade that happened on the exchange for the pair / timerange combination, therefore please be patient.
-
-!!! Warning "rateLimit tuning"
-    Please pay attention that rateLimit configuration entry holds delay in milliseconds between requests, NOT requests\sec rate.
-    So, in order to mitigate Kraken API "Rate limit exceeded" exception, this configuration should be increased, NOT decreased.
-
-## Kucoin
-
-Kucoin requires a passphrase for each api key, you will therefore need to add this key into the configuration so your exchange section looks as follows:
-
-```json
-"exchange": {
-    "name": "kucoin",
-    "key": "your_exchange_key",
-    "secret": "your_exchange_secret",
-    "password": "your_exchange_api_key_password",
-    // ...
-}
-```
-
-Kucoin supports [time_in_force](configuration.md#understand-order_time_in_force).
-
-!!! Tip "Stoploss on Exchange"
-    Kucoin supports `stoploss_on_exchange` and can use both stop-loss-market and stop-loss-limit orders. It provides great advantages, so we recommend to benefit from it.
-    You can use either `"limit"` or `"market"` in the `order_types.stoploss` configuration setting to decide which type of stoploss shall be used.
-
-### Kucoin Blacklists
-
-For Kucoin, it is suggested to add `"KCS/<STAKE>"` to your blacklist to avoid issues, unless you are willing to maintain enough extra `KCS` on the account or unless you're willing to disable using `KCS` for fees. 
-Kucoin accounts may use `KCS` for fees, and if a trade happens to be on `KCS`, further trades may consume this position and make the initial `KCS` trade unsellable as the expected amount is not there anymore.
-
-## HTX (formerly Huobi)
-
-!!! Tip "Stoploss on Exchange"
-    HTX supports `stoploss_on_exchange` and uses `stop-limit` orders. It provides great advantages, so we recommend to benefit from it by enabling stoploss on exchange.
-
-## OKX (former OKEX)
-
-OKX requires a passphrase for each api key, you will therefore need to add this key into the configuration so your exchange section looks as follows:
-
-```json
-"exchange": {
-    "name": "okx",
-    "key": "your_exchange_key",
-    "secret": "your_exchange_secret",
-    "password": "your_exchange_api_key_password",
-    // ...
-}
-```
-
-!!! Warning
-    OKX only provides 100 candles per api call. Therefore, the strategy will only have a pretty low amount of data available in backtesting mode.
-
-!!! Warning "Futures"
-    OKX Futures has the concept of "position mode" - which can be "Buy/Sell" or long/short (hedge mode).
-    Freqtrade supports both modes (we recommend to use Buy/Sell mode) - but changing the mode mid-trading is not supported and will lead to exceptions and failures to place trades.
-    OKX also only provides MARK candles for the past ~3 months. Backtesting futures prior to that date will therefore lead to slight deviations, as funding-fees cannot be calculated correctly without this data.
-
-## Gate.io
-
-!!! Tip "Stoploss on Exchange"
-    Gate.io supports `stoploss_on_exchange` and uses `stop-loss-limit` orders. It provides great advantages, so we recommend to benefit from it by enabling stoploss on exchange..
-
-Gate.io allows the use of `POINT` to pay for fees. As this is not a tradable currency (no regular market available), automatic fee calculations will fail (and default to a fee of 0).
-The configuration parameter `exchange.unknown_fee_rate` can be used to specify the exchange rate between Point and the stake currency. Obviously, changing the stake-currency will also require changes to this value.
-
-## Bybit
-
-Futures trading on bybit is currently supported for USDT markets, and will use isolated futures mode.
-
-On startup, freqtrade will set the position mode to "One-way Mode" for the whole (sub)account. This avoids making this call over and over again (slowing down bot operations), but means that changes to this setting may result in exceptions and errors.
-
-As bybit doesn't provide funding rate history, the dry-run calculation is used for live trades as well.
-
-API Keys for live futures trading must have the following permissions:
-* Read-write
-* Contract - Orders
-* Contract - Positions
-
-We do strongly recommend to limit all API keys to the IP you're going to use it from.
-
-!!! Warning "Unified accounts"
-    Freqtrade assumes accounts to be dedicated to the bot.
-    We therefore recommend the usage of one subaccount per bot. This is especially important when using unified accounts.  
-    Other configurations (multiple bots on one account, manual non-bot trades on the bot account) are not supported and may lead to unexpected behavior.
-
-
-!!! Tip "Stoploss on Exchange"
-    Bybit (futures only) supports `stoploss_on_exchange` and uses `stop-loss-limit` orders. It provides great advantages, so we recommend to benefit from it by enabling stoploss on exchange.
-    On futures, Bybit supports both `stop-limit` as well as `stop-market` orders. You can use either `"limit"` or `"market"` in the `order_types.stoploss` configuration setting to decide which type to use.
-
-## Bitmart
-
-Bitmart requires the API key Memo (the name you give the API key) to go along with the exchange key and secret.
-It's therefore required to pass the UID as well.
-
-```json
-"exchange": {
-    "name": "bitmart",
-    "uid": "your_bitmart_api_key_memo",
-    "secret": "your_exchange_secret",
-    "password": "your_exchange_api_key_password",
-    // ...
-}
-```
-
-!!! Warning "Necessary Verification"
-    Bitmart requires Verification Lvl2 to successfully trade on the spot market through the API - even though trading via UI works just fine with just Lvl1 verification.
-
-## All exchanges
-
-Should you experience constant errors with Nonce (like `InvalidNonce`), it is best to regenerate the API keys. Resetting Nonce is difficult and it's usually easier to regenerate the API keys.
-
-## Random notes for other exchanges
-
-* The Ocean (exchange id: `theocean`) exchange uses Web3 functionality and requires `web3` python package to be installed:
-
-```shell
-$ pip3 install web3
-```
-
-### Getting latest price / Incomplete candles
-
-Most exchanges return current incomplete candle via their OHLCV/klines API interface.
-By default, Freqtrade assumes that incomplete candle is fetched from the exchange and removes the last candle assuming it's the incomplete candle.
-
-Whether your exchange returns incomplete candles or not can be checked using [the helper script](developer.md#incomplete-candles) from the Contributor documentation.
-
-Due to the danger of repainting, Freqtrade does not allow you to use this incomplete candle.
-
-However, if it is based on the need for the latest price for your strategy - then this requirement can be acquired using the [data provider](strategy-customization.md#possible-options-for-dataprovider) from within the strategy.
-
-### Advanced Freqtrade Exchange configuration
-
-Advanced options can be configured using the `_ft_has_params` setting, which will override Defaults and exchange-specific behavior.
-
-Available options are listed in the exchange-class as `_ft_has_default`.
-
-For example, to test the order type `FOK` with Kraken, and modify candle limit to 200 (so you only get 200 candles per API call):
-
-```json
-"exchange": {
-    "name": "kraken",
-    "_ft_has_params": {
-        "order_time_in_force": ["GTC", "FOK"],
-        "ohlcv_candle_limit": 200
-        }
-    //...
-}
-```
-
-!!! Warning
-    Please make sure to fully understand the impacts of these settings before modifying them.

docs/faq.md

@@ -1,282 +0,0 @@
-# Freqtrade FAQ
-
-## Supported Markets
-
-Freqtrade supports spot trading, as well as (isolated) futures trading for some selected exchanges. Please refer to the [documentation start page](index.md#supported-futures-exchanges-experimental) for an up-to-date list of supported exchanges.
-
-### Can my bot open short positions?
-
-Freqtrade can open short positions in futures markets.
-This requires the strategy to be made for this - and `"trading_mode": "futures"` in the configuration.
-Please make sure to read the [relevant documentation page](leverage.md) first.
-
-In spot markets, you can in some cases use leveraged spot tokens, which reflect an inverted pair (eg. BTCUP/USD, BTCDOWN/USD, ETHBULL/USD, ETHBEAR/USD,...) which can be traded with Freqtrade.
-
-### Can my bot trade options or futures?
-
-Futures trading is supported for selected exchanges. Please refer to the [documentation start page](index.md#supported-futures-exchanges-experimental) for an up-to-date list of supported exchanges.
-
-## Beginner Tips & Tricks
-
-* When you work with your strategy & hyperopt file you should use a proper code editor like VSCode or PyCharm. A good code editor will provide syntax highlighting as well as line numbers, making it easy to find syntax errors (most likely pointed out by Freqtrade during startup).
-
-## Freqtrade common questions
-
-### Can freqtrade open multiple positions on the same pair in parallel?
-
-No. Freqtrade will only open one position per pair at a time.
-You can however use the [`adjust_trade_position()` callback](strategy-callbacks.md#adjust-trade-position) to adjust an open position.
-
-Backtesting provides an option for this in `--eps` - however this is only there to highlight "hidden" signals, and will not work in live.
-
-### The bot does not start
-
-Running the bot with `freqtrade trade --config config.json` shows the output `freqtrade: command not found`.
-
-This could be caused by the following reasons:
-
-* The virtual environment is not active.
-  * Run `source .venv/bin/activate` to activate the virtual environment.
-* The installation did not complete successfully.
-  * Please check the [Installation documentation](installation.md).
-
-### I have waited 5 minutes, why hasn't the bot made any trades yet?
-
-* Depending on the buy strategy, the amount of whitelisted coins, the
-situation of the market etc, it can take up to hours to find a good entry
-position for a trade. Be patient!
-
-* It may be because of a configuration error. It's best to check the logs, they usually tell you if the bot is simply not getting buy signals (only heartbeat messages), or if there is something wrong (errors / exceptions in the log).
-
-### I have made 12 trades already, why is my total profit negative?
-
-I understand your disappointment but unfortunately 12 trades is just
-not enough to say anything. If you run backtesting, you can see that the
-current algorithm does leave you on the plus side, but that is after
-thousands of trades and even there, you will be left with losses on
-specific coins that you have traded tens if not hundreds of times. We
-of course constantly aim to improve the bot but it will _always_ be a
-gamble, which should leave you with modest wins on monthly basis but
-you can't say much from few trades.
-
-### I’d like to make changes to the config. Can I do that without having to kill the bot?
-
-Yes. You can edit your config and use the `/reload_config` command to reload the configuration. The bot will stop, reload the configuration and strategy and will restart with the new configuration and strategy.
-
-### Why does my bot not sell everything it bought?
-
-This is called "coin dust" and can happen on all exchanges.
-It happens because many exchanges subtract fees from the "receiving currency" - so you buy 100 COIN - but you only get 99.9 COIN.
-As COIN is trading in full lot sizes (1COIN steps), you cannot sell 0.9 COIN (or 99.9 COIN) - but you need to round down to 99 COIN.
-
-This is not a bot-problem, but will also happen while manual trading.
-
-While freqtrade can handle this (it'll sell 99 COIN), fees are often below the minimum tradable lot-size (you can only trade full COIN, not 0.9 COIN).
-Leaving the dust (0.9 COIN) on the exchange makes usually sense, as the next time freqtrade buys COIN, it'll eat into the remaining small balance, this time selling everything it bought, and therefore slowly declining the dust balance (although it most likely will never reach exactly 0).
-
-Where possible (e.g. on binance), the use of the exchange's dedicated fee currency will fix this.
-On binance, it's sufficient to have BNB in your account, and have "Pay fees in BNB" enabled in your profile. Your BNB balance will slowly decline (as it's used to pay fees) - but you'll no longer encounter dust (Freqtrade will include the fees in the profit calculations).
-Other exchanges don't offer such possibilities, where it's simply something you'll have to accept or move to a different exchange.
-
-### I deposited more funds to the exchange, but my bot doesn't recognize this
-
-Freqtrade will update the exchange balance when necessary (Before placing an order).
-RPC calls (Telegram's `/balance`, API calls to `/balance`) can trigger an update at max. once per hour.
-
-If `adjust_trade_position` is enabled (and the bot has open trades eligible for position adjustments) - then the wallets will be refreshed once per hour.
-To force an immediate update, you can use `/reload_config` - which will restart the bot.
-
-### I want to use incomplete candles
-
-Freqtrade will not provide incomplete candles to strategies. Using incomplete candles will lead to repainting and consequently to strategies with "ghost" buys, which are impossible to both backtest, and verify after they happened.
-
-You can use "current" market data by using the [dataprovider](strategy-customization.md#orderbookpair-maximum)'s orderbook or ticker methods - which however cannot be used during backtesting.
-
-### Is there a setting to only Exit the trades being held and not perform any new Entries?
-
-You can use the `/stopentry` command in Telegram to prevent future trade entry, followed by `/forceexit all` (sell all open trades).
-
-### I want to run multiple bots on the same machine
-
-Please look at the [advanced setup documentation Page](advanced-setup.md#running-multiple-instances-of-freqtrade).
-
-### I'm getting "Missing data fillup" messages in the log
-
-This message is just a warning that the latest candles had missing candles in them.
-Depending on the exchange, this can indicate that the pair didn't have a trade for the timeframe you are using - and the exchange does only return candles with volume.
-On low volume pairs, this is a rather common occurrence.
-
-If this happens for all pairs in the pairlist, this might indicate a recent exchange downtime. Please check your exchange's public channels for details.
-
-Irrespectively of the reason, Freqtrade will fill up these candles with "empty" candles, where open, high, low and close are set to the previous candle close - and volume is empty. In a chart, this will look like a `_` - and is aligned with how exchanges usually represent 0 volume candles.
-
-### I'm getting "Price jump between 2 candles detected"
-
-This message is a warning that the candles had a price jump of > 30%.
-This might be a sign that the pair stopped trading, and some token exchange took place (e.g. COCOS in 2021 - where price jumped from 0.0000154 to 0.01621).
-This message is often accompanied by ["Missing data fillup"](#im-getting-missing-data-fillup-messages-in-the-log) - as trading on such pairs is often stopped for some time.
-
-### I'm getting "Outdated history for pair xxx" in the log
-
-The bot is trying to tell you that it got an outdated last candle (not the last complete candle).
-As a consequence, Freqtrade will not enter a trade for this pair - as trading on old information is usually not what is desired.
-
-This warning can point to one of the below problems:
-
-* Exchange downtime -> Check your exchange status page / blog / twitter feed for details.
-* Wrong system time -> Ensure your system-time is correct.
-* Barely traded pair -> Check the pair on the exchange webpage, look at the timeframe your strategy uses. If the pair does not have any volume in some candles (usually visualized with a "volume 0" bar, and a "_" as candle), this pair did not have any trades in this timeframe. These pairs should ideally be avoided, as they can cause problems with order-filling.
-* API problem -> API returns wrong data (this only here for completeness, and should not happen with supported exchanges).
-
-### I'm getting the "Exchange XXX does not support market orders." message and cannot run my strategy
-
-As the message says, your exchange does not support market orders and you have one of the [order types](configuration.md/#understand-order_types) set to "market". Your strategy was probably written with other exchanges in mind and sets "market" orders for "stoploss" orders, which is correct and preferable for most of the exchanges supporting market orders (but not for Gate.io).
-
-To fix this, redefine order types in the strategy to use "limit" instead of "market":
-
-``` python
-    order_types = {
-        ...
-        "stoploss": "limit",
-        ...
-    }
-```
-
-The same fix should be applied in the configuration file, if order types are defined in your custom config rather than in the strategy.
-
-### I'm trying to start the bot live, but get an API permission error
-
-Errors like `Invalid API-key, IP, or permissions for action` mean exactly what they actually say.
-Your API key is either invalid (copy/paste error? check for leading/trailing spaces in the config), expired, or the IP you're running the bot from is not enabled in the Exchange's API console.
-Usually, the permission "Spot Trading" (or the equivalent in the exchange you use) will be necessary.
-Futures will usually have to be enabled specifically.
-
-### How do I search the bot logs for something?
-
-By default, the bot writes its log into stderr stream. This is implemented this way so that you can easily separate the bot's diagnostics messages from Backtesting, Edge and Hyperopt results, output from other various Freqtrade utility sub-commands, as well as from the output of your custom `print()`'s you may have inserted into your strategy. So if you need to search the log messages with the grep utility, you need to redirect stderr to stdout and disregard stdout.
-
-* In unix shells, this normally can be done as simple as:
-```shell
-$ freqtrade --some-options 2>&1 >/dev/null | grep 'something'
-```
-(note, `2>&1` and `>/dev/null` should be written in this order)
-
-* Bash interpreter also supports so called process substitution syntax, you can grep the log for a string with it as:
-```shell
-$ freqtrade --some-options 2> >(grep 'something') >/dev/null
-```
-or
-```shell
-$ freqtrade --some-options 2> >(grep -v 'something' 1>&2)
-```
-
-* You can also write the copy of Freqtrade log messages to a file with the `--logfile` option:
-```shell
-$ freqtrade --logfile /path/to/mylogfile.log --some-options
-```
-and then grep it as:
-```shell
-$ cat /path/to/mylogfile.log | grep 'something'
-```
-or even on the fly, as the bot works and the log file grows:
-```shell
-$ tail -f /path/to/mylogfile.log | grep 'something'
-```
-from a separate terminal window.
-
-On Windows, the `--logfile` option is also supported by Freqtrade and you can use the `findstr` command to search the log for the string of interest:
-```
-> type \path\to\mylogfile.log | findstr "something"
-```
-
-## Hyperopt module
-
-### Why does freqtrade not have GPU support?
-
-First of all, most indicator libraries don't have GPU support - as such, there would be little benefit for indicator calculations.
-The GPU improvements would only apply to pandas-native calculations - or ones written by yourself.
-
-For hyperopt, freqtrade is using scikit-optimize, which is built on top of scikit-learn.
-Their statement about GPU support is [pretty clear](https://scikit-learn.org/stable/faq.html#will-you-add-gpu-support).
-
-GPU's also are only good at crunching numbers (floating point operations).
-For hyperopt, we need both number-crunching (find next parameters) and running python code (running backtesting).
-As such, GPU's are not too well suited for most parts of hyperopt.
-
-The benefit of using GPU would therefore be pretty slim - and will not justify the complexity introduced by trying to add GPU support.
-
-There is however nothing preventing you from using GPU-enabled indicators within your strategy if you think you must have this - you will however probably be disappointed by the slim gain that will give you (compared to the complexity).
-
-### How many epochs do I need to get a good Hyperopt result?
-
-Per default Hyperopt called without the `-e`/`--epochs` command line option will only
-run 100 epochs, means 100 evaluations of your triggers, guards, ... Too few
-to find a great result (unless if you are very lucky), so you probably
-have to run it for 10000 or more. But it will take an eternity to
-compute.
-
-Since hyperopt uses Bayesian search, running for too many epochs may not produce greater results.
-
-It's therefore recommended to run between 500-1000 epochs over and over until you hit at least 10000 epochs in total (or are satisfied with the result). You can best judge by looking at the results - if the bot keeps discovering better strategies, it's best to keep on going.
-
-```bash
-freqtrade hyperopt --hyperopt-loss SharpeHyperOptLossDaily --strategy SampleStrategy -e 1000
-```
-
-### Why does it take a long time to run hyperopt?
-
-* Discovering a great strategy with Hyperopt takes time. Study www.freqtrade.io, the Freqtrade Documentation page, join the Freqtrade [discord community](https://discord.gg/p7nuUNVfP7). While you patiently wait for the most advanced, free crypto bot in the world, to hand you a possible golden strategy specially designed just for you.
-
-* If you wonder why it can take from 20 minutes to days to do 1000 epochs here are some answers:
-
-This answer was written during the release 0.15.1, when we had:
-
-* 8 triggers
-* 9 guards: let's say we evaluate even 10 values from each
-* 1 stoploss calculation: let's say we want 10 values from that too to be evaluated
-
-The following calculation is still very rough and not very precise
-but it will give the idea. With only these triggers and guards there is
-already 8\*10^9\*10 evaluations. A roughly total of 80 billion evaluations.
-Did you run 100 000 evaluations? Congrats, you've done roughly 1 / 100 000 th
-of the search space, assuming that the bot never tests the same parameters more than once.
-
-* The time it takes to run 1000 hyperopt epochs depends on things like: The available cpu, hard-disk, ram, timeframe, timerange, indicator settings, indicator count, amount of coins that hyperopt test strategies on and the resulting trade count - which can be 650 trades in a year or 100000 trades depending if the strategy aims for big profits by trading rarely or for many low profit trades.
-
-Example: 4% profit 650 times vs 0,3% profit a trade 10000 times in a year. If we assume you set the --timerange to 365 days.
-
-Example:
-`freqtrade --config config.json --strategy SampleStrategy --hyperopt SampleHyperopt -e 1000 --timerange 20190601-20200601`
-
-## Edge module
-
-### Edge implements interesting approach for controlling position size, is there any theory behind it?
-
-The Edge module is mostly a result of brainstorming of [@mishaker](https://github.com/mishaker) and [@creslinux](https://github.com/creslinux) freqtrade team members.
-
-You can find further info on expectancy, win rate, risk management and position size in the following sources:
-
-- https://www.tradeciety.com/ultimate-math-guide-for-traders/
-- https://samuraitradingacademy.com/trading-expectancy/
-- https://www.learningmarkets.com/determining-expectancy-in-your-trading/
-- https://www.lonestocktrader.com/make-money-trading-positive-expectancy/
-- https://www.babypips.com/trading/trade-expectancy-matter
-
-## Official channels
-
-Freqtrade is using exclusively the following official channels:
-
-* [Freqtrade discord server](https://discord.gg/p7nuUNVfP7)
-* [Freqtrade documentation (https://freqtrade.io)](https://freqtrade.io)
-* [Freqtrade github organization](https://github.com/freqtrade)
-
-Nobody affiliated with the freqtrade project will ask you about your exchange keys or anything else exposing your funds to exploitation.
-Should you be asked to expose your exchange keys or send funds to some random wallet, then please don't follow these instructions.
-
-Failing to follow these guidelines will not be responsibility of freqtrade.
-
-## "Freqtrade token"
-
-Freqtrade does not have a Crypto token offering.
-
-Token offerings you find on the internet referring Freqtrade, FreqAI or freqUI must be considered to be a scam, trying to exploit freqtrade's popularity for their own, nefarious gains.

docs/freq-ui.md

@@ -1,84 +0,0 @@
-# FreqUI
-
-Freqtrade provides a builtin webserver, which can serve [FreqUI](https://github.com/freqtrade/frequi), the freqtrade frontend.
-
-By default, the UI is automatically installed as part of the installation (script, docker).
-freqUI can also be manually installed by using the `freqtrade install-ui` command.
-This same command can also be used to update freqUI to new new releases.
-
-Once the bot is started in trade / dry-run mode (with `freqtrade trade`) - the UI will be available under the configured API port (by default `http://127.0.0.1:8080`).
-
-??? Note "Looking to contribute to freqUI?"
-    Developers should not use this method, but instead clone the corresponding use the method described in the [freqUI repository](https://github.com/freqtrade/frequi) to get the source-code of freqUI. A working installation of node will be required to build the frontend.
-
-!!! tip "freqUI is not required to run freqtrade"
-    freqUI is an optional component of freqtrade, and is not required to run the bot.
-    It is a frontend that can be used to monitor the bot and to interact with it - but freqtrade itself will work perfectly fine without it.
-
-## Configuration
-
-FreqUI does not have it's own configuration file - but assumes a working setup for the [rest-api](rest-api.md) is available.
-Please refer to the corresponding documentation page to get setup with freqUI
-
-## UI
-
-FreqUI is a modern, responsive web application that can be used to monitor and interact with your bot.
-
-FreqUI provides a light, as well as a dark theme.
-Themes can be easily switched via a prominent button at the top of the page.
-The theme of the screenshots on this page will adapt to the selected documentation Theme, so to see the dark (or light) version, please switch the theme of the Documentation.
-
-### Login
-
-The below screenshot shows the login screen of freqUI.
-
-![FreqUI - login](assets/frequi-login-CORS.png#only-dark)
-![FreqUI - login](assets/frequi-login-CORS-light.png#only-light)
-
-!!! Hint "CORS"
-    The Cors error shown in this screenshot is due to the fact that the UI is running on a different port than the API, and [CORS](#cors) has not been setup correctly yet.
-
-### Trade view
-
-The trade view allows you to visualize the trades that the bot is making and to interact with the bot.
-On this page, you can also interact with the bot by starting and stopping it and - if configured - force trade entries and exits.
-
-![FreqUI - trade view](assets/freqUI-trade-pane-dark.png#only-dark)
-![FreqUI - trade view](assets/freqUI-trade-pane-light.png#only-light)
-
-### Plot Configurator
-
-FreqUI Plots can be configured either via a `plot_config` configuration object in the strategy (which can be loaded via "from strategy" button) or via the UI.
-Multiple plot configurations can be created and switched at will - allowing for flexible, different views into your charts.
-
-The plot configuration can be accessed via the "Plot Configurator" (Cog icon) button in the top right corner of the trade view.
-
-![FreqUI - plot configuration](assets/freqUI-plot-configurator-dark.png#only-dark)
-![FreqUI - plot configuration](assets/freqUI-plot-configurator-light.png#only-light)
-
-### Settings
-
-Several UI related settings can be changed by accessing the settings page.
-
-Things you can change (among others):
-
-* Timezone of the UI
-* Visualization of open trades as part of the favicon (browser tab)
-* Candle colors (up/down -> red/green)
-* Enable / disable in-app notification types
-
-![FreqUI - Settings view](assets/frequi-settings-dark.png#only-dark)
-![FreqUI - Settings view](assets/frequi-settings-light.png#only-light)
-
-## Backtesting
-
-When freqtrade is started in [webserver mode](utils.md#webserver-mode) (freqtrade started with `freqtrade webserver`), the backtesting view becomes available.
-This view allows you to backtest strategies and visualize the results.
-
-You can also load and visualize previous backtest results, as well as compare the results with each other.
-
-![FreqUI - Backtesting](assets/freqUI-backtesting-dark.png#only-dark)
-![FreqUI - Backtesting](assets/freqUI-backtesting-light.png#only-light)
-
-
---8<-- "includes/cors.md"

docs/freqai-configuration.md

@@ -1,421 +0,0 @@
-# Configuration
-
-FreqAI is configured through the typical [Freqtrade config file](configuration.md) and the standard [Freqtrade strategy](strategy-customization.md). Examples of FreqAI config and strategy files can be found in `config_examples/config_freqai.example.json` and `freqtrade/templates/FreqaiExampleStrategy.py`, respectively.
-
-## Setting up the configuration file
-
- Although there are plenty of additional parameters to choose from, as highlighted in the [parameter table](freqai-parameter-table.md#parameter-table), a FreqAI config must at minimum include the following parameters (the parameter values are only examples):
-
-```json
-    "freqai": {
-        "enabled": true,
-        "purge_old_models": 2,
-        "train_period_days": 30,
-        "backtest_period_days": 7,
-        "identifier" : "unique-id",
-        "feature_parameters" : {
-            "include_timeframes": ["5m","15m","4h"],
-            "include_corr_pairlist": [
-                "ETH/USD",
-                "LINK/USD",
-                "BNB/USD"
-            ],
-            "label_period_candles": 24,
-            "include_shifted_candles": 2,
-            "indicator_periods_candles": [10, 20]
-        },
-        "data_split_parameters" : {
-            "test_size": 0.25
-        }
-    }
-```
-
-A full example config is available in `config_examples/config_freqai.example.json`.
-
-!!! Note
-    The `identifier` is commonly overlooked by newcomers, however, this value plays an important role in your configuration. This value is a unique ID that you choose to describe one of your runs. Keeping it the same allows you to maintain crash resilience as well as faster backtesting. As soon as you want to try a new run (new features, new model, etc.), you should change this value (or delete the `user_data/models/unique-id` folder. More details available in the [parameter table](freqai-parameter-table.md#feature-parameters).
-
-## Building a FreqAI strategy
-
-The FreqAI strategy requires including the following lines of code in the standard [Freqtrade strategy](strategy-customization.md):
-
-```python
-    # user should define the maximum startup candle count (the largest number of candles
-    # passed to any single indicator)
-    startup_candle_count: int = 20
-
-    def populate_indicators(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
-
-        # the model will return all labels created by user in `set_freqai_targets()`
-        # (& appended targets), an indication of whether or not the prediction should be accepted,
-        # the target mean/std values for each of the labels created by user in
-        # `set_freqai_targets()` for each training period.
-
-        dataframe = self.freqai.start(dataframe, metadata, self)
-
-        return dataframe
-
-    def feature_engineering_expand_all(self, dataframe: DataFrame, period, **kwargs) -> DataFrame:
-        """
-        *Only functional with FreqAI enabled strategies*
-        This function will automatically expand the defined features on the config defined
-        `indicator_periods_candles`, `include_timeframes`, `include_shifted_candles`, and
-        `include_corr_pairs`. In other words, a single feature defined in this function
-        will automatically expand to a total of
-        `indicator_periods_candles` * `include_timeframes` * `include_shifted_candles` *
-        `include_corr_pairs` numbers of features added to the model.
-
-        All features must be prepended with `%` to be recognized by FreqAI internals.
-
-        :param df: strategy dataframe which will receive the features
-        :param period: period of the indicator - usage example:
-        dataframe["%-ema-period"] = ta.EMA(dataframe, timeperiod=period)
-        """
-
-        dataframe["%-rsi-period"] = ta.RSI(dataframe, timeperiod=period)
-        dataframe["%-mfi-period"] = ta.MFI(dataframe, timeperiod=period)
-        dataframe["%-adx-period"] = ta.ADX(dataframe, timeperiod=period)
-        dataframe["%-sma-period"] = ta.SMA(dataframe, timeperiod=period)
-        dataframe["%-ema-period"] = ta.EMA(dataframe, timeperiod=period)
-
-        return dataframe
-
-    def feature_engineering_expand_basic(self, dataframe: DataFrame, **kwargs) -> DataFrame:
-        """
-        *Only functional with FreqAI enabled strategies*
-        This function will automatically expand the defined features on the config defined
-        `include_timeframes`, `include_shifted_candles`, and `include_corr_pairs`.
-        In other words, a single feature defined in this function
-        will automatically expand to a total of
-        `include_timeframes` * `include_shifted_candles` * `include_corr_pairs`
-        numbers of features added to the model.
-
-        Features defined here will *not* be automatically duplicated on user defined
-        `indicator_periods_candles`
-
-        All features must be prepended with `%` to be recognized by FreqAI internals.
-
-        :param df: strategy dataframe which will receive the features
-        dataframe["%-pct-change"] = dataframe["close"].pct_change()
-        dataframe["%-ema-200"] = ta.EMA(dataframe, timeperiod=200)
-        """
-        dataframe["%-pct-change"] = dataframe["close"].pct_change()
-        dataframe["%-raw_volume"] = dataframe["volume"]
-        dataframe["%-raw_price"] = dataframe["close"]
-        return dataframe
-
-    def feature_engineering_standard(self, dataframe: DataFrame, **kwargs) -> DataFrame:
-        """
-        *Only functional with FreqAI enabled strategies*
-        This optional function will be called once with the dataframe of the base timeframe.
-        This is the final function to be called, which means that the dataframe entering this
-        function will contain all the features and columns created by all other
-        freqai_feature_engineering_* functions.
-
-        This function is a good place to do custom exotic feature extractions (e.g. tsfresh).
-        This function is a good place for any feature that should not be auto-expanded upon
-        (e.g. day of the week).
-
-        All features must be prepended with `%` to be recognized by FreqAI internals.
-
-        :param df: strategy dataframe which will receive the features
-        usage example: dataframe["%-day_of_week"] = (dataframe["date"].dt.dayofweek + 1) / 7
-        """
-        dataframe["%-day_of_week"] = (dataframe["date"].dt.dayofweek + 1) / 7
-        dataframe["%-hour_of_day"] = (dataframe["date"].dt.hour + 1) / 25
-        return dataframe
-
-    def set_freqai_targets(self, dataframe: DataFrame, **kwargs) -> DataFrame:
-        """
-        *Only functional with FreqAI enabled strategies*
-        Required function to set the targets for the model.
-        All targets must be prepended with `&` to be recognized by the FreqAI internals.
-
-        :param df: strategy dataframe which will receive the targets
-        usage example: dataframe["&-target"] = dataframe["close"].shift(-1) / dataframe["close"]
-        """
-        dataframe["&-s_close"] = (
-            dataframe["close"]
-            .shift(-self.freqai_info["feature_parameters"]["label_period_candles"])
-            .rolling(self.freqai_info["feature_parameters"]["label_period_candles"])
-            .mean()
-            / dataframe["close"]
-            - 1
-            )
-        return dataframe
-```
-
-Notice how the `feature_engineering_*()` is where [features](freqai-feature-engineering.md#feature-engineering) are added. Meanwhile `set_freqai_targets()` adds the labels/targets. A full example strategy is available in `templates/FreqaiExampleStrategy.py`.
-
-!!! Note
-    The `self.freqai.start()` function cannot be called outside the `populate_indicators()`.
-
-!!! Note
-    Features **must** be defined in `feature_engineering_*()`. Defining FreqAI features in `populate_indicators()`
-    will cause the algorithm to fail in live/dry mode. In order to add generalized features that are not associated with a specific pair or timeframe, you should use `feature_engineering_standard()`
-    (as exemplified in `freqtrade/templates/FreqaiExampleStrategy.py`).
-
-## Important dataframe key patterns
-
-Below are the values you can expect to include/use inside a typical strategy dataframe (`df[]`):
-
-|  DataFrame Key | Description |
-|------------|-------------|
-| `df['&*']` | Any dataframe column prepended with `&` in `set_freqai_targets()` is treated as a training target (label) inside FreqAI (typically following the naming convention `&-s*`). For example, to predict the close price 40 candles into the future, you would set `df['&-s_close'] = df['close'].shift(-self.freqai_info["feature_parameters"]["label_period_candles"])` with `"label_period_candles": 40` in the config. FreqAI makes the predictions and gives them back under the same key (`df['&-s_close']`) to be used in `populate_entry/exit_trend()`. <br> **Datatype:** Depends on the output of the model.
-| `df['&*_std/mean']` | Standard deviation and mean values of the defined labels during training (or live tracking with `fit_live_predictions_candles`). Commonly used to understand the rarity of a prediction (use the z-score as shown in `templates/FreqaiExampleStrategy.py` and explained [here](#creating-a-dynamic-target-threshold) to evaluate how often a particular prediction was observed during training or historically with `fit_live_predictions_candles`). <br> **Datatype:** Float.
-| `df['do_predict']` | Indication of an outlier data point. The return value is integer between -2 and 2, which lets you know if the prediction is trustworthy or not. `do_predict==1` means that the prediction is trustworthy. If the Dissimilarity Index (DI, see details [here](freqai-feature-engineering.md#identifying-outliers-with-the-dissimilarity-index-di)) of the input data point is above the threshold defined in the config, FreqAI will subtract 1 from `do_predict`, resulting in `do_predict==0`. If `use_SVM_to_remove_outliers` is active, the Support Vector Machine (SVM, see details [here](freqai-feature-engineering.md#identifying-outliers-using-a-support-vector-machine-svm)) may also detect outliers in training and prediction data. In this case, the SVM will also subtract 1 from `do_predict`. If the input data point was considered an outlier by the SVM but not by the DI, or vice versa, the result will be `do_predict==0`. If both the DI and the SVM considers the input data point to be an outlier, the result will be `do_predict==-1`. As with the SVM, if `use_DBSCAN_to_remove_outliers` is active, DBSCAN (see details [here](freqai-feature-engineering.md#identifying-outliers-with-dbscan)) may also detect outliers and subtract 1 from `do_predict`. Hence, if both the SVM and DBSCAN are active and identify a datapoint that was above the DI threshold as an outlier, the result will be `do_predict==-2`. A particular case is when `do_predict == 2`, which means that the model has expired due to exceeding `expired_hours`. <br> **Datatype:** Integer between -2 and 2.
-| `df['DI_values']` | Dissimilarity Index (DI) values are proxies for the level of confidence FreqAI has in the prediction. A lower DI means the prediction is close to the training data, i.e., higher prediction confidence. See details about the DI [here](freqai-feature-engineering.md#identifying-outliers-with-the-dissimilarity-index-di). <br> **Datatype:** Float.
-| `df['%*']` | Any dataframe column prepended with `%` in `feature_engineering_*()` is treated as a training feature. For example, you can include the RSI in the training feature set (similar to in `templates/FreqaiExampleStrategy.py`) by setting `df['%-rsi']`. See more details on how this is done [here](freqai-feature-engineering.md). <br> **Note:** Since the number of features prepended with `%` can multiply very quickly (10s of thousands of features are easily engineered using the multiplictative functionality of, e.g., `include_shifted_candles` and `include_timeframes` as described in the [parameter table](freqai-parameter-table.md)), these features are removed from the dataframe that is returned from FreqAI to the strategy. To keep a particular type of feature for plotting purposes, you would prepend it with `%%` (see details below). <br> **Datatype:** Depends on the feature created by the user.
-| `df['%%*']` | Any dataframe column prepended with `%%` in `feature_engineering_*()` is treated as a training feature, just the same as the above `%` prepend. However, in this case, the features are returned back to the strategy for FreqUI/plot-dataframe plotting and monitoring in Dry/Live/Backtesting <br> **Datatype:** Depends on the feature created by the user. Please note that features created in `feature_engineering_expand()` will have automatic FreqAI naming schemas depending on the expansions that you configured (i.e. `include_timeframes`, `include_corr_pairlist`, `indicators_periods_candles`, `include_shifted_candles`). So if you want to plot `%%-rsi` from `feature_engineering_expand_all()`, the final naming scheme for your plotting config would be: `%%-rsi-period_10_ETH/USDT:USDT_1h` for the `rsi` feature with `period=10`, `timeframe=1h`, and `pair=ETH/USDT:USDT` (the `:USDT` is added if you are using futures pairs). It is useful to simply add `print(dataframe.columns)` in your `populate_indicators()` after `self.freqai.start()` to see the full list of available features that are returned to the strategy for plotting purposes.
-
-## Setting the `startup_candle_count`
-
-The `startup_candle_count` in the FreqAI strategy needs to be set up in the same way as in the standard Freqtrade strategy (see details [here](strategy-customization.md#strategy-startup-period)). This value is used by Freqtrade to ensure that a sufficient amount of data is provided when calling the `dataprovider`, to avoid any NaNs at the beginning of the first training. You can easily set this value by identifying the longest period (in candle units) which is passed to the indicator creation functions (e.g., TA-Lib functions). In the presented example, `startup_candle_count` is 20 since this is the maximum value in `indicators_periods_candles`.
-
-!!! Note
-    There are instances where the TA-Lib functions actually require more data than just the passed `period` or else the feature dataset gets populated with NaNs. Anecdotally, multiplying the `startup_candle_count` by 2 always leads to a fully NaN free training dataset. Hence, it is typically safest to multiply the expected `startup_candle_count` by 2. Look out for this log message to confirm that the data is clean:
-
-    ```
-    2022-08-31 15:14:04 - freqtrade.freqai.data_kitchen - INFO - dropped 0 training points due to NaNs in populated dataset 4319.
-    ```
-
-## Creating a dynamic target threshold
-
-Deciding when to enter or exit a trade can be done in a dynamic way to reflect current market conditions. FreqAI allows you to return additional information from the training of a model (more info [here](freqai-feature-engineering.md#returning-additional-info-from-training)). For example, the `&*_std/mean` return values describe the statistical distribution of the target/label *during the most recent training*. Comparing a given prediction to these values allows you to know the rarity of the prediction. In `templates/FreqaiExampleStrategy.py`, the `target_roi` and  `sell_roi` are defined to be 1.25 z-scores away from the mean which causes predictions that are closer to the mean to be filtered out.
-
-```python
-dataframe["target_roi"] = dataframe["&-s_close_mean"] + dataframe["&-s_close_std"] * 1.25
-dataframe["sell_roi"] = dataframe["&-s_close_mean"] - dataframe["&-s_close_std"] * 1.25
-```
-
-To consider the population of *historical predictions* for creating the dynamic target instead of information from the training as discussed above, you would set `fit_live_predictions_candles` in the config to the number of historical prediction candles you wish to use to generate target statistics.
-
-```json
-    "freqai": {
-        "fit_live_predictions_candles": 300,
-    }
-```
-
-If this value is set, FreqAI will initially use the predictions from the training data and subsequently begin introducing real prediction data as it is generated. FreqAI will save this historical data to be reloaded if you stop and restart a model with the same `identifier`.
-
-## Using different prediction models
-
-FreqAI has multiple example prediction model libraries that are ready to be used as is via the flag `--freqaimodel`. These libraries include `CatBoost`, `LightGBM`, and `XGBoost` regression, classification, and multi-target models, and can be found in `freqai/prediction_models/`.
-
-Regression and classification models differ in what targets they predict - a regression model will predict a target of continuous values, for example what price BTC will be at tomorrow, whilst a classifier will predict a target of discrete values, for example if the price of BTC will go up tomorrow or not. This means that you have to specify your targets differently depending on which model type you are using (see details [below](#setting-model-targets)).
-
-All of the aforementioned model libraries implement gradient boosted decision tree algorithms. They all work on the principle of ensemble learning, where predictions from multiple simple learners are combined to get a final prediction that is more stable and generalized. The simple learners in this case are decision trees. Gradient boosting refers to the method of learning, where each simple learner is built in sequence - the subsequent learner is used to improve on the error from the previous learner. If you want to learn more about the different model libraries you can find the information in their respective docs:
-
-* CatBoost: https://catboost.ai/en/docs/
-* LightGBM: https://lightgbm.readthedocs.io/en/v3.3.2/#
-* XGBoost: https://xgboost.readthedocs.io/en/stable/#
-
-There are also numerous online articles describing and comparing the algorithms. Some relatively lightweight examples would be [CatBoost vs. LightGBM vs. XGBoost — Which is the best algorithm?](https://towardsdatascience.com/catboost-vs-lightgbm-vs-xgboost-c80f40662924#:~:text=In%20CatBoost%2C%20symmetric%20trees%2C%20or,the%20same%20depth%20can%20differ.) and [XGBoost, LightGBM or CatBoost — which boosting algorithm should I use?](https://medium.com/riskified-technology/xgboost-lightgbm-or-catboost-which-boosting-algorithm-should-i-use-e7fda7bb36bc). Keep in mind that the performance of each model is highly dependent on the application and so any reported metrics might not be true for your particular use of the model.
-
-Apart from the models already available in FreqAI, it is also possible to customize and create your own prediction models using the `IFreqaiModel` class. You are encouraged to inherit `fit()`, `train()`, and `predict()` to customize various aspects of the training procedures. You can place custom FreqAI models in `user_data/freqaimodels` - and freqtrade will pick them up from there based on the provided `--freqaimodel` name - which has to correspond to the class name of your custom model.
-Make sure to use unique names to avoid overriding built-in models.
-
-### Setting model targets
-
-#### Regressors
-
-If you are using a regressor, you need to specify a target that has continuous values. FreqAI includes a variety of regressors, such as the `CatboostRegressor`via the flag `--freqaimodel CatboostRegressor`. An example of how you could set a regression target for predicting the price 100 candles into the future would be
-
-```python
-df['&s-close_price'] = df['close'].shift(-100)
-```
-
-If you want to predict multiple targets, you need to define multiple labels using the same syntax as shown above.
-
-#### Classifiers
-
-If you are using a classifier, you need to specify a target that has discrete values. FreqAI includes a variety of classifiers, such as the `CatboostClassifier` via the flag `--freqaimodel CatboostClassifier`. If you elects to use a classifier, the classes need to be set using strings. For example, if you want to predict if the price 100 candles into the future goes up or down you would set
-
-```python
-df['&s-up_or_down'] = np.where( df["close"].shift(-100) > df["close"], 'up', 'down')
-```
-
-If you want to predict multiple targets you must specify all labels in the same label column. You could, for example, add the label `same` to define where the price was unchanged by setting
-
-```python
-df['&s-up_or_down'] = np.where( df["close"].shift(-100) > df["close"], 'up', 'down')
-df['&s-up_or_down'] = np.where( df["close"].shift(-100) == df["close"], 'same', df['&s-up_or_down'])
-```
-
-## PyTorch Module
-
-### Quick start
-
-The easiest way to quickly run a pytorch model is with the following command (for regression task):
-
-```bash
-freqtrade trade --config config_examples/config_freqai.example.json --strategy FreqaiExampleStrategy --freqaimodel PyTorchMLPRegressor --strategy-path freqtrade/templates 
-```
-
-!!! Note "Installation/docker"
-    The PyTorch module requires large packages such as `torch`, which should be explicitly requested during `./setup.sh -i` by answering "y" to the question "Do you also want dependencies for freqai-rl or PyTorch (~700mb additional space required) [y/N]?".
-    Users who prefer docker should ensure they use the docker image appended with `_freqaitorch`.
-    We do provide an explicit docker-compose file for this in `docker/docker-compose-freqai.yml` - which can be used via `docker compose -f docker/docker-compose-freqai.yml run ...` - or can be copied to replace the original docker file.
-    This docker-compose file also contains a (disabled) section to enable GPU resources within docker containers. This obviously assumes the system has GPU resources available.
-
-### Structure
-
-#### Model
-
-You can construct your own Neural Network architecture in PyTorch by simply defining your `nn.Module` class inside your custom [`IFreqaiModel` file](#using-different-prediction-models) and then using that class in your `def train()` function. Here is an example of logistic regression model implementation using PyTorch (should be used with nn.BCELoss criterion) for classification tasks.
-
-```python
-
-class LogisticRegression(nn.Module):
-    def __init__(self, input_size: int):
-        super().__init__()
-        # Define your layers
-        self.linear = nn.Linear(input_size, 1)
-        self.activation = nn.Sigmoid()
-
-    def forward(self, x: torch.Tensor) -> torch.Tensor:
-        # Define the forward pass
-        out = self.linear(x)
-        out = self.activation(out)
-        return out
-
-class MyCoolPyTorchClassifier(BasePyTorchClassifier):
-    """
-    This is a custom IFreqaiModel showing how a user might setup their own 
-    custom Neural Network architecture for their training.
-    """
-
-    @property
-    def data_convertor(self) -> PyTorchDataConvertor:
-        return DefaultPyTorchDataConvertor(target_tensor_type=torch.float)
-
-    def __init__(self, **kwargs) -> None:
-        super().__init__(**kwargs)
-        config = self.freqai_info.get("model_training_parameters", {})
-        self.learning_rate: float = config.get("learning_rate",  3e-4)
-        self.model_kwargs: Dict[str, Any] = config.get("model_kwargs",  {})
-        self.trainer_kwargs: Dict[str, Any] = config.get("trainer_kwargs",  {})
-
-    def fit(self, data_dictionary: Dict, dk: FreqaiDataKitchen, **kwargs) -> Any:
-        """
-        User sets up the training and test data to fit their desired model here
-        :param data_dictionary: the dictionary holding all data for train, test,
-            labels, weights
-        :param dk: The datakitchen object for the current coin/model
-        """
-
-        class_names = self.get_class_names()
-        self.convert_label_column_to_int(data_dictionary, dk, class_names)
-        n_features = data_dictionary["train_features"].shape[-1]
-        model = LogisticRegression(
-            input_dim=n_features
-        )
-        model.to(self.device)
-        optimizer = torch.optim.AdamW(model.parameters(), lr=self.learning_rate)
-        criterion = torch.nn.CrossEntropyLoss()
-        init_model = self.get_init_model(dk.pair)
-        trainer = PyTorchModelTrainer(
-            model=model,
-            optimizer=optimizer,
-            criterion=criterion,
-            model_meta_data={"class_names": class_names},
-            device=self.device,
-            init_model=init_model,
-            data_convertor=self.data_convertor,
-            **self.trainer_kwargs,
-        )
-        trainer.fit(data_dictionary, self.splits)
-        return trainer
-
-```
-
-#### Trainer
-
-The `PyTorchModelTrainer` performs the idiomatic PyTorch train loop:
-Define our model, loss function, and optimizer, and then move them to the appropriate device (GPU or CPU). Inside the loop, we iterate through the batches in the dataloader, move the data to the device, compute the prediction and loss, backpropagate, and update the model parameters using the optimizer. 
-
-In addition, the trainer is responsible for the following:
- - saving and loading the model
- - converting the data from `pandas.DataFrame` to `torch.Tensor`. 
-
-#### Integration with Freqai module 
-
-Like all freqai models, PyTorch models inherit `IFreqaiModel`. `IFreqaiModel` declares three abstract methods: `train`, `fit`, and `predict`. we implement these methods in three levels of hierarchy.
-From top to bottom:
-
-1. `BasePyTorchModel` - Implements the `train` method. all `BasePyTorch*` inherit it. responsible for general data preparation (e.g., data normalization) and calling the `fit` method. Sets `device` attribute used by children classes. Sets `model_type` attribute used by the parent class.
-2. `BasePyTorch*` -  Implements the `predict` method. Here, the `*` represents a group of algorithms, such as classifiers or regressors. responsible for data preprocessing, predicting, and postprocessing if needed.
-3. `PyTorch*Classifier` / `PyTorch*Regressor` - implements the `fit` method. responsible for the main train flaw, where we initialize the trainer and model objects.
-
-![image](assets/freqai_pytorch-diagram.png)
-
-#### Full example
-
-Building a PyTorch regressor using MLP (multilayer perceptron) model, MSELoss criterion, and AdamW optimizer.
-
-```python
-class PyTorchMLPRegressor(BasePyTorchRegressor):
-    def __init__(self, **kwargs) -> None:
-        super().__init__(**kwargs)
-        config = self.freqai_info.get("model_training_parameters", {})
-        self.learning_rate: float = config.get("learning_rate",  3e-4)
-        self.model_kwargs: Dict[str, Any] = config.get("model_kwargs",  {})
-        self.trainer_kwargs: Dict[str, Any] = config.get("trainer_kwargs",  {})
-
-    def fit(self, data_dictionary: Dict, dk: FreqaiDataKitchen, **kwargs) -> Any:
-        n_features = data_dictionary["train_features"].shape[-1]
-        model = PyTorchMLPModel(
-            input_dim=n_features,
-            output_dim=1,
-            **self.model_kwargs
-        )
-        model.to(self.device)
-        optimizer = torch.optim.AdamW(model.parameters(), lr=self.learning_rate)
-        criterion = torch.nn.MSELoss()
-        init_model = self.get_init_model(dk.pair)
-        trainer = PyTorchModelTrainer(
-            model=model,
-            optimizer=optimizer,
-            criterion=criterion,
-            device=self.device,
-            init_model=init_model,
-            target_tensor_type=torch.float,
-            **self.trainer_kwargs,
-        )
-        trainer.fit(data_dictionary)
-        return trainer
-```
-
-Here we create a `PyTorchMLPRegressor` class that implements the `fit` method. The `fit` method specifies the training building blocks: model, optimizer, criterion, and trainer. We inherit both `BasePyTorchRegressor` and `BasePyTorchModel`, where the former implements the `predict` method that is suitable for our regression task, and the latter implements the train method.
-
-??? Note "Setting Class Names for Classifiers"
-    When using classifiers, the user must declare the class names (or targets) by overriding the `IFreqaiModel.class_names` attribute. This is achieved by setting `self.freqai.class_names` in the FreqAI strategy inside the `set_freqai_targets` method.
-    
-    For example, if you are using a binary classifier to predict price movements as up or down, you can set the class names as follows:
-    ```python
-    def set_freqai_targets(self, dataframe: DataFrame, metadata: Dict, **kwargs) -> DataFrame:
-        self.freqai.class_names = ["down", "up"]
-        dataframe['&s-up_or_down'] = np.where(dataframe["close"].shift(-100) >
-                                                  dataframe["close"], 'up', 'down')
-    
-        return dataframe
-    ```
-    To see a full example, you can refer to the [classifier test strategy class](https://github.com/freqtrade/freqtrade/blob/develop/tests/strategy/strats/freqai_test_classifier.py).
-
-
-#### Improving performance with `torch.compile()`
-
-Torch provides a `torch.compile()` method that can be used to improve performance for specific GPU hardware. More details can be found [here](https://pytorch.org/tutorials/intermediate/torch_compile_tutorial.html). In brief, you simply wrap your `model` in `torch.compile()`:
-
-
-```python
-        model = PyTorchMLPModel(
-            input_dim=n_features,
-            output_dim=1,
-            **self.model_kwargs
-        )
-        model.to(self.device)
-        model = torch.compile(model)
-```
-
-Then proceed to use the model as normal. Keep in mind that doing this will remove eager execution, which means errors and tracebacks will not be informative.

docs/freqai-developers.md

@@ -1,78 +0,0 @@
-# Development
-
-## Project architecture
-
-The architecture and functions of FreqAI are generalized to encourages development of unique features, functions, models, etc.
-
-The class structure and a detailed algorithmic overview is depicted in the following diagram:
-
-![image](assets/freqai_algorithm-diagram.jpg)
-
-As shown, there are three distinct objects comprising FreqAI:
-
-* **IFreqaiModel** - A singular persistent object containing all the necessary logic to collect, store, and process data, engineer features, run training, and inference models.
-* **FreqaiDataKitchen** - A non-persistent object which is created uniquely for each unique asset/model. Beyond metadata, it also contains a variety of data processing tools.
-* **FreqaiDataDrawer** - A singular persistent object containing all the historical predictions, models, and save/load methods.
-
-There are a variety of built-in [prediction models](freqai-configuration.md#using-different-prediction-models) which inherit directly from `IFreqaiModel`. Each of these models have full access to all methods in `IFreqaiModel` and can therefore override any of those functions at will. However, advanced users will likely stick to overriding `fit()`, `train()`, `predict()`, and `data_cleaning_train/predict()`.
-
-## Data handling
-
-FreqAI aims to organize model files, prediction data, and meta data in a way that simplifies post-processing and enhances crash resilience by automatic data reloading. The data is saved in a file structure,`user_data_dir/models/`, which contains all the data associated with the trainings and backtests. The `FreqaiDataKitchen()` relies heavily on the file structure for proper training and inferencing and should therefore not be manually modified.
-
-### File structure
-
-The file structure is automatically generated based on the model `identifier` set in the [config](freqai-configuration.md#setting-up-the-configuration-file). The following structure shows where the data is stored for post processing:
-
-| Structure | Description |
-|-----------|-------------|
-| `config_*.json` | A copy of the model specific configuration file. |
-| `historic_predictions.pkl` | A file containing all historic predictions generated during the lifetime of the `identifier` model during live deployment. `historic_predictions.pkl` is used to reload the model after a crash or a config change. A backup file is always held in case of corruption on the main file. FreqAI **automatically** detects corruption and replaces the corrupted file with the backup. |
-| `pair_dictionary.json` | A file containing the training queue as well as the on disk location of the most recently trained model. |
-| `sub-train-*_TIMESTAMP` | A folder containing all the files associated with a single model, such as: <br>
-|| `*_metadata.json` - Metadata for the model, such as normalization max/min, expected training feature list, etc. <br>
-|| `*_model.*` - The model file saved to disk for reloading from a crash. Can be `joblib` (typical boosting libs), `zip` (stable_baselines), `hd5` (keras type), etc. <br>
-|| `*_pca_object.pkl` - The [Principal component analysis (PCA)](freqai-feature-engineering.md#data-dimensionality-reduction-with-principal-component-analysis) transform (if `principal_component_analysis: True` is set in the config) which will be used to transform unseen prediction features. <br>
-|| `*_svm_model.pkl` - The [Support Vector Machine (SVM)](freqai-feature-engineering.md#identifying-outliers-using-a-support-vector-machine-svm) model (if `use_SVM_to_remove_outliers: True` is set in the config) which is used to detect outliers in unseen prediction features. <br>
-|| `*_trained_df.pkl` - The dataframe containing all the training features used to train the `identifier` model. This is used for computing the [Dissimilarity Index (DI)](freqai-feature-engineering.md#identifying-outliers-with-the-dissimilarity-index-di) and can also be used for post-processing. <br>
-|| `*_trained_dates.df.pkl` - The dates associated with the `trained_df.pkl`, which is useful for post-processing. |
-
-The example file structure would look like this:
-
-```
-├── models
-│   └── unique-id
-│       ├── config_freqai.example.json
-│       ├── historic_predictions.backup.pkl
-│       ├── historic_predictions.pkl
-│       ├── pair_dictionary.json
-│       ├── sub-train-1INCH_1662821319
-│       │   ├── cb_1inch_1662821319_metadata.json
-│       │   ├── cb_1inch_1662821319_model.joblib
-│       │   ├── cb_1inch_1662821319_pca_object.pkl
-│       │   ├── cb_1inch_1662821319_svm_model.joblib
-│       │   ├── cb_1inch_1662821319_trained_dates_df.pkl
-│       │   └── cb_1inch_1662821319_trained_df.pkl
-│       ├── sub-train-1INCH_1662821371
-│       │   ├── cb_1inch_1662821371_metadata.json
-│       │   ├── cb_1inch_1662821371_model.joblib
-│       │   ├── cb_1inch_1662821371_pca_object.pkl
-│       │   ├── cb_1inch_1662821371_svm_model.joblib
-│       │   ├── cb_1inch_1662821371_trained_dates_df.pkl
-│       │   └── cb_1inch_1662821371_trained_df.pkl
-│       ├── sub-train-ADA_1662821344
-│       │   ├── cb_ada_1662821344_metadata.json
-│       │   ├── cb_ada_1662821344_model.joblib
-│       │   ├── cb_ada_1662821344_pca_object.pkl
-│       │   ├── cb_ada_1662821344_svm_model.joblib
-│       │   ├── cb_ada_1662821344_trained_dates_df.pkl
-│       │   └── cb_ada_1662821344_trained_df.pkl
-│       └── sub-train-ADA_1662821399
-│           ├── cb_ada_1662821399_metadata.json
-│           ├── cb_ada_1662821399_model.joblib
-│           ├── cb_ada_1662821399_pca_object.pkl
-│           ├── cb_ada_1662821399_svm_model.joblib
-│           ├── cb_ada_1662821399_trained_dates_df.pkl
-│           └── cb_ada_1662821399_trained_df.pkl
-
-```

docs/freqai-feature-engineering.md

@@ -1,408 +0,0 @@
-# Feature engineering
-
-## Defining the features
-
-Low level feature engineering is performed in the user strategy within a set of functions called `feature_engineering_*`. These function set the `base features` such as, `RSI`, `MFI`, `EMA`, `SMA`, time of day, volume, etc. The `base features` can be custom indicators or they can be imported from any technical-analysis library that you can find. FreqAI is equipped with a set of functions to simplify rapid large-scale feature engineering:
-
-|  Function | Description |
-|---------------|-------------|
-| `feature_engineering_expand_all()` | This optional function will automatically expand the defined features on the config defined `indicator_periods_candles`, `include_timeframes`, `include_shifted_candles`, and `include_corr_pairs`.
-| `feature_engineering_expand_basic()` | This optional function will automatically expand the defined features on the config defined `include_timeframes`, `include_shifted_candles`, and `include_corr_pairs`. Note: this function does *not* expand across `indicator_periods_candles`.
-| `feature_engineering_standard()` | This optional function will be called once with the dataframe of the base timeframe. This is the final function to be called, which means that the dataframe entering this function will contain all the features and columns from the base asset created by the other `feature_engineering_expand` functions. This function is a good place to do custom exotic feature extractions (e.g. tsfresh). This function is also a good place for any feature that should not be auto-expanded upon (e.g., day of the week).
-| `set_freqai_targets()` | Required function to set the targets for the model. All targets must be prepended with `&` to be recognized by the FreqAI internals.
-
-Meanwhile, high level feature engineering is handled within `"feature_parameters":{}` in the FreqAI config. Within this file, it is possible to decide large scale feature expansions on top of the `base_features` such as "including correlated pairs" or "including informative timeframes" or even "including recent candles."
-
-It is advisable to start from the template `feature_engineering_*` functions in the source provided example strategy (found in `templates/FreqaiExampleStrategy.py`) to ensure that the feature definitions are following the correct conventions. Here is an example of how to set the indicators and labels in the strategy:
-
-```python
-    def feature_engineering_expand_all(self, dataframe: DataFrame, period, metadata, **kwargs) -> DataFrame:
-        """
-        *Only functional with FreqAI enabled strategies*
-        This function will automatically expand the defined features on the config defined
-        `indicator_periods_candles`, `include_timeframes`, `include_shifted_candles`, and
-        `include_corr_pairs`. In other words, a single feature defined in this function
-        will automatically expand to a total of
-        `indicator_periods_candles` * `include_timeframes` * `include_shifted_candles` *
-        `include_corr_pairs` numbers of features added to the model.
-
-        All features must be prepended with `%` to be recognized by FreqAI internals.
-
-        Access metadata such as the current pair/timeframe/period with:
-
-        `metadata["pair"]` `metadata["tf"]`  `metadata["period"]`
-
-        :param df: strategy dataframe which will receive the features
-        :param period: period of the indicator - usage example:
-        :param metadata: metadata of current pair
-        dataframe["%-ema-period"] = ta.EMA(dataframe, timeperiod=period)
-        """
-
-        dataframe["%-rsi-period"] = ta.RSI(dataframe, timeperiod=period)
-        dataframe["%-mfi-period"] = ta.MFI(dataframe, timeperiod=period)
-        dataframe["%-adx-period"] = ta.ADX(dataframe, timeperiod=period)
-        dataframe["%-sma-period"] = ta.SMA(dataframe, timeperiod=period)
-        dataframe["%-ema-period"] = ta.EMA(dataframe, timeperiod=period)
-
-        bollinger = qtpylib.bollinger_bands(
-            qtpylib.typical_price(dataframe), window=period, stds=2.2
-        )
-        dataframe["bb_lowerband-period"] = bollinger["lower"]
-        dataframe["bb_middleband-period"] = bollinger["mid"]
-        dataframe["bb_upperband-period"] = bollinger["upper"]
-
-        dataframe["%-bb_width-period"] = (
-            dataframe["bb_upperband-period"]
-            - dataframe["bb_lowerband-period"]
-        ) / dataframe["bb_middleband-period"]
-        dataframe["%-close-bb_lower-period"] = (
-            dataframe["close"] / dataframe["bb_lowerband-period"]
-        )
-
-        dataframe["%-roc-period"] = ta.ROC(dataframe, timeperiod=period)
-
-        dataframe["%-relative_volume-period"] = (
-            dataframe["volume"] / dataframe["volume"].rolling(period).mean()
-        )
-
-        return dataframe
-
-    def feature_engineering_expand_basic(self, dataframe: DataFrame, metadata, **kwargs) -> DataFrame:
-        """
-        *Only functional with FreqAI enabled strategies*
-        This function will automatically expand the defined features on the config defined
-        `include_timeframes`, `include_shifted_candles`, and `include_corr_pairs`.
-        In other words, a single feature defined in this function
-        will automatically expand to a total of
-        `include_timeframes` * `include_shifted_candles` * `include_corr_pairs`
-        numbers of features added to the model.
-
-        Features defined here will *not* be automatically duplicated on user defined
-        `indicator_periods_candles`
-
-        Access metadata such as the current pair/timeframe with:
-
-        `metadata["pair"]` `metadata["tf"]`
-
-        All features must be prepended with `%` to be recognized by FreqAI internals.
-
-        :param df: strategy dataframe which will receive the features
-        :param metadata: metadata of current pair
-        dataframe["%-pct-change"] = dataframe["close"].pct_change()
-        dataframe["%-ema-200"] = ta.EMA(dataframe, timeperiod=200)
-        """
-        dataframe["%-pct-change"] = dataframe["close"].pct_change()
-        dataframe["%-raw_volume"] = dataframe["volume"]
-        dataframe["%-raw_price"] = dataframe["close"]
-        return dataframe
-
-    def feature_engineering_standard(self, dataframe: DataFrame, metadata, **kwargs) -> DataFrame:
-        """
-        *Only functional with FreqAI enabled strategies*
-        This optional function will be called once with the dataframe of the base timeframe.
-        This is the final function to be called, which means that the dataframe entering this
-        function will contain all the features and columns created by all other
-        freqai_feature_engineering_* functions.
-
-        This function is a good place to do custom exotic feature extractions (e.g. tsfresh).
-        This function is a good place for any feature that should not be auto-expanded upon
-        (e.g. day of the week).
-
-        Access metadata such as the current pair with:
-
-        `metadata["pair"]`
-
-        All features must be prepended with `%` to be recognized by FreqAI internals.
-
-        :param df: strategy dataframe which will receive the features
-        :param metadata: metadata of current pair
-        usage example: dataframe["%-day_of_week"] = (dataframe["date"].dt.dayofweek + 1) / 7
-        """
-        dataframe["%-day_of_week"] = (dataframe["date"].dt.dayofweek + 1) / 7
-        dataframe["%-hour_of_day"] = (dataframe["date"].dt.hour + 1) / 25
-        return dataframe
-
-    def set_freqai_targets(self, dataframe: DataFrame, metadata, **kwargs) -> DataFrame:
-        """
-        *Only functional with FreqAI enabled strategies*
-        Required function to set the targets for the model.
-        All targets must be prepended with `&` to be recognized by the FreqAI internals.
-
-        Access metadata such as the current pair with:
-
-        `metadata["pair"]`
-
-        :param df: strategy dataframe which will receive the targets
-        :param metadata: metadata of current pair
-        usage example: dataframe["&-target"] = dataframe["close"].shift(-1) / dataframe["close"]
-        """
-        dataframe["&-s_close"] = (
-            dataframe["close"]
-            .shift(-self.freqai_info["feature_parameters"]["label_period_candles"])
-            .rolling(self.freqai_info["feature_parameters"]["label_period_candles"])
-            .mean()
-            / dataframe["close"]
-            - 1
-            )
-        
-        return dataframe
-```
-
-In the presented example, the user does not wish to pass the `bb_lowerband` as a feature to the model,
-and has therefore not prepended it with `%`. The user does, however, wish to pass `bb_width` to the
-model for training/prediction and has therefore prepended it with `%`.
-
-After having defined the `base features`, the next step is to expand upon them using the powerful `feature_parameters` in the configuration file:
-
-```json
-    "freqai": {
-        //...
-        "feature_parameters" : {
-            "include_timeframes": ["5m","15m","4h"],
-            "include_corr_pairlist": [
-                "ETH/USD",
-                "LINK/USD",
-                "BNB/USD"
-            ],
-            "label_period_candles": 24,
-            "include_shifted_candles": 2,
-            "indicator_periods_candles": [10, 20]
-        },
-        //...
-    }
-```
-
-The `include_timeframes` in the config above are the timeframes (`tf`) of each call to `feature_engineering_expand_*()` in the strategy. In the presented case, the user is asking for the `5m`, `15m`, and `4h` timeframes of the `rsi`, `mfi`, `roc`, and `bb_width` to be included in the feature set.
-
-You can ask for each of the defined features to be included also for informative pairs using the `include_corr_pairlist`. This means that the feature set will include all the features from `feature_engineering_expand_*()` on all the `include_timeframes` for each of the correlated pairs defined in the config (`ETH/USD`, `LINK/USD`, and `BNB/USD` in the presented example).
-
-`include_shifted_candles` indicates the number of previous candles to include in the feature set. For example, `include_shifted_candles: 2` tells FreqAI to include the past 2 candles for each of the features in the feature set.
-
-In total, the number of features the user of the presented example strategy has created is: length of `include_timeframes` * no. features in `feature_engineering_expand_*()` * length of `include_corr_pairlist` * no. `include_shifted_candles` * length of `indicator_periods_candles`
- $= 3 * 3 * 3 * 2 * 2 = 108$.
- 
- !!! note "Learn more about creative feature engineering"
-    Check out our [medium article](https://emergentmethods.medium.com/freqai-from-price-to-prediction-6fadac18b665) geared toward helping users learn how to creatively engineer features.
-
-### Gain finer control over `feature_engineering_*` functions with `metadata`
-
-All `feature_engineering_*` and `set_freqai_targets()` functions are passed a `metadata` dictionary which contains information about the `pair`, `tf` (timeframe), and `period` that FreqAI is automating for feature building. As such, a user can use `metadata` inside `feature_engineering_*` functions as criteria for blocking/reserving features for certain timeframes, periods, pairs etc.
-
-```python
-def feature_engineering_expand_all(self, dataframe: DataFrame, period, metadata, **kwargs) -> DataFrame:
-    if metadata["tf"] == "1h":
-        dataframe["%-roc-period"] = ta.ROC(dataframe, timeperiod=period)
-```
-
-This will block `ta.ROC()` from being added to any timeframes other than `"1h"`.
-
-### Returning additional info from training
-
-Important metrics can be returned to the strategy at the end of each model training by assigning them to `dk.data['extra_returns_per_train']['my_new_value'] = XYZ` inside the custom prediction model class. 
-
-FreqAI takes the `my_new_value` assigned in this dictionary and expands it to fit the dataframe that is returned to the strategy. You can then use the returned metrics in your strategy through `dataframe['my_new_value']`. An example of how return values can be used in FreqAI are the `&*_mean` and `&*_std` values that are used to [created a dynamic target threshold](freqai-configuration.md#creating-a-dynamic-target-threshold).
-
-Another example, where the user wants to use live metrics from the trade database, is shown below:
-
-```json
-    "freqai": {
-        "extra_returns_per_train": {"total_profit": 4}
-    }
-```
-
-You need to set the standard dictionary in the config so that FreqAI can return proper dataframe shapes. These values will likely be overridden by the prediction model, but in the case where the model has yet to set them, or needs a default initial value, the pre-set values are what will be returned.
-
-### Weighting features for temporal importance
-
-FreqAI allows you to set a `weight_factor` to weight recent data more strongly than past data via an exponential function:
-
-$$ W_i = \exp(\frac{-i}{\alpha*n}) $$
-
-where $W_i$ is the weight of data point $i$ in a total set of $n$ data points. Below is a figure showing the effect of different weight factors on the data points in a feature set.
-
-![weight-factor](assets/freqai_weight-factor.jpg)
-
-## Building the data pipeline
-
-By default, FreqAI builds a dynamic pipeline based on user configuration settings. The default settings are robust and designed to work with a variety of methods. These two steps are a `MinMaxScaler(-1,1)` and a `VarianceThreshold` which removes any column that has 0 variance. Users can activate other steps with more configuration parameters. For example if users add `use_SVM_to_remove_outliers: true` to the `freqai` config, then FreqAI will automatically add the [`SVMOutlierExtractor`](#identifying-outliers-using-a-support-vector-machine-svm) to the pipeline. Likewise, users can add `principal_component_analysis: true` to the `freqai` config to activate PCA. The [DissimilarityIndex](#identifying-outliers-with-the-dissimilarity-index-di) is activated with `DI_threshold: 1`. Finally, noise can also be added to the data with `noise_standard_deviation: 0.1`. Finally, users can add [DBSCAN](#identifying-outliers-with-dbscan) outlier removal with `use_DBSCAN_to_remove_outliers: true`.
-
-!!! note "More information available"
-    Please review the [parameter table](freqai-parameter-table.md) for more information on these parameters.
-
-
-### Customizing the pipeline
-
-Users are encouraged to customize the data pipeline to their needs by building their own data pipeline. This can be done by simply setting `dk.feature_pipeline` to their desired `Pipeline` object inside their `IFreqaiModel` `train()` function, or if they prefer not to touch the `train()` function, they can override `define_data_pipeline`/`define_label_pipeline` functions in their `IFreqaiModel`:
-
-!!! note "More information available"
-    FreqAI uses the [`DataSieve`](https://github.com/emergentmethods/datasieve) pipeline, which follows the SKlearn pipeline API, but adds, among other features, coherence between the X, y, and sample_weight vector point removals, feature removal, feature name following. 
-
-```python
-from datasieve.transforms import SKLearnWrapper, DissimilarityIndex
-from datasieve.pipeline import Pipeline
-from sklearn.preprocessing import QuantileTransformer, StandardScaler
-from freqai.base_models import BaseRegressionModel
-
-
-class MyFreqaiModel(BaseRegressionModel):
-    """
-    Some cool custom model
-    """
-    def fit(self, data_dictionary: Dict, dk: FreqaiDataKitchen, **kwargs) -> Any:
-        """
-        My custom fit function
-        """
-        model = cool_model.fit()
-        return model
-
-    def define_data_pipeline(self) -> Pipeline:
-        """
-        User defines their custom feature pipeline here (if they wish)
-        """
-        feature_pipeline = Pipeline([
-            ('qt', SKLearnWrapper(QuantileTransformer(output_distribution='normal'))),
-            ('di', ds.DissimilarityIndex(di_threshold=1))
-        ])
-
-        return feature_pipeline
-    
-    def define_label_pipeline(self) -> Pipeline:
-        """
-        User defines their custom label pipeline here (if they wish)
-        """
-        label_pipeline = Pipeline([
-            ('qt', SKLearnWrapper(StandardScaler())),
-        ])
-
-        return label_pipeline
-```
-
-Here, you are defining the exact pipeline that will be used for your feature set during training and prediction. You can use *most* SKLearn transformation steps by wrapping them in the `SKLearnWrapper` class as shown above. In addition, you can use any of the transformations available in the [`DataSieve` library](https://github.com/emergentmethods/datasieve). 
-
-You can easily add your own transformation by creating a class that inherits from the datasieve `BaseTransform` and implementing your `fit()`, `transform()` and `inverse_transform()` methods:
-
-```python
-from datasieve.transforms.base_transform import BaseTransform
-# import whatever else you need
-
-class MyCoolTransform(BaseTransform):
-    def __init__(self, **kwargs):
-        self.param1 = kwargs.get('param1', 1)
-
-    def fit(self, X, y=None, sample_weight=None, feature_list=None, **kwargs):
-        # do something with X, y, sample_weight, or/and feature_list
-        return X, y, sample_weight, feature_list
-
-    def transform(self, X, y=None, sample_weight=None,
-                  feature_list=None, outlier_check=False, **kwargs):
-        # do something with X, y, sample_weight, or/and feature_list
-        return X, y, sample_weight, feature_list
-
-    def inverse_transform(self, X, y=None, sample_weight=None, feature_list=None, **kwargs):
-        # do/dont do something with X, y, sample_weight, or/and feature_list
-        return X, y, sample_weight, feature_list
-```
-
-!!! note "Hint"
-    You can define this custom class in the same file as your `IFreqaiModel`.
-
-### Migrating a custom `IFreqaiModel` to the new Pipeline
-
-If you have created your own custom `IFreqaiModel` with a custom `train()`/`predict()` function, *and* you still rely on `data_cleaning_train/predict()`, then you will need to migrate to the new pipeline. If your model does *not* rely on `data_cleaning_train/predict()`, then you do not need to worry about this migration.
-
-More details about the migration can be found [here](strategy_migration.md#freqai---new-data-pipeline).
-
-## Outlier detection
-
-Equity and crypto markets suffer from a high level of non-patterned noise in the form of outlier data points. FreqAI implements a variety of methods to identify such outliers and hence mitigate risk.
-
-### Identifying outliers with the Dissimilarity Index (DI)
-
-The Dissimilarity Index (DI) aims to quantify the uncertainty associated with each prediction made by the model. 
-
-You can tell FreqAI to remove outlier data points from the training/test data sets using the DI by including the following statement in the config:
-
-```json
-    "freqai": {
-        "feature_parameters" : {
-            "DI_threshold": 1
-        }
-    }
-```
-
-Which will add `DissimilarityIndex` step to your `feature_pipeline` and set the threshold to 1. The DI allows predictions which are outliers (not existent in the model feature space) to be thrown out due to low levels of certainty. To do so, FreqAI measures the distance between each training data point (feature vector), $X_{a}$, and all other training data points:
-
-$$ d_{ab} = \sqrt{\sum_{j=1}^p(X_{a,j}-X_{b,j})^2} $$
-
-where $d_{ab}$ is the distance between the normalized points $a$ and $b$, and $p$ is the number of features, i.e., the length of the vector $X$. The characteristic distance, $\overline{d}$, for a set of training data points is simply the mean of the average distances:
-
-$$ \overline{d} = \sum_{a=1}^n(\sum_{b=1}^n(d_{ab}/n)/n) $$
-
-$\overline{d}$ quantifies the spread of the training data, which is compared to the distance between a new prediction feature vectors, $X_k$ and all the training data:
-
-$$ d_k = \arg \min d_{k,i} $$
-
-This enables the estimation of the Dissimilarity Index as:
-
-$$ DI_k = d_k/\overline{d} $$
-
-You can tweak the DI through the `DI_threshold` to increase or decrease the extrapolation of the trained model. A higher `DI_threshold` means that the DI is more lenient and allows predictions further away from the training data to be used whilst a lower `DI_threshold` has the opposite effect and hence discards more predictions.
-
-Below is a figure that describes the DI for a 3D data set.
-
-![DI](assets/freqai_DI.jpg)
-
-### Identifying outliers using a Support Vector Machine (SVM)
-
-You can tell FreqAI to remove outlier data points from the training/test data sets using a Support Vector Machine (SVM) by including the following statement in the config:
-
-```json
-    "freqai": {
-        "feature_parameters" : {
-            "use_SVM_to_remove_outliers": true
-        }
-    }
-```
-
-Which will add `SVMOutlierExtractor` step to your `feature_pipeline`. The SVM will be trained on the training data and any data point that the SVM deems to be beyond the feature space will be removed.
-
-You can elect to provide additional parameters for the SVM, such as `shuffle`, and `nu` via the `feature_parameters.svm_params` dictionary in the config.
-
-The parameter `shuffle` is by default set to `False` to ensure consistent results. If it is set to `True`, running the SVM multiple times on the same data set might result in different outcomes due to `max_iter` being to low for the algorithm to reach the demanded `tol`. Increasing `max_iter` solves this issue but causes the procedure to take longer time.
-
-The parameter `nu`, *very* broadly, is the amount of data points that should be considered outliers and should be between 0 and 1.
-
-### Identifying outliers with DBSCAN
-
-You can configure FreqAI to use DBSCAN to cluster and remove outliers from the training/test data set or incoming outliers from predictions, by activating `use_DBSCAN_to_remove_outliers` in the config:
-
-```json
-    "freqai": {
-        "feature_parameters" : {
-            "use_DBSCAN_to_remove_outliers": true
-        }
-    }
-```
-
-Which will add the `DataSieveDBSCAN` step to your `feature_pipeline`. This is an unsupervised machine learning algorithm that clusters data without needing to know how many clusters there should be.
-
-Given a number of data points $N$, and a distance $\varepsilon$, DBSCAN clusters the data set by setting all data points that have $N-1$ other data points within a distance of $\varepsilon$ as *core points*. A data point that is within a distance of $\varepsilon$ from a *core point* but that does not have $N-1$ other data points within a distance of $\varepsilon$ from itself is considered an *edge point*. A cluster is then the collection of *core points* and *edge points*. Data points that have no other data points at a distance $<\varepsilon$ are considered outliers. The figure below shows a cluster with $N = 3$.
-
-![dbscan](assets/freqai_dbscan.jpg)
-
-FreqAI uses `sklearn.cluster.DBSCAN` (details are available on scikit-learn's webpage [here](https://scikit-learn.org/stable/modules/generated/sklearn.cluster.DBSCAN.html) (external website)) with `min_samples` ($N$) taken as 1/4 of the no. of time points (candles) in the feature set. `eps` ($\varepsilon$) is computed automatically as the elbow point in the *k-distance graph* computed from the nearest neighbors in the pairwise distances of all data points in the feature set.
-
-
-### Data dimensionality reduction with Principal Component Analysis
-
-You can reduce the dimensionality of your features by activating the principal_component_analysis in the config:
-
-```json
-    "freqai": {
-        "feature_parameters" : {
-            "principal_component_analysis": true
-        }
-    }
-```
-
-This will perform PCA on the features and reduce their dimensionality so that the explained variance of the data set is >= 0.999. Reducing data dimensionality makes training the model faster and hence allows for more up-to-date models.

docs/freqai-parameter-table.md

@@ -1,117 +0,0 @@
-# Parameter table
-
-The table below will list all configuration parameters available for FreqAI. Some of the parameters are exemplified in `config_examples/config_freqai.example.json`.
-
-Mandatory parameters are marked as **Required** and have to be set in one of the suggested ways.
-
-### General configuration parameters
-
-|  Parameter | Description |
-|------------|-------------|
-|  |  **General configuration parameters within the `config.freqai` tree**
-| `freqai` | **Required.** <br> The parent dictionary containing all the parameters for controlling FreqAI. <br> **Datatype:** Dictionary.
-| `train_period_days` | **Required.** <br> Number of days to use for the training data (width of the sliding window). <br> **Datatype:** Positive integer.
-| `backtest_period_days` | **Required.** <br> Number of days to inference from the trained model before sliding the `train_period_days` window defined above, and retraining the model during backtesting (more info [here](freqai-running.md#backtesting)). This can be fractional days, but beware that the provided `timerange` will be divided by this number to yield the number of trainings necessary to complete the backtest. <br> **Datatype:** Float.
-| `identifier` | **Required.** <br> A unique ID for the current model. If models are saved to disk, the `identifier` allows for reloading specific pre-trained models/data. <br> **Datatype:** String.
-| `live_retrain_hours` | Frequency of retraining during dry/live runs. <br> **Datatype:** Float > 0. <br> Default: `0` (models retrain as often as possible).
-| `expiration_hours` | Avoid making predictions if a model is more than `expiration_hours` old. <br> **Datatype:** Positive integer. <br> Default: `0` (models never expire).
-| `purge_old_models` | Number of models to keep on disk (not relevant to backtesting). Default is 2, which means that dry/live runs will keep the latest 2 models on disk. Setting to 0 keeps all models. This parameter also accepts a boolean to maintain backwards compatibility. <br> **Datatype:** Integer. <br> Default: `2`.
-| `save_backtest_models` | Save models to disk when running backtesting. Backtesting operates most efficiently by saving the prediction data and reusing them directly for subsequent runs (when you wish to tune entry/exit parameters). Saving backtesting models to disk also allows to use the same model files for starting a dry/live instance with the same model `identifier`. <br> **Datatype:** Boolean. <br> Default: `False` (no models are saved).
-| `fit_live_predictions_candles` | Number of historical candles to use for computing target (label) statistics from prediction data, instead of from the training dataset (more information can be found [here](freqai-configuration.md#creating-a-dynamic-target-threshold)). <br> **Datatype:** Positive integer.
-| `continual_learning` | Use the final state of the most recently trained model as starting point for the new model, allowing for incremental learning (more information can be found [here](freqai-running.md#continual-learning)). Beware that this is currently a naive approach to incremental learning, and it has a high probability of overfitting/getting stuck in local minima while the market moves away from your model. We have the connections here primarily for experimental purposes and so that it is ready for more mature approaches to continual learning in chaotic systems like the crypto market. <br> **Datatype:** Boolean. <br> Default: `False`.
-| `write_metrics_to_disk` | Collect train timings, inference timings and cpu usage in json file. <br> **Datatype:** Boolean. <br> Default: `False`
-| `data_kitchen_thread_count` | <br> Designate the number of threads you want to use for data processing (outlier methods, normalization, etc.). This has no impact on the number of threads used for training. If user does not set it (default), FreqAI will use max number of threads - 2 (leaving 1 physical core available for Freqtrade bot and FreqUI) <br> **Datatype:** Positive integer.
-| `activate_tensorboard` | <br> Indicate whether or not to activate tensorboard for the tensorboard enabled modules (currently Reinforcment Learning, XGBoost, Catboost, and PyTorch). Tensorboard needs Torch installed, which means you will need the torch/RL docker image or you need to answer "yes" to the install question about whether or not you wish to install Torch. <br> **Datatype:** Boolean. <br> Default: `True`.
-
-### Feature parameters
-
-|  Parameter | Description |
-|------------|-------------|
-|  |  **Feature parameters within the `freqai.feature_parameters` sub dictionary**
-| `feature_parameters` | A dictionary containing the parameters used to engineer the feature set. Details and examples are shown [here](freqai-feature-engineering.md). <br> **Datatype:** Dictionary.
-| `include_timeframes` | A list of timeframes that all indicators in `feature_engineering_expand_*()` will be created for. The list is added as features to the base indicators dataset. <br> **Datatype:** List of timeframes (strings).
-| `include_corr_pairlist` | A list of correlated coins that FreqAI will add as additional features to all `pair_whitelist` coins. All indicators set in `feature_engineering_expand_*()` during feature engineering (see details [here](freqai-feature-engineering.md)) will be created for each correlated coin. The correlated coins features are added to the base indicators dataset. <br> **Datatype:** List of assets (strings).
-| `label_period_candles` | Number of candles into the future that the labels are created for. This can be used in `set_freqai_targets()` (see `templates/FreqaiExampleStrategy.py` for detailed usage). This parameter is not necessarily required, you can create custom labels and choose whether to make use of this parameter or not. Please see `templates/FreqaiExampleStrategy.py` to see the example usage. <br> **Datatype:** Positive integer.
-| `include_shifted_candles` | Add features from previous candles to subsequent candles with the intent of adding historical information. If used, FreqAI will duplicate and shift all features from the `include_shifted_candles` previous candles so that the information is available for the subsequent candle. <br> **Datatype:** Positive integer.
-| `weight_factor` | Weight training data points according to their recency (see details [here](freqai-feature-engineering.md#weighting-features-for-temporal-importance)). <br> **Datatype:** Positive float (typically < 1).
-| `indicator_max_period_candles` | **No longer used (#7325)**. Replaced by `startup_candle_count` which is set in the [strategy](freqai-configuration.md#building-a-freqai-strategy). `startup_candle_count` is timeframe independent and defines the maximum *period* used in `feature_engineering_*()` for indicator creation. FreqAI uses this parameter together with the maximum timeframe in `include_time_frames` to calculate how many data points to download such that the first data point does not include a NaN. <br> **Datatype:** Positive integer.
-| `indicator_periods_candles` | Time periods to calculate indicators for. The indicators are added to the base indicator dataset. <br> **Datatype:** List of positive integers.
-| `principal_component_analysis` | Automatically reduce the dimensionality of the data set using Principal Component Analysis. See details about how it works [here](freqai-feature-engineering.md#data-dimensionality-reduction-with-principal-component-analysis) <br> **Datatype:** Boolean. <br> Default: `False`.
-| `plot_feature_importances` | Create a feature importance plot for each model for the top/bottom `plot_feature_importances` number of features. Plot is stored in `user_data/models/<identifier>/sub-train-<COIN>_<timestamp>.html`. <br> **Datatype:** Integer. <br> Default: `0`.
-| `DI_threshold` | Activates the use of the Dissimilarity Index for outlier detection when set to > 0. See details about how it works [here](freqai-feature-engineering.md#identifying-outliers-with-the-dissimilarity-index-di). <br> **Datatype:** Positive float (typically < 1).
-| `use_SVM_to_remove_outliers` | Train a support vector machine to detect and remove outliers from the training dataset, as well as from incoming data points. See details about how it works [here](freqai-feature-engineering.md#identifying-outliers-using-a-support-vector-machine-svm). <br> **Datatype:** Boolean.
-| `svm_params` | All parameters available in Sklearn's `SGDOneClassSVM()`. See details about some select parameters [here](freqai-feature-engineering.md#identifying-outliers-using-a-support-vector-machine-svm). <br> **Datatype:** Dictionary.
-| `use_DBSCAN_to_remove_outliers` | Cluster data using the DBSCAN algorithm to identify and remove outliers from training and prediction data. See details about how it works [here](freqai-feature-engineering.md#identifying-outliers-with-dbscan). <br> **Datatype:** Boolean. 
-| `noise_standard_deviation` | If set, FreqAI adds noise to the training features with the aim of preventing overfitting. FreqAI generates random deviates from a gaussian distribution with a standard deviation of `noise_standard_deviation` and adds them to all data points. `noise_standard_deviation` should be kept relative to the normalized space, i.e., between -1 and 1. In other words, since data in FreqAI is always normalized to be between -1 and 1, `noise_standard_deviation: 0.05` would result in 32% of the data being randomly increased/decreased by more than 2.5% (i.e., the percent of data falling within the first standard deviation). <br> **Datatype:** Integer. <br> Default: `0`.
-| `outlier_protection_percentage` | Enable to prevent outlier detection methods from discarding too much data. If more than `outlier_protection_percentage` % of points are detected as outliers by the SVM or DBSCAN, FreqAI will log a warning message and ignore outlier detection, i.e., the original dataset will be kept intact. If the outlier protection is triggered, no predictions will be made based on the training dataset. <br> **Datatype:** Float. <br> Default: `30`.
-| `reverse_train_test_order` | Split the feature dataset (see below) and use the latest data split for training and test on historical split of the data. This allows the model to be trained up to the most recent data point, while avoiding overfitting. However, you should be careful to understand the unorthodox nature of this parameter before employing it. <br> **Datatype:** Boolean. <br> Default: `False` (no reversal).
-| `shuffle_after_split` | Split the data into train and test sets, and then shuffle both sets individually. <br> **Datatype:** Boolean. <br> Default: `False`.
-| `buffer_train_data_candles` | Cut `buffer_train_data_candles` off the beginning and end of the training data *after* the indicators were populated. The main example use is when predicting maxima and minima, the argrelextrema function  cannot know the maxima/minima at the edges of the timerange. To improve model accuracy, it is best to compute argrelextrema on the full timerange and then use this function to cut off the edges (buffer) by the kernel. In another case, if the targets are set to a shifted price movement, this buffer is unnecessary because the shifted candles at the end of the timerange will be NaN and FreqAI will automatically cut those off of the training dataset.<br> **Datatype:** Integer. <br> Default: `0`.
-
-### Data split parameters
-
-|  Parameter | Description |
-|------------|-------------|
-|  |  **Data split parameters within the `freqai.data_split_parameters` sub dictionary**
-| `data_split_parameters` | Include any additional parameters available from scikit-learn `test_train_split()`, which are shown [here](https://scikit-learn.org/stable/modules/generated/sklearn.model_selection.train_test_split.html) (external website). <br> **Datatype:** Dictionary.
-| `test_size` | The fraction of data that should be used for testing instead of training. <br> **Datatype:** Positive float < 1.
-| `shuffle` | Shuffle the training data points during training. Typically, to not remove the chronological order of data in time-series forecasting, this is set to `False`. <br> **Datatype:** Boolean. <br> Default: `False`.
-
-### Model training parameters
-
-|  Parameter | Description |
-|------------|-------------|
-|  |  **Model training parameters within the `freqai.model_training_parameters` sub dictionary**
-| `model_training_parameters` | A flexible dictionary that includes all parameters available by the selected model library. For example, if you use `LightGBMRegressor`, this dictionary can contain any parameter available by the `LightGBMRegressor` [here](https://lightgbm.readthedocs.io/en/latest/pythonapi/lightgbm.LGBMRegressor.html) (external website). If you select a different model, this dictionary can contain any parameter from that model. A list of the currently available models can be found [here](freqai-configuration.md#using-different-prediction-models).  <br> **Datatype:** Dictionary.
-| `n_estimators` | The number of boosted trees to fit in the training of the model. <br> **Datatype:** Integer.
-| `learning_rate` | Boosting learning rate during training of the model. <br> **Datatype:** Float.
-| `n_jobs`, `thread_count`, `task_type` | Set the number of threads for parallel processing and the `task_type` (`gpu` or `cpu`). Different model libraries use different parameter names. <br> **Datatype:** Float.
-
-### Reinforcement Learning parameters
-
-|  Parameter | Description |
-|------------|-------------|
-|  |  **Reinforcement Learning Parameters within the `freqai.rl_config` sub dictionary**
-| `rl_config` | A dictionary containing the control parameters for a Reinforcement Learning model. <br> **Datatype:** Dictionary.
-| `train_cycles` | Training time steps will be set based on the `train_cycles * number of training data points. <br> **Datatype:** Integer.
-| `max_trade_duration_candles`| Guides the agent training to keep trades below desired length. Example usage shown in `prediction_models/ReinforcementLearner.py` within the customizable `calculate_reward()` function. <br> **Datatype:** int.
-| `model_type` | Model string from stable_baselines3 or SBcontrib. Available strings include: `'TRPO', 'ARS', 'RecurrentPPO', 'MaskablePPO', 'PPO', 'A2C', 'DQN'`. User should ensure that `model_training_parameters` match those available to the corresponding stable_baselines3 model by visiting their documentation. [PPO doc](https://stable-baselines3.readthedocs.io/en/master/modules/ppo.html) (external website) <br> **Datatype:** string.
-| `policy_type` | One of the available policy types from stable_baselines3 <br> **Datatype:** string.
-| `max_training_drawdown_pct` | The maximum drawdown that the agent is allowed to experience during training. <br> **Datatype:** float. <br> Default: 0.8
-| `cpu_count` | Number of threads/cpus to dedicate to the Reinforcement Learning training process (depending on if `ReinforcementLearning_multiproc` is selected or not). Recommended to leave this untouched, by default, this value is set to the total number of physical cores minus 1. <br> **Datatype:** int. 
-| `model_reward_parameters` | Parameters used inside the customizable `calculate_reward()` function in `ReinforcementLearner.py` <br> **Datatype:** int.
-| `add_state_info` | Tell FreqAI to include state information in the feature set for training and inferencing. The current state variables include trade duration, current profit, trade position. This is only available in dry/live runs, and is automatically switched to false for backtesting. <br> **Datatype:** bool. <br> Default: `False`.
-| `net_arch` | Network architecture which is well described in [`stable_baselines3` doc](https://stable-baselines3.readthedocs.io/en/master/guide/custom_policy.html#examples). In summary: `[<shared layers>, dict(vf=[<non-shared value network layers>], pi=[<non-shared policy network layers>])]`. By default this is set to `[128, 128]`, which defines 2 shared hidden layers with 128 units each.
-| `randomize_starting_position` | Randomize the starting point of each episode to avoid overfitting. <br> **Datatype:** bool. <br> Default: `False`.
-| `drop_ohlc_from_features` | Do not include the normalized ohlc data in the feature set passed to the agent during training (ohlc will still be used for driving the environment in all cases) <br> **Datatype:** Boolean. <br> **Default:** `False`
-| `progress_bar` | Display a progress bar with the current progress, elapsed time and estimated remaining time. <br> **Datatype:** Boolean. <br> Default: `False`.
-
-### PyTorch parameters
-
-#### general
-
-|  Parameter | Description |
-|------------|-------------|
-|  |  **Model training parameters within the `freqai.model_training_parameters` sub dictionary**
-| `learning_rate` | Learning rate to be passed to the optimizer. <br> **Datatype:** float. <br> Default: `3e-4`.
-| `model_kwargs` | Parameters to be passed to the model class. <br> **Datatype:** dict. <br> Default: `{}`.
-| `trainer_kwargs` | Parameters to be passed to the trainer class. <br> **Datatype:** dict. <br> Default: `{}`.
-
-#### trainer_kwargs
-
-| Parameter    | Description |
-|--------------|-------------|
-|              |  **Model training parameters within the `freqai.model_training_parameters.model_kwargs` sub dictionary**
-| `n_epochs`   | The `n_epochs` parameter is a crucial setting in the PyTorch training loop that determines the number of times the entire training dataset will be used to update the model's parameters. An epoch represents one full pass through the entire training dataset. Overrides `n_steps`. Either `n_epochs` or `n_steps` must be set. <br><br> **Datatype:** int. optional. <br> Default: `10`.
-| `n_steps`    | An alternative way of setting `n_epochs` -  the number of training iterations to run. Iteration here refer to the number of times we call `optimizer.step()`. Ignored if `n_epochs` is set. A simplified version of the function: <br><br> n_epochs = n_steps / (n_obs / batch_size) <br><br> The motivation here is that `n_steps` is easier to optimize and keep stable across different n_obs - the number of data points.  <br> <br> **Datatype:** int. optional. <br> Default: `None`.
-| `batch_size` | The size of the batches to use during training. <br><br> **Datatype:** int. <br> Default: `64`.
-
-
-### Additional parameters
-
-|  Parameter | Description |
-|------------|-------------|
-|  |  **Extraneous parameters**
-| `freqai.keras` | If the selected model makes use of Keras (typical for TensorFlow-based prediction models), this flag needs to be activated so that the model save/loading follows Keras standards. <br> **Datatype:** Boolean. <br> Default: `False`.
-| `freqai.conv_width` | The width of a neural network input tensor. This replaces the need for shifting candles (`include_shifted_candles`) by feeding in historical data points as the second dimension of the tensor. Technically, this parameter can also be used for regressors, but it only adds computational overhead and does not change the model training/prediction. <br> **Datatype:** Integer. <br> Default: `2`.
-| `freqai.reduce_df_footprint` | Recast all numeric columns to float32/int32, with the objective of reducing ram/disk usage and decreasing train/inference timing. This parameter is set in the main level of the Freqtrade configuration file (not inside FreqAI). <br> **Datatype:** Boolean. <br> Default: `False`.

docs/freqai-reinforcement-learning.md

@@ -1,280 +0,0 @@
-# Reinforcement Learning
-
-!!! Note "Installation size"
-    Reinforcement learning dependencies include large packages such as `torch`, which should be explicitly requested during `./setup.sh -i` by answering "y" to the question "Do you also want dependencies for freqai-rl (~700mb additional space required) [y/N]?".
-    Users who prefer docker should ensure they use the docker image appended with `_freqairl`.
-
-## Background and terminology
-
-### What is RL and why does FreqAI need it?
-
-Reinforcement learning involves two important components, the *agent* and the training *environment*. During agent training, the agent moves through historical data candle by candle, always making 1 of a set of actions: Long entry, long exit, short entry, short exit, neutral). During this training process, the environment tracks the performance of these actions and rewards the agent according to a custom user made `calculate_reward()` (here we offer a default reward for users to build on if they wish [details here](#creating-a-custom-reward-function)). The reward is used to train weights in a neural network.
-
-A second important component of the FreqAI RL implementation is the use of *state* information. State information is fed into the network at each step, including current profit, current position, and current trade duration. These are used to train the agent in the training environment, and to reinforce the agent in dry/live (this functionality is not available in backtesting). *FreqAI + Freqtrade is a perfect match for this reinforcing mechanism since this information is readily available in live deployments.*
-
-Reinforcement learning is a natural progression for FreqAI, since it adds a new layer of adaptivity and market reactivity that Classifiers and Regressors cannot match. However, Classifiers and Regressors have strengths that RL does not have such as robust predictions. Improperly trained RL agents may find "cheats" and "tricks" to maximize reward without actually winning any trades. For this reason, RL is more complex and demands a higher level of understanding than typical Classifiers and Regressors.
-
-### The RL interface
-
-With the current framework, we aim to expose the training environment via the common "prediction model" file, which is a user inherited `BaseReinforcementLearner` object (e.g. `freqai/prediction_models/ReinforcementLearner`). Inside this user class, the RL environment is available and customized via `MyRLEnv` as [shown below](#creating-a-custom-reward-function).
-
-We envision the majority of users focusing their effort on creative design of the `calculate_reward()` function [details here](#creating-a-custom-reward-function), while leaving the rest of the environment untouched. Other users may not touch the environment at all, and they will only play with the configuration settings and the powerful feature engineering that already exists in FreqAI. Meanwhile, we enable advanced users to create their own model classes entirely.
-
-The framework is built on stable_baselines3 (torch) and OpenAI gym for the base environment class. But generally speaking, the model class is well isolated. Thus, the addition of competing libraries can be easily integrated into the existing framework. For the environment, it is inheriting from `gym.Env` which means that it is necessary to write an entirely new environment in order to switch to a different library.
-
-### Important considerations
-
-As explained above, the agent is "trained" in an artificial trading "environment". In our case, that environment may seem quite similar to a real Freqtrade backtesting environment, but it is *NOT*. In fact, the RL training environment is much more simplified. It does not incorporate any of the complicated strategy logic, such as callbacks like `custom_exit`, `custom_stoploss`, leverage controls, etc. The RL environment is instead a very "raw" representation of the true market, where the agent has free will to learn the policy (read: stoploss, take profit, etc.) which is enforced by the `calculate_reward()`. Thus, it is important to consider that the agent training environment is not identical to the real world.
-
-## Running Reinforcement Learning
-
-Setting up and running a Reinforcement Learning model is the same as running a Regressor or Classifier. The same two flags, `--freqaimodel` and `--strategy`, must be defined on the command line:
-
-```bash
-freqtrade trade --freqaimodel ReinforcementLearner --strategy MyRLStrategy --config config.json
-```
-
-where `ReinforcementLearner` will use the templated `ReinforcementLearner` from `freqai/prediction_models/ReinforcementLearner` (or a custom user defined one located in `user_data/freqaimodels`). The strategy, on the other hand, follows the same base [feature engineering](freqai-feature-engineering.md) with `feature_engineering_*` as a typical Regressor. The difference lies in the creation of the targets, Reinforcement Learning doesn't require them. However, FreqAI requires a default (neutral) value to be set in the action column:
-
-```python
-    def set_freqai_targets(self, dataframe, **kwargs) -> DataFrame:
-        """
-        *Only functional with FreqAI enabled strategies*
-        Required function to set the targets for the model.
-        All targets must be prepended with `&` to be recognized by the FreqAI internals.
-
-        More details about feature engineering available:
-
-        https://www.freqtrade.io/en/latest/freqai-feature-engineering
-
-        :param df: strategy dataframe which will receive the targets
-        usage example: dataframe["&-target"] = dataframe["close"].shift(-1) / dataframe["close"]
-        """
-        # For RL, there are no direct targets to set. This is filler (neutral)
-        # until the agent sends an action.
-        dataframe["&-action"] = 0
-        return dataframe
-```
-
-Most of the function remains the same as for typical Regressors, however, the function below shows how the strategy must pass the raw price data to the agent so that it has access to raw OHLCV in the training environment:
-
-```python
-    def feature_engineering_standard(self, dataframe: DataFrame, **kwargs) -> DataFrame:
-        # The following features are necessary for RL models
-        dataframe[f"%-raw_close"] = dataframe["close"]
-        dataframe[f"%-raw_open"] = dataframe["open"]
-        dataframe[f"%-raw_high"] = dataframe["high"]
-        dataframe[f"%-raw_low"] = dataframe["low"]
-    return dataframe
-```
-
-Finally, there is no explicit "label" to make - instead it is necessary to assign the `&-action` column which will contain the agent's actions when accessed in `populate_entry/exit_trends()`. In the present example, the neutral action to 0. This value should align with the environment used. FreqAI provides two environments, both use 0 as the neutral action.
-
-After users realize there are no labels to set, they will soon understand that the agent is making its "own" entry and exit decisions. This makes strategy construction rather simple. The entry and exit signals come from the agent in the form of an integer - which are used directly to decide entries and exits in the strategy:
-
-```python
-    def populate_entry_trend(self, df: DataFrame, metadata: dict) -> DataFrame:
-
-        enter_long_conditions = [df["do_predict"] == 1, df["&-action"] == 1]
-
-        if enter_long_conditions:
-            df.loc[
-                reduce(lambda x, y: x & y, enter_long_conditions), ["enter_long", "enter_tag"]
-            ] = (1, "long")
-
-        enter_short_conditions = [df["do_predict"] == 1, df["&-action"] == 3]
-
-        if enter_short_conditions:
-            df.loc[
-                reduce(lambda x, y: x & y, enter_short_conditions), ["enter_short", "enter_tag"]
-            ] = (1, "short")
-
-        return df
-
-    def populate_exit_trend(self, df: DataFrame, metadata: dict) -> DataFrame:
-        exit_long_conditions = [df["do_predict"] == 1, df["&-action"] == 2]
-        if exit_long_conditions:
-            df.loc[reduce(lambda x, y: x & y, exit_long_conditions), "exit_long"] = 1
-
-        exit_short_conditions = [df["do_predict"] == 1, df["&-action"] == 4]
-        if exit_short_conditions:
-            df.loc[reduce(lambda x, y: x & y, exit_short_conditions), "exit_short"] = 1
-
-        return df
-```
-
-It is important to consider that `&-action` depends on which environment they choose to use. The example above shows 5 actions, where 0 is neutral, 1 is enter long, 2 is exit long, 3 is enter short and 4 is exit short.
-
-## Configuring the Reinforcement Learner
-
-In order to configure the `Reinforcement Learner` the following dictionary must exist in the `freqai` config:
-
-```json
-        "rl_config": {
-            "train_cycles": 25,
-            "add_state_info": true,
-            "max_trade_duration_candles": 300,
-            "max_training_drawdown_pct": 0.02,
-            "cpu_count": 8,
-            "model_type": "PPO",
-            "policy_type": "MlpPolicy",
-            "model_reward_parameters": {
-                "rr": 1,
-                "profit_aim": 0.025
-            }
-        }
-```
-
-Parameter details can be found [here](freqai-parameter-table.md), but in general the `train_cycles` decides how many times the agent should cycle through the candle data in its artificial environment to train weights in the model. `model_type` is a string which selects one of the available models in [stable_baselines](https://stable-baselines3.readthedocs.io/en/master/)(external link).
-
-!!! Note
-    If you would like to experiment with `continual_learning`, then you should set that value to `true` in the main `freqai` configuration dictionary. This will tell the Reinforcement Learning library to continue training new models from the final state of previous models, instead of retraining new models from scratch each time a retrain is initiated.
-
-!!! Note
-    Remember that the general `model_training_parameters` dictionary should contain all the model hyperparameter customizations for the particular `model_type`. For example, `PPO` parameters can be found [here](https://stable-baselines3.readthedocs.io/en/master/modules/ppo.html).
-
-## Creating a custom reward function
-
-!!! danger "Not for production"
-    Warning!
-    The reward function provided with the Freqtrade source code is a showcase of functionality designed to show/test as many possible environment control features as possible. It is also designed to run quickly on small computers. This is a benchmark, it is *not* for live production. Please beware that you will need to create your own custom_reward() function or use a template built by other users outside of the Freqtrade source code.
-
-As you begin to modify the strategy and the prediction model, you will quickly realize some important differences between the Reinforcement Learner and the Regressors/Classifiers. Firstly, the strategy does not set a target value (no labels!). Instead, you set the `calculate_reward()` function inside the `MyRLEnv` class (see below). A default `calculate_reward()` is provided inside `prediction_models/ReinforcementLearner.py` to demonstrate the necessary building blocks for creating rewards, but this is *not* designed for production. Users *must* create their own custom reinforcement learning model class or use a pre-built one from outside the Freqtrade source code and save it to `user_data/freqaimodels`. It is inside the `calculate_reward()` where creative theories about the market can be expressed. For example, you can reward your agent when it makes a winning trade, and penalize the agent when it makes a losing trade. Or perhaps, you wish to reward the agent for entering trades, and penalize the agent for sitting in trades too long. Below we show examples of how these rewards are all calculated:
-
-!!! note "Hint"
-    The best reward functions are ones that are continuously differentiable, and well scaled. In other words, adding a single large negative penalty to a rare event is not a good idea, and the neural net will not be able to learn that function. Instead, it is better to add a small negative penalty to a common event. This will help the agent learn faster. Not only this, but you can help improve the continuity of your rewards/penalties by having them scale with severity according to some linear/exponential functions. In other words, you'd slowly scale the penalty as the duration of the trade increases. This is better than a single large penalty occurring at a single point in time.
-
-```python
-from freqtrade.freqai.prediction_models.ReinforcementLearner import ReinforcementLearner
-from freqtrade.freqai.RL.Base5ActionRLEnv import Actions, Base5ActionRLEnv, Positions
-
-
-class MyCoolRLModel(ReinforcementLearner):
-    """
-    User created RL prediction model.
-
-    Save this file to `freqtrade/user_data/freqaimodels`
-
-    then use it with:
-
-    freqtrade trade --freqaimodel MyCoolRLModel --config config.json --strategy SomeCoolStrat
-
-    Here the users can override any of the functions
-    available in the `IFreqaiModel` inheritance tree. Most importantly for RL, this
-    is where the user overrides `MyRLEnv` (see below), to define custom
-    `calculate_reward()` function, or to override any other parts of the environment.
-
-    This class also allows users to override any other part of the IFreqaiModel tree.
-    For example, the user can override `def fit()` or `def train()` or `def predict()`
-    to take fine-tuned control over these processes.
-
-    Another common override may be `def data_cleaning_predict()` where the user can
-    take fine-tuned control over the data handling pipeline.
-    """
-    class MyRLEnv(Base5ActionRLEnv):
-        """
-        User made custom environment. This class inherits from BaseEnvironment and gym.Env.
-        Users can override any functions from those parent classes. Here is an example
-        of a user customized `calculate_reward()` function.
-
-        Warning!
-        This is function is a showcase of functionality designed to show as many possible
-        environment control features as possible. It is also designed to run quickly
-        on small computers. This is a benchmark, it is *not* for live production.
-        """
-        def calculate_reward(self, action: int) -> float:
-            # first, penalize if the action is not valid
-            if not self._is_valid(action):
-                return -2
-            pnl = self.get_unrealized_profit()
-
-            factor = 100
-
-            pair = self.pair.replace(':', '')
-
-            # you can use feature values from dataframe
-            # Assumes the shifted RSI indicator has been generated in the strategy.
-            rsi_now = self.raw_features[f"%-rsi-period_10_shift-1_{pair}_"
-                            f"{self.config['timeframe']}"].iloc[self._current_tick]
-
-            # reward agent for entering trades
-            if (action in (Actions.Long_enter.value, Actions.Short_enter.value)
-                    and self._position == Positions.Neutral):
-                if rsi_now < 40:
-                    factor = 40 / rsi_now
-                else:
-                    factor = 1
-                return 25 * factor
-
-            # discourage agent from not entering trades
-            if action == Actions.Neutral.value and self._position == Positions.Neutral:
-                return -1
-            max_trade_duration = self.rl_config.get('max_trade_duration_candles', 300)
-            trade_duration = self._current_tick - self._last_trade_tick
-            if trade_duration <= max_trade_duration:
-                factor *= 1.5
-            elif trade_duration > max_trade_duration:
-                factor *= 0.5
-            # discourage sitting in position
-            if self._position in (Positions.Short, Positions.Long) and \
-            action == Actions.Neutral.value:
-                return -1 * trade_duration / max_trade_duration
-            # close long
-            if action == Actions.Long_exit.value and self._position == Positions.Long:
-                if pnl > self.profit_aim * self.rr:
-                    factor *= self.rl_config['model_reward_parameters'].get('win_reward_factor', 2)
-                return float(pnl * factor)
-            # close short
-            if action == Actions.Short_exit.value and self._position == Positions.Short:
-                if pnl > self.profit_aim * self.rr:
-                    factor *= self.rl_config['model_reward_parameters'].get('win_reward_factor', 2)
-                return float(pnl * factor)
-            return 0.
-```
-
-## Using Tensorboard
-
-Reinforcement Learning models benefit from tracking training metrics. FreqAI has integrated Tensorboard to allow users to track training and evaluation performance across all coins and across all retrainings. Tensorboard is activated via the following command:
-
-```bash
-tensorboard --logdir user_data/models/unique-id
-```
-
-where `unique-id` is the `identifier` set in the `freqai` configuration file. This command must be run in a separate shell to view the output in the browser at 127.0.0.1:6006 (6006 is the default port used by Tensorboard).
-
-![tensorboard](assets/tensorboard.jpg)
-
-## Custom logging
-
-FreqAI also provides a built in episodic summary logger called `self.tensorboard_log` for adding custom information to the Tensorboard log. By default, this function is already called once per step inside the environment to record the agent actions. All values accumulated for all steps in a single episode are reported at the conclusion of each episode, followed by a full reset of all metrics to 0 in preparation for the subsequent episode.
-
-`self.tensorboard_log` can also be used anywhere inside the environment, for example, it can be added to the `calculate_reward` function to collect more detailed information about how often various parts of the reward were called:
-
-```python
-    class MyRLEnv(Base5ActionRLEnv):
-        """
-        User made custom environment. This class inherits from BaseEnvironment and gym.Env.
-        Users can override any functions from those parent classes. Here is an example
-        of a user customized `calculate_reward()` function.
-        """
-        def calculate_reward(self, action: int) -> float:
-            if not self._is_valid(action):
-                self.tensorboard_log("invalid")
-                return -2
-
-```
-
-!!! Note
-    The `self.tensorboard_log()` function is designed for tracking incremented objects only i.e. events, actions inside the training environment. If the event of interest is a float, the float can be passed as the second argument e.g. `self.tensorboard_log("float_metric1", 0.23)`. In this case the metric values are not incremented.
-
-## Choosing a base environment
-
-FreqAI provides three base environments, `Base3ActionRLEnvironment`, `Base4ActionEnvironment` and `Base5ActionEnvironment`. As the names imply, the environments are customized for agents that can select from 3, 4 or 5 actions. The `Base3ActionEnvironment` is the simplest, the agent can select from hold, long, or short. This environment can also be used for long-only bots (it automatically follows the `can_short` flag from the strategy), where long is the enter condition and short is the exit condition. Meanwhile, in the `Base4ActionEnvironment`, the agent can enter long, enter short, hold neutral, or exit position. Finally, in the `Base5ActionEnvironment`, the agent has the same actions as Base4, but instead of a single exit action, it separates exit long and exit short. The main changes stemming from the environment selection include:
-
-* the actions available in the `calculate_reward`
-* the actions consumed by the user strategy
-
-All of the FreqAI provided environments inherit from an action/position agnostic environment object called the `BaseEnvironment`, which contains all shared logic. The architecture is designed to be easily customized. The simplest customization is the `calculate_reward()` (see details [here](#creating-a-custom-reward-function)). However, the customizations can be further extended into any of the functions inside the environment. You can do this by simply overriding those functions inside your `MyRLEnv` in the prediction model file. Or for more advanced customizations, it is encouraged to create an entirely new environment inherited from `BaseEnvironment`.
-
-!!! Note
-    Only the `Base3ActionRLEnv` can do long-only training/trading (set the user strategy attribute `can_short = False`).

docs/freqai-running.md

@@ -1,187 +0,0 @@
-# Running FreqAI
-
-There are two ways to train and deploy an adaptive machine learning model - live deployment and historical backtesting. In both cases, FreqAI runs/simulates periodic retraining of models as shown in the following figure:
-
-![freqai-window](assets/freqai_moving-window.jpg)
-
-## Live deployments
-
-FreqAI can be run dry/live using the following command:
-
-```bash
-freqtrade trade --strategy FreqaiExampleStrategy --config config_freqai.example.json --freqaimodel LightGBMRegressor
-```
-
-When launched, FreqAI will start training a new model, with a new `identifier`, based on the config settings. Following training, the model will be used to make predictions on incoming candles until a new model is available. New models are typically generated as often as possible, with FreqAI managing an internal queue of the coin pairs to try to keep all models equally up to date. FreqAI will always use the most recently trained model to make predictions on incoming live data. If you do not want FreqAI to retrain new models as often as possible, you can set `live_retrain_hours` to tell FreqAI to wait at least that number of hours before training a new model. Additionally, you can set `expired_hours` to tell FreqAI to avoid making predictions on models that are older than that number of hours.
-
-Trained models are by default saved to disk to allow for reuse during backtesting or after a crash. You can opt to [purge old models](#purging-old-model-data) to save disk space by setting `"purge_old_models": true` in the config.
-
-To start a dry/live run from a saved backtest model (or from a previously crashed dry/live session), you only need to specify the `identifier` of the specific model:
-
-```json
-    "freqai": {
-        "identifier": "example",
-        "live_retrain_hours": 0.5
-    }
-```
-
-In this case, although FreqAI will initiate with a pre-trained model, it will still check to see how much time has elapsed since the model was trained. If a full `live_retrain_hours` has elapsed since the end of the loaded model, FreqAI will start training a new model.
-
-### Automatic data download
-
-FreqAI automatically downloads the proper amount of data needed to ensure training of a model through the defined `train_period_days` and `startup_candle_count` (see the [parameter table](freqai-parameter-table.md) for detailed descriptions of these parameters). 
-
-### Saving prediction data
-
-All predictions made during the lifetime of a specific `identifier` model are stored in `historic_predictions.pkl` to allow for reloading after a crash or changes made to the config.
-
-### Purging old model data
-
-FreqAI stores new model files after each successful training. These files become obsolete as new models are generated to adapt to new market conditions. If you are planning to leave FreqAI running for extended periods of time with high frequency retraining, you should enable `purge_old_models` in the config:
-
-```json
-    "freqai": {
-        "purge_old_models": 4,
-    }
-```
-
-This will automatically purge all models older than the four most recently trained ones to save disk space. Inputing "0" will never purge any models.
-
-## Backtesting
-
-The FreqAI backtesting module can be executed with the following command:
-
-```bash
-freqtrade backtesting --strategy FreqaiExampleStrategy --strategy-path freqtrade/templates --config config_examples/config_freqai.example.json --freqaimodel LightGBMRegressor --timerange 20210501-20210701
-```
-
-If this command has never been executed with the existing config file, FreqAI will train a new model
-for each pair, for each backtesting window within the expanded `--timerange`.
-
-Backtesting mode requires [downloading the necessary data](#downloading-data-to-cover-the-full-backtest-period) before deployment (unlike in dry/live mode where FreqAI handles the data downloading automatically). You should be careful to consider that the time range of the downloaded data is more than the backtesting time range. This is because FreqAI needs data prior to the desired backtesting time range in order to train a model to be ready to make predictions on the first candle of the set backtesting time range. More details on how to calculate the data to download can be found [here](#deciding-the-size-of-the-sliding-training-window-and-backtesting-duration).
-
-!!! Note "Model reuse"
-    Once the training is completed, you can execute the backtesting again with the same config file and
-    FreqAI will find the trained models and load them instead of spending time training. This is useful
-    if you want to tweak (or even hyperopt) buy and sell criteria inside the strategy. If you
-    *want* to retrain a new model with the same config file, you should simply change the `identifier`.
-    This way, you can return to using any model you wish by simply specifying the `identifier`.
-
-!!! Note
-    Backtesting calls `set_freqai_targets()` one time for each backtest window (where the number of windows is the full backtest timerange divided by the `backtest_period_days` parameter). Doing this means that the targets simulate dry/live behavior without look ahead bias. However, the definition of the features in `feature_engineering_*()` is performed once on the entire training timerange. This means that you should be sure that features do not look-ahead into the future.
-    More details about look-ahead bias can be found in [Common Mistakes](strategy-customization.md#common-mistakes-when-developing-strategies).
-
----
-
-### Saving backtesting prediction data
-
-To allow for tweaking your strategy (**not** the features!), FreqAI will automatically save the predictions during backtesting so that they can be reused for future backtests and live runs using the same `identifier` model. This provides a performance enhancement geared towards enabling **high-level hyperopting** of entry/exit criteria.
-
-An additional directory called `backtesting_predictions`, which contains all the predictions stored in `feather` format, will be created in the `unique-id` folder.
-
-To change your **features**, you **must** set a new `identifier` in the config to signal to FreqAI to train new models.
-
-To save the models generated during a particular backtest so that you can start a live deployment from one of them instead of training a new model, you must set `save_backtest_models` to `True` in the config.
-
-!!! Note
-    To ensure that the model can be reused, freqAI will call your strategy with a dataframe of length 1. 
-    If your strategy requires more data than this to generate the same features, you can't reuse backtest predictions for live deployment and need to update your `identifier` for each new backtest.
-
-### Backtest live collected predictions
-
-FreqAI allow you to reuse live historic predictions through the backtest parameter `--freqai-backtest-live-models`. This can be useful when you want to reuse predictions generated in dry/run for comparison or other study.
-
-The `--timerange` parameter must not be informed, as it will be automatically calculated through the data in the historic predictions file.
-
-### Downloading data to cover the full backtest period
-
-For live/dry deployments, FreqAI will download the necessary data automatically. However, to use backtesting functionality, you need to download the necessary data using `download-data` (details [here](data-download.md#data-downloading)). You need to pay careful attention to understanding how much *additional* data needs to be downloaded to ensure that there is a sufficient amount of training data *before* the start of the backtesting time range. The amount of additional data can be roughly estimated by moving the start date of the time range backwards by `train_period_days` and the `startup_candle_count` (see the [parameter table](freqai-parameter-table.md) for detailed descriptions of these parameters) from the beginning of the desired backtesting time range. 
-
-As an example, to backtest the `--timerange 20210501-20210701` using the [example config](freqai-configuration.md#setting-up-the-configuration-file) which sets `train_period_days` to 30, together with `startup_candle_count: 40` on a maximum `include_timeframes` of 1h, the start date for the downloaded data needs to be `20210501` - 30 days - 40 * 1h / 24 hours = 20210330 (31.7 days earlier than the start of the desired training time range).
-
-### Deciding the size of the sliding training window and backtesting duration
-
-The backtesting time range is defined with the typical `--timerange` parameter in the configuration file. The duration of the sliding training window is set by `train_period_days`, whilst `backtest_period_days` is the sliding backtesting window, both in number of days (`backtest_period_days` can be
-a float to indicate sub-daily retraining in live/dry mode). In the presented [example config](freqai-configuration.md#setting-up-the-configuration-file) (found in `config_examples/config_freqai.example.json`), the user is asking FreqAI to use a training period of 30 days and backtest on the subsequent 7 days. After the training of the model, FreqAI will backtest the subsequent 7 days. The "sliding window" then moves one week forward (emulating FreqAI retraining once per week in live mode) and the new model uses the previous 30 days (including the 7 days used for backtesting by the previous model) to train. This is repeated until the end of `--timerange`.  This means that if you set `--timerange 20210501-20210701`, FreqAI will have trained 8 separate models at the end of `--timerange` (because the full range comprises 8 weeks).
-
-!!! Note
-    Although fractional `backtest_period_days` is allowed, you should be aware that the `--timerange` is divided by this value to determine the number of models that FreqAI will need to train in order to backtest the full range. For example, by setting a `--timerange` of 10 days, and a `backtest_period_days` of 0.1, FreqAI will need to train 100 models per pair to complete the full backtest. Because of this, a true backtest of FreqAI adaptive training would take a *very* long time. The best way to fully test a model is to run it dry and let it train constantly. In this case, backtesting would take the exact same amount of time as a dry run.
-
-## Defining model expirations
-
-During dry/live mode, FreqAI trains each coin pair sequentially (on separate threads/GPU from the main Freqtrade bot). This means that there is always an age discrepancy between models. If you are training on 50 pairs, and each pair requires 5 minutes to train, the oldest model will be over 4 hours old. This may be undesirable if the characteristic time scale (the trade duration target) for a strategy is less than 4 hours. You can decide to only make trade entries if the model is less than a certain number of hours old by setting the `expiration_hours` in the config file:
-
-```json
-    "freqai": {
-        "expiration_hours": 0.5,
-    }
-```
-
-In the presented example config, the user will only allow predictions on models that are less than 1/2 hours old.
-
-## Controlling the model learning process
-
-Model training parameters are unique to the selected machine learning library. FreqAI allows you to set any parameter for any library using the `model_training_parameters` dictionary in the config. The example config (found in `config_examples/config_freqai.example.json`) shows some of the example parameters associated with `Catboost` and `LightGBM`, but you can add any parameters available in those libraries or any other machine learning library you choose to implement.
-
-Data split parameters are defined in `data_split_parameters` which can be any parameters associated with scikit-learn's `train_test_split()` function. `train_test_split()` has a parameters called `shuffle` which allows to shuffle the data or keep it unshuffled. This is particularly useful to avoid biasing training with temporally auto-correlated data. More details about these parameters can be found the [scikit-learn website](https://scikit-learn.org/stable/modules/generated/sklearn.model_selection.train_test_split.html) (external website).
-
-The FreqAI specific parameter `label_period_candles` defines the offset (number of candles into the future) used for the `labels`. In the presented [example config](freqai-configuration.md#setting-up-the-configuration-file), the user is asking for `labels` that are 24 candles in the future.
-
-## Continual learning
-
-You can choose to adopt a continual learning scheme by setting `"continual_learning": true` in the config. By enabling `continual_learning`, after training an initial model from scratch, subsequent trainings will start from the final model state of the preceding training. This gives the new model a "memory" of the previous state. By default, this is set to `False` which means that all new models are trained from scratch, without input from previous models.
-
-???+ danger "Continual learning enforces a constant parameter space"
-    Since `continual_learning` means that the model parameter space *cannot* change between trainings, `principal_component_analysis` is automatically disabled when `continual_learning` is enabled. Hint: PCA changes the parameter space and the number of features, learn more about PCA [here](freqai-feature-engineering.md#data-dimensionality-reduction-with-principal-component-analysis).
-
-???+ danger "Experimental functionality"
-    Beware that this is currently a naive approach to incremental learning, and it has a high probability of overfitting/getting stuck in local minima while the market moves away from your model. We have the mechanics available in FreqAI primarily for experimental purposes and so that it is ready for more mature approaches to continual learning in chaotic systems like the crypto market.
-
-## Hyperopt
-
-You can hyperopt using the same command as for [typical Freqtrade hyperopt](hyperopt.md):
-
-```bash
-freqtrade hyperopt --hyperopt-loss SharpeHyperOptLoss --strategy FreqaiExampleStrategy --freqaimodel LightGBMRegressor --strategy-path freqtrade/templates --config config_examples/config_freqai.example.json --timerange 20220428-20220507
-```
-
-`hyperopt` requires you to have the data pre-downloaded in the same fashion as if you were doing [backtesting](#backtesting). In addition, you must consider some restrictions when trying to hyperopt FreqAI strategies:
-
-- The `--analyze-per-epoch` hyperopt parameter is not compatible with FreqAI.
-- It's not possible to hyperopt indicators in the `feature_engineering_*()` and `set_freqai_targets()` functions. This means that you cannot optimize model parameters using hyperopt. Apart from this exception, it is possible to optimize all other [spaces](hyperopt.md#running-hyperopt-with-smaller-search-space).
-- The backtesting instructions also apply to hyperopt.
-
-The best method for combining hyperopt and FreqAI is to focus on hyperopting entry/exit thresholds/criteria. You need to focus on hyperopting parameters that are not used in your features. For example, you should not try to hyperopt rolling window lengths in the feature creation, or any part of the FreqAI config which changes predictions. In order to efficiently hyperopt the FreqAI strategy, FreqAI stores predictions as dataframes and reuses them. Hence the requirement to hyperopt entry/exit thresholds/criteria only.
-
-A good example of a hyperoptable parameter in FreqAI is a threshold for the [Dissimilarity Index (DI)](freqai-feature-engineering.md#identifying-outliers-with-the-dissimilarity-index-di) `DI_values` beyond which we consider data points as outliers:
-
-```python
-di_max = IntParameter(low=1, high=20, default=10, space='buy', optimize=True, load=True)
-dataframe['outlier'] = np.where(dataframe['DI_values'] > self.di_max.value/10, 1, 0)
-```
-
-This specific hyperopt would help you understand the appropriate `DI_values` for your particular parameter space.
-
-## Using Tensorboard
-
-!!! note "Availability"
-    FreqAI includes tensorboard for a variety of models, including XGBoost, all PyTorch models, Reinforcement Learning, and Catboost. If you would like to see Tensorboard integrated into another model type, please open an issue on the [Freqtrade GitHub](https://github.com/freqtrade/freqtrade/issues)
-
-!!! danger "Requirements"
-    Tensorboard logging requires the FreqAI torch installation/docker image.
-
-
-The easiest way to use tensorboard is to ensure `freqai.activate_tensorboard` is set to `True` (default setting) in your configuration file, run FreqAI, then open a separate shell and run:
-
-```bash
-cd freqtrade
-tensorboard --logdir user_data/models/unique-id
-```
-
-where `unique-id` is the `identifier` set in the `freqai` configuration file. This command must be run in a separate shell if you wish to view the output in your browser at 127.0.0.1:6060 (6060 is the default port used by Tensorboard).
-
-![tensorboard](assets/tensorboard.jpg)
-
-
-!!! note "Deactivate for improved performance"
-    Tensorboard logging can slow down training and should be deactivated for production use.

docs/freqai.md

@@ -1,141 +0,0 @@
-![freqai-logo](assets/freqai_doc_logo.svg)
-
-# FreqAI
-
-## Introduction
-
-FreqAI is a software designed to automate a variety of tasks associated with training a predictive machine learning model to generate market forecasts given a set of input signals. In general, FreqAI aims to be a sandbox for easily deploying robust machine learning libraries on real-time data ([details](#freqai-position-in-open-source-machine-learning-landscape)).
-
-!!! Note
-    FreqAI is, and always will be, a not-for-profit, open-source project. FreqAI does *not* have a crypto token, FreqAI does *not* sell signals, and FreqAI does not have a domain besides the present [freqtrade documentation](https://www.freqtrade.io/en/latest/freqai/).
-
-Features include:
-
-* **Self-adaptive retraining** - Retrain models during [live deployments](freqai-running.md#live-deployments) to self-adapt to the market in a supervised manner
-* **Rapid feature engineering** - Create large rich [feature sets](freqai-feature-engineering.md#feature-engineering) (10k+ features) based on simple user-created strategies
-* **High performance** - Threading allows for adaptive model retraining on a separate thread (or on GPU if available) from model inferencing (prediction) and bot trade operations. Newest models and data are kept in RAM for rapid inferencing
-* **Realistic backtesting** - Emulate self-adaptive training on historic data with a [backtesting module](freqai-running.md#backtesting) that automates retraining
-* **Extensibility** - The generalized and robust architecture allows for incorporating any [machine learning library/method](freqai-configuration.md#using-different-prediction-models) available in Python. Eight examples are currently available, including classifiers, regressors, and a convolutional neural network
-* **Smart outlier removal** - Remove outliers from training and prediction data sets using a variety of [outlier detection techniques](freqai-feature-engineering.md#outlier-detection)
-* **Crash resilience** - Store trained models to disk to make reloading from a crash fast and easy, and [purge obsolete files](freqai-running.md#purging-old-model-data) for sustained dry/live runs
-* **Automatic data normalization** - [Normalize the data](freqai-feature-engineering.md#feature-normalization) in a smart and statistically safe way
-* **Automatic data download** - Compute timeranges for data downloads and update historic data (in live deployments)
-* **Cleaning of incoming data** - Handle NaNs safely before training and model inferencing
-* **Dimensionality reduction** - Reduce the size of the training data via [Principal Component Analysis](freqai-feature-engineering.md#data-dimensionality-reduction-with-principal-component-analysis)
-* **Deploying bot fleets** - Set one bot to train models while a fleet of [consumers](producer-consumer.md) use signals.
-
-## Quick start
-
-The easiest way to quickly test FreqAI is to run it in dry mode with the following command:
-
-```bash
-freqtrade trade --config config_examples/config_freqai.example.json --strategy FreqaiExampleStrategy --freqaimodel LightGBMRegressor --strategy-path freqtrade/templates
-```
-
-You will see the boot-up process of automatic data downloading, followed by simultaneous training and trading. 
-
-!!! danger "Not for production"
-    The example strategy provided with the Freqtrade source code is designed for showcasing/testing a wide variety of FreqAI features. It is also designed to run on small computers so that it can be used as a benchmark between developers and users. It is *not* designed to be run in production.
-
-An example strategy, prediction model, and config to use as a starting points can be found in
-`freqtrade/templates/FreqaiExampleStrategy.py`, `freqtrade/freqai/prediction_models/LightGBMRegressor.py`, and
-`config_examples/config_freqai.example.json`, respectively.
-
-## General approach
-
-You provide FreqAI with a set of custom *base indicators* (the same way as in a [typical Freqtrade strategy](strategy-customization.md)) as well as target values (*labels*). For each pair in the whitelist, FreqAI trains a model to predict the target values based on the input of custom indicators. The models are then consistently retrained, with a predetermined frequency, to adapt to market conditions. FreqAI offers the ability to both backtest strategies (emulating reality with periodic retraining on historic data) and deploy dry/live runs. In dry/live conditions, FreqAI can be set to constant retraining in a background thread to keep models as up to date as possible.
-
-An overview of the algorithm, explaining the data processing pipeline and model usage, is shown below.
-
-![freqai-algo](assets/freqai_algo.jpg)
-
-### Important machine learning vocabulary
-
-**Features** - the parameters, based on historic data, on which a model is trained. All features for a single candle are stored as a vector. In FreqAI, you build a feature data set from anything you can construct in the strategy.
-
-**Labels** - the target values that the model is trained toward. Each feature vector is associated with a single label that is defined by you within the strategy. These labels intentionally look into the future and are what you are training the model to be able to predict.
-
-**Training** - the process of "teaching" the model to match the feature sets to the associated labels. Different types of models "learn" in different ways which means that one might be better than another for a specific application. More information about the different models that are already implemented in FreqAI can be found [here](freqai-configuration.md#using-different-prediction-models).
-
-**Train data** - a subset of the feature data set that is fed to the model during training to "teach" the model how to predict the targets. This data directly influences weight connections in the model.
-
-**Test data** - a subset of the feature data set that is used to evaluate the performance of the model after training. This data does not influence nodal weights within the model.
-
-**Inferencing** - the process of feeding a trained model new unseen data on which it will make a prediction. 
-
-## Install prerequisites
-
-The normal Freqtrade install process will ask if you wish to install FreqAI dependencies. You should reply "yes" to this question if you wish to use FreqAI. If you did not reply yes, you can manually install these dependencies after the install with:
-
-``` bash
-pip install -r requirements-freqai.txt
-```
-
-!!! Note
-    Catboost will not be installed on low-powered arm devices (raspberry), since it does not provide wheels for this platform.
-
-### Usage with docker
-
-If you are using docker, a dedicated tag with FreqAI dependencies is available as `:freqai`. As such - you can replace the image line in your docker compose file with `image: freqtradeorg/freqtrade:develop_freqai`. This image contains the regular FreqAI dependencies. Similar to native installs, Catboost will not be available on ARM based devices. If you would like to use PyTorch or Reinforcement learning, you should use the torch or RL tags, `image: freqtradeorg/freqtrade:develop_freqaitorch`, `image: freqtradeorg/freqtrade:develop_freqairl`.
-
-!!! note "docker-compose-freqai.yml"
-   We do provide an explicit docker-compose file for this in `docker/docker-compose-freqai.yml` - which can be used via `docker compose -f docker/docker-compose-freqai.yml run ...` - or can be copied to replace the original docker file. This docker-compose file also contains a (disabled) section to enable GPU resources within docker containers. This obviously assumes the system has GPU resources available.
-
-### FreqAI position in open-source machine learning landscape
-
-Forecasting chaotic time-series based systems, such as equity/cryptocurrency markets, requires a broad set of tools geared toward testing a wide range of hypotheses. Fortunately, a recent maturation of robust machine learning libraries (e.g. `scikit-learn`) has opened up a wide range of research possibilities. Scientists from a diverse range of fields can now easily prototype their studies on an abundance of established machine learning algorithms. Similarly, these user-friendly libraries enable "citzen scientists" to use their basic Python skills for data exploration. However, leveraging these machine learning libraries on historical and live chaotic data sources can be logistically difficult and expensive. Additionally, robust data collection, storage, and handling presents a disparate challenge. [`FreqAI`](#freqai) aims to provide a generalized and extensible open-sourced framework geared toward live deployments of adaptive modeling for market forecasting. The `FreqAI` framework is effectively a sandbox for the rich world of open-source machine learning libraries. Inside the `FreqAI` sandbox, users find they can combine a wide variety of third-party libraries to test creative hypotheses on a free live 24/7 chaotic data source - cryptocurrency exchange data. 
-
-### Citing FreqAI
-
-FreqAI is [published in the Journal of Open Source Software](https://joss.theoj.org/papers/10.21105/joss.04864). If you find FreqAI useful in your research, please use the following citation:
-
-```bibtex
-@article{Caulk2022, 
-    doi = {10.21105/joss.04864},
-    url = {https://doi.org/10.21105/joss.04864},
-    year = {2022}, publisher = {The Open Journal},
-    volume = {7}, number = {80}, pages = {4864},
-    author = {Robert A. Caulk and Elin Törnquist and Matthias Voppichler and Andrew R. Lawless and Ryan McMullan and Wagner Costa Santos and Timothy C. Pogue and Johan van der Vlugt and Stefan P. Gehring and Pascal Schmidt},
-    title = {FreqAI: generalizing adaptive modeling for chaotic time-series market forecasts},
-    journal = {Journal of Open Source Software} } 
-```
-
-## Common pitfalls
-
-FreqAI cannot be combined with dynamic `VolumePairlists` (or any pairlist filter that adds and removes pairs dynamically).
-This is for performance reasons - FreqAI relies on making quick predictions/retrains. To do this effectively,
-it needs to download all the training data at the beginning of a dry/live instance. FreqAI stores and appends
-new candles automatically for future retrains. This means that if new pairs arrive later in the dry run due to a volume pairlist, it will not have the data ready. However, FreqAI does work with the `ShufflePairlist` or a `VolumePairlist` which keeps the total pairlist constant (but reorders the pairs according to volume).
-
-## Additional learning materials
-
-Here we compile some external materials that provide deeper looks into various components of FreqAI:
-
-- [Real-time head-to-head: Adaptive modeling of financial market data using XGBoost and CatBoost](https://emergentmethods.medium.com/real-time-head-to-head-adaptive-modeling-of-financial-market-data-using-xgboost-and-catboost-995a115a7495)
-- [FreqAI - from price to prediction](https://emergentmethods.medium.com/freqai-from-price-to-prediction-6fadac18b665)
-
-
-## Support
-
-You can find support for FreqAI in a variety of places, including the [Freqtrade discord](https://discord.gg/Jd8JYeWHc4), the dedicated [FreqAI discord](https://discord.gg/7AMWACmbjT), and in [github issues](https://github.com/freqtrade/freqtrade/issues).
-
-## Credits
-
-FreqAI is developed by a group of individuals who all contribute specific skillsets to the project.
-
-Conception and software development:
-Robert Caulk @robcaulk
-
-Theoretical brainstorming and data analysis:
-Elin Törnquist @th0rntwig
-
-Code review and software architecture brainstorming:
-@xmatthias
-
-Software development:
-Wagner Costa @wagnercosta
-Emre Suzen @aemr3
-Timothy Pogue @wizrds
-
-Beta testing and bug reporting:
-Stefan Gehring @bloodhunter4rc, @longyu, Andrew Lawless @paranoidandy, Pascal Schmidt @smidelis, Ryan McMullan @smarmau, Juha Nykänen @suikula, Johan van der Vlugt @jooopiert, Richárd Józsa @richardjosza

docs/hyperopt.md

@@ -1,936 +0,0 @@
-# Hyperopt
-
-This page explains how to tune your strategy by finding the optimal
-parameters, a process called hyperparameter optimization. The bot uses algorithms included in the `scikit-optimize` package to accomplish this.
-The search will burn all your CPU cores, make your laptop sound like a fighter jet and still take a long time.
-
-In general, the search for best parameters starts with a few random combinations (see [below](#reproducible-results) for more details) and then uses Bayesian search with a ML regressor algorithm (currently ExtraTreesRegressor) to quickly find a combination of parameters in the search hyperspace that minimizes the value of the [loss function](#loss-functions).
-
-Hyperopt requires historic data to be available, just as backtesting does (hyperopt runs backtesting many times with different parameters).
-To learn how to get data for the pairs and exchange you're interested in, head over to the [Data Downloading](data-download.md) section of the documentation.
-
-!!! Bug
-    Hyperopt can crash when used with only 1 CPU Core as found out in [Issue #1133](https://github.com/freqtrade/freqtrade/issues/1133)
-
-!!! Note
-    Since 2021.4 release you no longer have to write a separate hyperopt class, but can configure the parameters directly in the strategy.
-    The legacy method was supported up to 2021.8 and has been removed in 2021.9.
-
-## Install hyperopt dependencies
-
-Since Hyperopt dependencies are not needed to run the bot itself, are heavy, can not be easily built on some platforms (like Raspberry PI), they are not installed by default. Before you run Hyperopt, you need to install the corresponding dependencies, as described in this section below.
-
-!!! Note
-    Since Hyperopt is a resource intensive process, running it on a Raspberry Pi is not recommended nor supported.
-
-### Docker
-
-The docker-image includes hyperopt dependencies, no further action needed.
-
-### Easy installation script (setup.sh) / Manual installation
-
-```bash
-source .venv/bin/activate
-pip install -r requirements-hyperopt.txt
-```
-
-## Hyperopt command reference
-
-```
-usage: freqtrade hyperopt [-h] [-v] [--logfile FILE] [-V] [-c PATH] [-d PATH]
-                          [--userdir PATH] [-s NAME] [--strategy-path PATH]
-                          [--recursive-strategy-search] [--freqaimodel NAME]
-                          [--freqaimodel-path PATH] [-i TIMEFRAME]
-                          [--timerange TIMERANGE]
-                          [--data-format-ohlcv {json,jsongz,hdf5}]
-                          [--max-open-trades INT]
-                          [--stake-amount STAKE_AMOUNT] [--fee FLOAT]
-                          [-p PAIRS [PAIRS ...]] [--hyperopt-path PATH]
-                          [--eps] [--dmmp] [--enable-protections]
-                          [--dry-run-wallet DRY_RUN_WALLET]
-                          [--timeframe-detail TIMEFRAME_DETAIL] [-e INT]
-                          [--spaces {all,buy,sell,roi,stoploss,trailing,protection,trades,default} [{all,buy,sell,roi,stoploss,trailing,protection,trades,default} ...]]
-                          [--print-all] [--no-color] [--print-json] [-j JOBS]
-                          [--random-state INT] [--min-trades INT]
-                          [--hyperopt-loss NAME] [--disable-param-export]
-                          [--ignore-missing-spaces] [--analyze-per-epoch]
-
-optional arguments:
-  -h, --help            show this help message and exit
-  -i TIMEFRAME, --timeframe TIMEFRAME
-                        Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
-  --timerange TIMERANGE
-                        Specify what timerange of data to use.
-  --data-format-ohlcv {json,jsongz,hdf5}
-                        Storage format for downloaded candle (OHLCV) data.
-                        (default: `json`).
-  --max-open-trades INT
-                        Override the value of the `max_open_trades`
-                        configuration setting.
-  --stake-amount STAKE_AMOUNT
-                        Override the value of the `stake_amount` configuration
-                        setting.
-  --fee FLOAT           Specify fee ratio. Will be applied twice (on trade
-                        entry and exit).
-  -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
-                        Limit command to these pairs. Pairs are space-
-                        separated.
-  --hyperopt-path PATH  Specify additional lookup path for Hyperopt Loss
-                        functions.
-  --eps, --enable-position-stacking
-                        Allow buying the same pair multiple times (position
-                        stacking).
-  --dmmp, --disable-max-market-positions
-                        Disable applying `max_open_trades` during backtest
-                        (same as setting `max_open_trades` to a very high
-                        number).
-  --enable-protections, --enableprotections
-                        Enable protections for backtesting.Will slow
-                        backtesting down by a considerable amount, but will
-                        include configured protections
-  --dry-run-wallet DRY_RUN_WALLET, --starting-balance DRY_RUN_WALLET
-                        Starting balance, used for backtesting / hyperopt and
-                        dry-runs.
-  --timeframe-detail TIMEFRAME_DETAIL
-                        Specify detail timeframe for backtesting (`1m`, `5m`,
-                        `30m`, `1h`, `1d`).
-  -e INT, --epochs INT  Specify number of epochs (default: 100).
-  --spaces {all,buy,sell,roi,stoploss,trailing,protection,trades,default} [{all,buy,sell,roi,stoploss,trailing,protection,trades,default} ...]
-                        Specify which parameters to hyperopt. Space-separated
-                        list.
-  --print-all           Print all results, not only the best ones.
-  --no-color            Disable colorization of hyperopt results. May be
-                        useful if you are redirecting output to a file.
-  --print-json          Print output in JSON format.
-  -j JOBS, --job-workers JOBS
-                        The number of concurrently running jobs for
-                        hyperoptimization (hyperopt worker processes). If -1
-                        (default), all CPUs are used, for -2, all CPUs but one
-                        are used, etc. If 1 is given, no parallel computing
-                        code is used at all.
-  --random-state INT    Set random state to some positive integer for
-                        reproducible hyperopt results.
-  --min-trades INT      Set minimal desired number of trades for evaluations
-                        in the hyperopt optimization path (default: 1).
-  --hyperopt-loss NAME, --hyperoptloss NAME
-                        Specify the class name of the hyperopt loss function
-                        class (IHyperOptLoss). Different functions can
-                        generate completely different results, since the
-                        target for optimization is different. Built-in
-                        Hyperopt-loss-functions are:
-                        ShortTradeDurHyperOptLoss, OnlyProfitHyperOptLoss,
-                        SharpeHyperOptLoss, SharpeHyperOptLossDaily,
-                        SortinoHyperOptLoss, SortinoHyperOptLossDaily,
-                        CalmarHyperOptLoss, MaxDrawDownHyperOptLoss,
-                        MaxDrawDownRelativeHyperOptLoss,
-                        ProfitDrawDownHyperOptLoss
-  --disable-param-export
-                        Disable automatic hyperopt parameter export.
-  --ignore-missing-spaces, --ignore-unparameterized-spaces
-                        Suppress errors for any requested Hyperopt spaces that
-                        do not contain any parameters.
-  --analyze-per-epoch   Run populate_indicators once per epoch.
-
-Common arguments:
-  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
-  --logfile FILE        Log to the file specified. Special values are:
-                        'syslog', 'journald'. See the documentation for more
-                        details.
-  -V, --version         show program's version number and exit
-  -c PATH, --config PATH
-                        Specify configuration file (default:
-                        `userdir/config.json` or `config.json` whichever
-                        exists). Multiple --config options may be used. Can be
-                        set to `-` to read config from stdin.
-  -d PATH, --datadir PATH
-                        Path to directory with historical backtesting data.
-  --userdir PATH, --user-data-dir PATH
-                        Path to userdata directory.
-
-Strategy arguments:
-  -s NAME, --strategy NAME
-                        Specify strategy class name which will be used by the
-                        bot.
-  --strategy-path PATH  Specify additional strategy lookup path.
-  --recursive-strategy-search
-                        Recursively search for a strategy in the strategies
-                        folder.
-  --freqaimodel NAME    Specify a custom freqaimodels.
-  --freqaimodel-path PATH
-                        Specify additional lookup path for freqaimodels.
-
-```
-
-### Hyperopt checklist
-
-Checklist on all tasks / possibilities in hyperopt
-
-Depending on the space you want to optimize, only some of the below are required:
-
-* define parameters with `space='buy'` - for entry signal optimization
-* define parameters with `space='sell'` - for exit signal optimization
-
-!!! Note
-    `populate_indicators` needs to create all indicators any of the spaces may use, otherwise hyperopt will not work.
-
-Rarely you may also need to create a [nested class](advanced-hyperopt.md#overriding-pre-defined-spaces) named `HyperOpt` and implement
-
-* `roi_space` - for custom ROI optimization (if you need the ranges for the ROI parameters in the optimization hyperspace that differ from default)
-* `generate_roi_table` - for custom ROI optimization (if you need the ranges for the values in the ROI table that differ from default or the number of entries (steps) in the ROI table which differs from the default 4 steps)
-* `stoploss_space` - for custom stoploss optimization (if you need the range for the stoploss parameter in the optimization hyperspace that differs from default)
-* `trailing_space` - for custom trailing stop optimization (if you need the ranges for the trailing stop parameters in the optimization hyperspace that differ from default)
-* `max_open_trades_space` - for custom max_open_trades optimization (if you need the ranges for the max_open_trades parameter in the optimization hyperspace that differ from default)
-
-!!! Tip "Quickly optimize ROI, stoploss and trailing stoploss"
-    You can quickly optimize the spaces `roi`, `stoploss` and `trailing` without changing anything in your strategy.
-
-    ``` bash
-    # Have a working strategy at hand.
-    freqtrade hyperopt --hyperopt-loss SharpeHyperOptLossDaily --spaces roi stoploss trailing --strategy MyWorkingStrategy --config config.json -e 100
-    ```
-
-### Hyperopt execution logic
-
-Hyperopt will first load your data into memory and will then run `populate_indicators()` once per Pair to generate all indicators, unless `--analyze-per-epoch` is specified.
-
-Hyperopt will then spawn into different processes (number of processors, or `-j <n>`), and run backtesting over and over again, changing the parameters that are part of the `--spaces` defined.
-
-For every new set of parameters, freqtrade will run first `populate_entry_trend()` followed by `populate_exit_trend()`, and then run the regular backtesting process to simulate trades.
-
-After backtesting, the results are passed into the [loss function](#loss-functions), which will evaluate if this result was better or worse than previous results.  
-Based on the loss function result, hyperopt will determine the next set of parameters to try in the next round of backtesting.
-
-### Configure your Guards and Triggers
-
-There are two places you need to change in your strategy file to add a new buy hyperopt for testing:
-
-* Define the parameters at the class level hyperopt shall be optimizing.
-* Within `populate_entry_trend()` - use defined parameter values instead of raw constants.
-
-There you have two different types of indicators: 1. `guards` and 2. `triggers`.
-
-1. Guards are conditions like "never buy if ADX < 10", or never buy if current price is over EMA10.
-2. Triggers are ones that actually trigger buy in specific moment, like "buy when EMA5 crosses over EMA10" or "buy when close price touches lower Bollinger band".
-
-!!! Hint "Guards and Triggers"
-    Technically, there is no difference between Guards and Triggers.  
-    However, this guide will make this distinction to make it clear that signals should not be "sticking".
-    Sticking signals are signals that are active for multiple candles. This can lead into entering a signal late (right before the signal disappears - which means that the chance of success is a lot lower than right at the beginning).
-
-Hyper-optimization will, for each epoch round, pick one trigger and possibly multiple guards.
-
-#### Exit signal optimization
-
-Similar to the entry-signal above, exit-signals can also be optimized.
-Place the corresponding settings into the following methods
-
-* Define the parameters at the class level hyperopt shall be optimizing, either naming them `sell_*`, or by explicitly defining `space='sell'`.
-* Within `populate_exit_trend()` - use defined parameter values instead of raw constants.
-
-The configuration and rules are the same than for buy signals.
-
-## Solving a Mystery
-
-Let's say you are curious: should you use MACD crossings or lower Bollinger Bands to trigger your long entries.
-And you also wonder should you use RSI or ADX to help with those decisions.
-If you decide to use RSI or ADX, which values should I use for them?
-
-So let's use hyperparameter optimization to solve this mystery.
-
-### Defining indicators to be used
-
-We start by calculating the indicators our strategy is going to use.
-
-``` python
-class MyAwesomeStrategy(IStrategy):
-
-    def populate_indicators(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
-        """
-        Generate all indicators used by the strategy
-        """
-        dataframe['adx'] = ta.ADX(dataframe)
-        dataframe['rsi'] = ta.RSI(dataframe)
-        macd = ta.MACD(dataframe)
-        dataframe['macd'] = macd['macd']
-        dataframe['macdsignal'] = macd['macdsignal']
-        dataframe['macdhist'] = macd['macdhist']
-
-        bollinger = ta.BBANDS(dataframe, timeperiod=20, nbdevup=2.0, nbdevdn=2.0)
-        dataframe['bb_lowerband'] = bollinger['lowerband']
-        dataframe['bb_middleband'] = bollinger['middleband']
-        dataframe['bb_upperband'] = bollinger['upperband']
-        return dataframe
-```
-
-### Hyperoptable parameters
-
-We continue to define hyperoptable parameters:
-
-```python
-class MyAwesomeStrategy(IStrategy):
-    buy_adx = DecimalParameter(20, 40, decimals=1, default=30.1, space="buy")
-    buy_rsi = IntParameter(20, 40, default=30, space="buy")
-    buy_adx_enabled = BooleanParameter(default=True, space="buy")
-    buy_rsi_enabled = CategoricalParameter([True, False], default=False, space="buy")
-    buy_trigger = CategoricalParameter(["bb_lower", "macd_cross_signal"], default="bb_lower", space="buy")
-```
-
-The above definition says: I have five parameters I want to randomly combine to find the best combination.  
-`buy_rsi` is an integer parameter, which will be tested between 20 and 40. This space has a size of 20.  
-`buy_adx` is a decimal parameter, which will be evaluated between 20 and 40 with 1 decimal place (so values are 20.1, 20.2, ...). This space has a size of 200.  
-Then we have three category variables. First two are either `True` or `False`.
-We use these to either enable or disable the ADX and RSI guards.
-The last one we call `trigger` and use it to decide which buy trigger we want to use.
-
-!!! Note "Parameter space assignment"
-    Parameters must either be assigned to a variable named `buy_*` or `sell_*` - or contain `space='buy'` | `space='sell'` to be assigned to a space correctly.
-    If no parameter is available for a space, you'll receive the error that no space was found when running hyperopt.  
-    Parameters with unclear space (e.g. `adx_period = IntParameter(4, 24, default=14)` - no explicit nor implicit space) will not be detected and will therefore be ignored.
-
-So let's write the buy strategy using these values:
-
-```python
-    def populate_entry_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
-        conditions = []
-        # GUARDS AND TRENDS
-        if self.buy_adx_enabled.value:
-            conditions.append(dataframe['adx'] > self.buy_adx.value)
-        if self.buy_rsi_enabled.value:
-            conditions.append(dataframe['rsi'] < self.buy_rsi.value)
-
-        # TRIGGERS
-        if self.buy_trigger.value == 'bb_lower':
-            conditions.append(dataframe['close'] < dataframe['bb_lowerband'])
-        if self.buy_trigger.value == 'macd_cross_signal':
-            conditions.append(qtpylib.crossed_above(
-                dataframe['macd'], dataframe['macdsignal']
-            ))
-
-        # Check that volume is not 0
-        conditions.append(dataframe['volume'] > 0)
-
-        if conditions:
-            dataframe.loc[
-                reduce(lambda x, y: x & y, conditions),
-                'enter_long'] = 1
-
-        return dataframe
-```
-
-Hyperopt will now call `populate_entry_trend()` many times (`epochs`) with different value combinations.  
-It will use the given historical data and simulate buys based on the buy signals generated with the above function.  
-Based on the results, hyperopt will tell you which parameter combination produced the best results (based on the configured [loss function](#loss-functions)).
-
-!!! Note
-    The above setup expects to find ADX, RSI and Bollinger Bands in the populated indicators.
-    When you want to test an indicator that isn't used by the bot currently, remember to
-    add it to the `populate_indicators()` method in your strategy or hyperopt file.
-
-## Parameter types
-
-There are four parameter types each suited for different purposes.
-
-* `IntParameter` - defines an integral parameter with upper and lower boundaries of search space.
-* `DecimalParameter` - defines a floating point parameter with a limited number of decimals (default 3). Should be preferred instead of `RealParameter` in most cases.
-* `RealParameter` - defines a floating point parameter with upper and lower boundaries and no precision limit. Rarely used as it creates a space with a near infinite number of possibilities.
-* `CategoricalParameter` - defines a parameter with a predetermined number of choices.
-* `BooleanParameter` - Shorthand for `CategoricalParameter([True, False])` - great for "enable" parameters.
-
-### Parameter options
-
-There are two parameter options that can help you to quickly test various ideas:
-
-* `optimize` - when set to `False`, the parameter will not be included in optimization process. (Default: True)
-* `load` - when set to `False`, results of a previous hyperopt run (in `buy_params` and `sell_params` either in your strategy or the JSON output file) will not be used as the starting value for subsequent hyperopts. The default value specified in the parameter will be used instead. (Default: True)
-
-!!! Tip "Effects of `load=False` on backtesting"
-    Be aware that setting the `load` option to `False` will mean backtesting will also use the default value specified in the parameter and *not* the value found through hyperoptimisation.
-
-!!! Warning
-    Hyperoptable parameters cannot be used in `populate_indicators` - as hyperopt does not recalculate indicators for each epoch, so the starting value would be used in this case.
-
-## Optimizing an indicator parameter
-
-Assuming you have a simple strategy in mind - a EMA cross strategy (2 Moving averages crossing) - and you'd like to find the ideal parameters for this strategy.
-By default, we assume a stoploss of 5% - and a take-profit (`minimal_roi`) of 10% - which means freqtrade will sell the trade once 10% profit has been reached.
-
-``` python
-from pandas import DataFrame
-from functools import reduce
-
-import talib.abstract as ta
-
-from freqtrade.strategy import (BooleanParameter, CategoricalParameter, DecimalParameter, 
-                                IStrategy, IntParameter)
-import freqtrade.vendor.qtpylib.indicators as qtpylib
-
-class MyAwesomeStrategy(IStrategy):
-    stoploss = -0.05
-    timeframe = '15m'
-    minimal_roi = {
-        "0":  0.10
-    }
-    # Define the parameter spaces
-    buy_ema_short = IntParameter(3, 50, default=5)
-    buy_ema_long = IntParameter(15, 200, default=50)
-
-
-    def populate_indicators(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
-        """Generate all indicators used by the strategy"""
-        
-        # Calculate all ema_short values
-        for val in self.buy_ema_short.range:
-            dataframe[f'ema_short_{val}'] = ta.EMA(dataframe, timeperiod=val)
-        
-        # Calculate all ema_long values
-        for val in self.buy_ema_long.range:
-            dataframe[f'ema_long_{val}'] = ta.EMA(dataframe, timeperiod=val)
-        
-        return dataframe
-
-    def populate_entry_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
-        conditions = []
-        conditions.append(qtpylib.crossed_above(
-                dataframe[f'ema_short_{self.buy_ema_short.value}'], dataframe[f'ema_long_{self.buy_ema_long.value}']
-            ))
-
-        # Check that volume is not 0
-        conditions.append(dataframe['volume'] > 0)
-
-        if conditions:
-            dataframe.loc[
-                reduce(lambda x, y: x & y, conditions),
-                'enter_long'] = 1
-        return dataframe
-
-    def populate_exit_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
-        conditions = []
-        conditions.append(qtpylib.crossed_above(
-                dataframe[f'ema_long_{self.buy_ema_long.value}'], dataframe[f'ema_short_{self.buy_ema_short.value}']
-            ))
-
-        # Check that volume is not 0
-        conditions.append(dataframe['volume'] > 0)
-
-        if conditions:
-            dataframe.loc[
-                reduce(lambda x, y: x & y, conditions),
-                'exit_long'] = 1
-        return dataframe
-```
-
-Breaking it down:
-
-Using `self.buy_ema_short.range` will return a range object containing all entries between the Parameters low and high value.
-In this case (`IntParameter(3, 50, default=5)`), the loop would run for all numbers between 3 and 50 (`[3, 4, 5, ... 49, 50]`).
-By using this in a loop, hyperopt will generate 48 new columns (`['buy_ema_3', 'buy_ema_4', ... , 'buy_ema_50']`).
-
-Hyperopt itself will then use the selected value to create the buy and sell signals.
-
-While this strategy is most likely too simple to provide consistent profit, it should serve as an example how optimize indicator parameters.
-
-!!! Note
-    `self.buy_ema_short.range` will act differently between hyperopt and other modes. For hyperopt, the above example may generate 48 new columns, however for all other modes (backtesting, dry/live), it will only generate the column for the selected value. You should therefore avoid using the resulting column with explicit values (values other than `self.buy_ema_short.value`).
-
-!!! Note
-    `range` property may also be used with `DecimalParameter` and `CategoricalParameter`. `RealParameter` does not provide this property due to infinite search space.
-
-??? Hint "Performance tip"
-    During normal hyperopting, indicators are calculated once and supplied to each epoch, linearly increasing RAM usage as a factor of increasing cores. As this also has performance implications, there are two alternatives to reduce RAM usage
-
-    * Move `ema_short` and `ema_long` calculations from `populate_indicators()` to `populate_entry_trend()`. Since `populate_entry_trend()` will be calculated every epoch, you don't need to use `.range` functionality.
-    * hyperopt provides `--analyze-per-epoch` which will move the execution of `populate_indicators()` to the epoch process, calculating a single value per parameter per epoch instead of using the `.range` functionality. In this case, `.range` functionality will only return the actually used value.
-
-    These alternatives will reduce RAM usage, but increase CPU usage. However, your hyperopting run will be less likely to fail due to Out Of Memory (OOM) issues.
-
-    Whether you are using `.range` functionality or the alternatives above, you should try to use space ranges as small as possible since this will improve CPU/RAM usage.
-
-
-## Optimizing protections
-
-Freqtrade can also optimize protections. How you optimize protections is up to you, and the following should be considered as example only.
-
-The strategy will simply need to define the "protections" entry as property returning a list of protection configurations.
-
-``` python
-from pandas import DataFrame
-from functools import reduce
-
-import talib.abstract as ta
-
-from freqtrade.strategy import (BooleanParameter, CategoricalParameter, DecimalParameter, 
-                                IStrategy, IntParameter)
-import freqtrade.vendor.qtpylib.indicators as qtpylib
-
-class MyAwesomeStrategy(IStrategy):
-    stoploss = -0.05
-    timeframe = '15m'
-    # Define the parameter spaces
-    cooldown_lookback = IntParameter(2, 48, default=5, space="protection", optimize=True)
-    stop_duration = IntParameter(12, 200, default=5, space="protection", optimize=True)
-    use_stop_protection = BooleanParameter(default=True, space="protection", optimize=True)
-
-
-    @property
-    def protections(self):
-        prot = []
-
-        prot.append({
-            "method": "CooldownPeriod",
-            "stop_duration_candles": self.cooldown_lookback.value
-        })
-        if self.use_stop_protection.value:
-            prot.append({
-                "method": "StoplossGuard",
-                "lookback_period_candles": 24 * 3,
-                "trade_limit": 4,
-                "stop_duration_candles": self.stop_duration.value,
-                "only_per_pair": False
-            })
-
-        return prot
-
-    def populate_indicators(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
-        # ...
-        
-```
-
-You can then run hyperopt as follows:
-`freqtrade hyperopt --hyperopt-loss SharpeHyperOptLossDaily --strategy MyAwesomeStrategy --spaces protection`
-
-!!! Note
-    The protection space is not part of the default space, and is only available with the Parameters Hyperopt interface, not with the legacy hyperopt interface (which required separate hyperopt files).
-    Freqtrade will also automatically change the "--enable-protections" flag if the protection space is selected.
-
-!!! Warning
-    If protections are defined as property, entries from the configuration will be ignored.
-    It is therefore recommended to not define protections in the configuration.
-
-### Migrating from previous property setups
-
-A migration from a previous setup is pretty simple, and can be accomplished by converting the protections entry to a property.
-In simple terms, the following configuration will be converted to the below.
-
-``` python
-class MyAwesomeStrategy(IStrategy):
-    protections = [
-        {
-            "method": "CooldownPeriod",
-            "stop_duration_candles": 4
-        }
-    ]
-```
-
-Result
-
-``` python
-class MyAwesomeStrategy(IStrategy):
-    
-    @property
-    def protections(self):
-        return [
-            {
-                "method": "CooldownPeriod",
-                "stop_duration_candles": 4
-            }
-        ]
-```
-
-You will then obviously also change potential interesting entries to parameters to allow hyper-optimization.
-
-### Optimizing `max_entry_position_adjustment`
-
-While `max_entry_position_adjustment` is not a separate space, it can still be used in hyperopt by using the property approach shown above.
-
-``` python
-from pandas import DataFrame
-from functools import reduce
-
-import talib.abstract as ta
-
-from freqtrade.strategy import (BooleanParameter, CategoricalParameter, DecimalParameter, 
-                                IStrategy, IntParameter)
-import freqtrade.vendor.qtpylib.indicators as qtpylib
-
-class MyAwesomeStrategy(IStrategy):
-    stoploss = -0.05
-    timeframe = '15m'
-
-    # Define the parameter spaces
-    max_epa = CategoricalParameter([-1, 0, 1, 3, 5, 10], default=1, space="buy", optimize=True)
-
-    @property
-    def max_entry_position_adjustment(self):
-        return self.max_epa.value
-        
-
-    def populate_indicators(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
-        # ...
-```
-
-??? Tip "Using `IntParameter`"
-    You can also use the `IntParameter` for this optimization, but you must explicitly return an integer:
-    ``` python
-    max_epa = IntParameter(-1, 10, default=1, space="buy", optimize=True)
-
-    @property
-    def max_entry_position_adjustment(self):
-        return int(self.max_epa.value)
-    ```
-
-## Loss-functions
-
-Each hyperparameter tuning requires a target. This is usually defined as a loss function (sometimes also called objective function), which should decrease for more desirable results, and increase for bad results.
-
-A loss function must be specified via the `--hyperopt-loss <Class-name>` argument (or optionally via the configuration under the `"hyperopt_loss"` key).
-This class should be in its own file within the `user_data/hyperopts/` directory.
-
-Currently, the following loss functions are builtin:
-
-* `ShortTradeDurHyperOptLoss` - (default legacy Freqtrade hyperoptimization loss function) - Mostly for short trade duration and avoiding losses.
-* `OnlyProfitHyperOptLoss` - takes only amount of profit into consideration.
-* `SharpeHyperOptLoss` - optimizes Sharpe Ratio calculated on trade returns relative to standard deviation.
-* `SharpeHyperOptLossDaily` - optimizes Sharpe Ratio calculated on **daily** trade returns relative to standard deviation.
-* `SortinoHyperOptLoss` - optimizes Sortino Ratio calculated on trade returns relative to **downside** standard deviation.
-* `SortinoHyperOptLossDaily` - optimizes Sortino Ratio calculated on **daily** trade returns relative to **downside** standard deviation.
-* `MaxDrawDownHyperOptLoss` - Optimizes Maximum absolute drawdown.
-* `MaxDrawDownRelativeHyperOptLoss` -  Optimizes both maximum absolute drawdown while also adjusting for maximum relative drawdown.
-* `CalmarHyperOptLoss` - Optimizes Calmar Ratio calculated on trade returns relative to max drawdown.
-* `ProfitDrawDownHyperOptLoss` - Optimizes by max Profit & min Drawdown objective. `DRAWDOWN_MULT` variable within the hyperoptloss file can be adjusted to be stricter or more flexible on drawdown purposes.
-
-Creation of a custom loss function is covered in the [Advanced Hyperopt](advanced-hyperopt.md) part of the documentation.
-
-## Execute Hyperopt
-
-Once you have updated your hyperopt configuration you can run it.
-Because hyperopt tries a lot of combinations to find the best parameters it will take time to get a good result.
-
-We strongly recommend to use `screen` or `tmux` to prevent any connection loss.
-
-```bash
-freqtrade hyperopt --config config.json --hyperopt-loss <hyperoptlossname> --strategy <strategyname> -e 500 --spaces all
-```
-
-The `-e` option will set how many evaluations hyperopt will do. Since hyperopt uses Bayesian search, running too many epochs at once may not produce greater results. Experience has shown that best results are usually not improving much after 500-1000 epochs.  
-Doing multiple runs (executions) with a few 1000 epochs and different random state will most likely produce different results.
-
-The `--spaces all` option determines that all possible parameters should be optimized. Possibilities are listed below.
-
-!!! Note
-    Hyperopt will store hyperopt results with the timestamp of the hyperopt start time.
-    Reading commands (`hyperopt-list`, `hyperopt-show`) can use `--hyperopt-filename <filename>` to read and display older hyperopt results.
-    You can find a list of filenames with `ls -l user_data/hyperopt_results/`.
-
-### Execute Hyperopt with different historical data source
-
-If you would like to hyperopt parameters using an alternate historical data set that
-you have on-disk, use the `--datadir PATH` option. By default, hyperopt uses data from directory `user_data/data`.
-
-### Running Hyperopt with a smaller test-set
-
-Use the `--timerange` argument to change how much of the test-set you want to use.
-For example, to use one month of data, pass `--timerange 20210101-20210201` (from january 2021 - february 2021) to the hyperopt call.
-
-Full command:
-
-```bash
-freqtrade hyperopt --strategy <strategyname> --timerange 20210101-20210201
-```
-
-### Running Hyperopt with Smaller Search Space
-
-Use the `--spaces` option to limit the search space used by hyperopt.
-Letting Hyperopt optimize everything is a huuuuge search space.
-Often it might make more sense to start by just searching for initial buy algorithm.
-Or maybe you just want to optimize your stoploss or roi table for that awesome new buy strategy you have.
-
-Legal values are:
-
-* `all`: optimize everything
-* `buy`: just search for a new buy strategy
-* `sell`: just search for a new sell strategy
-* `roi`: just optimize the minimal profit table for your strategy
-* `stoploss`: search for the best stoploss value
-* `trailing`: search for the best trailing stop values
-* `trades`: search for the best max open trades values
-* `protection`: search for the best protection parameters (read the [protections section](#optimizing-protections) on how to properly define these)
-* `default`: `all` except `trailing` and `protection`
-* space-separated list of any of the above values for example `--spaces roi stoploss`
-
-The default Hyperopt Search Space, used when no `--space` command line option is specified, does not include the `trailing` hyperspace. We recommend you to run optimization for the `trailing` hyperspace separately, when the best parameters for other hyperspaces were found, validated and pasted into your custom strategy.
-
-## Understand the Hyperopt Result
-
-Once Hyperopt is completed you can use the result to update your strategy.
-Given the following result from hyperopt:
-
-```
-Best result:
-
-    44/100:    135 trades. Avg profit  0.57%. Total profit  0.03871918 BTC (0.7722%). Avg duration 180.4 mins. Objective: 1.94367
-
-    # Buy hyperspace params:
-    buy_params = {
-        'buy_adx': 44,
-        'buy_rsi': 29,
-        'buy_adx_enabled': False,
-        'buy_rsi_enabled': True,
-        'buy_trigger': 'bb_lower'
-    }
-```
-
-You should understand this result like:
-
-* The buy trigger that worked best was `bb_lower`.
-* You should not use ADX because `'buy_adx_enabled': False`.
-* You should **consider** using the RSI indicator (`'buy_rsi_enabled': True`) and the best value is `29.0` (`'buy_rsi': 29.0`)
-
-### Automatic parameter application to the strategy
-
-When using Hyperoptable parameters, the result of your hyperopt-run will be written to a json file next to your strategy (so for `MyAwesomeStrategy.py`, the file would be `MyAwesomeStrategy.json`).  
-This file is also updated when using the `hyperopt-show` sub-command, unless `--disable-param-export` is provided to either of the 2 commands.
-
-
-Your strategy class can also contain these results explicitly. Simply copy hyperopt results block and paste them at class level, replacing old parameters (if any). New parameters will automatically be loaded next time strategy is executed.
-
-Transferring your whole hyperopt result to your strategy would then look like:
-
-```python
-class MyAwesomeStrategy(IStrategy):
-    # Buy hyperspace params:
-    buy_params = {
-        'buy_adx': 44,
-        'buy_rsi': 29,
-        'buy_adx_enabled': False,
-        'buy_rsi_enabled': True,
-        'buy_trigger': 'bb_lower'
-    }
-```
-
-!!! Note
-    Values in the configuration file will overwrite Parameter-file level parameters - and both will overwrite parameters within the strategy.
-    The prevalence is therefore: config > parameter file > strategy `*_params` > parameter default
-
-### Understand Hyperopt ROI results
-
-If you are optimizing ROI (i.e. if optimization search-space contains 'all', 'default' or 'roi'), your result will look as follows and include a ROI table:
-
-```
-Best result:
-
-    44/100:    135 trades. Avg profit  0.57%. Total profit  0.03871918 BTC (0.7722%). Avg duration 180.4 mins. Objective: 1.94367
-
-    # ROI table:
-    minimal_roi = {
-        0: 0.10674,
-        21: 0.09158,
-        78: 0.03634,
-        118: 0
-    }
-```
-
-In order to use this best ROI table found by Hyperopt in backtesting and for live trades/dry-run, copy-paste it as the value of the `minimal_roi` attribute of your custom strategy:
-
-```
-    # Minimal ROI designed for the strategy.
-    # This attribute will be overridden if the config file contains "minimal_roi"
-    minimal_roi = {
-        0: 0.10674,
-        21: 0.09158,
-        78: 0.03634,
-        118: 0
-    }
-```
-
-As stated in the comment, you can also use it as the value of the `minimal_roi` setting in the configuration file.
-
-#### Default ROI Search Space
-
-If you are optimizing ROI, Freqtrade creates the 'roi' optimization hyperspace for you -- it's the hyperspace of components for the ROI tables. By default, each ROI table generated by the Freqtrade consists of 4 rows (steps). Hyperopt implements adaptive ranges for ROI tables with ranges for values in the ROI steps that depend on the timeframe used. By default the values vary in the following ranges (for some of the most used timeframes, values are rounded to 3 digits after the decimal point):
-
-| # step | 1m     |               | 5m       |             | 1h         |               | 1d           |               |
-| ------ | ------ | ------------- | -------- | ----------- | ---------- | ------------- | ------------ | ------------- |
-| 1      | 0      | 0.011...0.119 | 0        | 0.03...0.31 | 0          | 0.068...0.711 | 0            | 0.121...1.258 |
-| 2      | 2...8  | 0.007...0.042 | 10...40  | 0.02...0.11 | 120...480  | 0.045...0.252 | 2880...11520 | 0.081...0.446 |
-| 3      | 4...20 | 0.003...0.015 | 20...100 | 0.01...0.04 | 240...1200 | 0.022...0.091 | 5760...28800 | 0.040...0.162 |
-| 4      | 6...44 | 0.0           | 30...220 | 0.0         | 360...2640 | 0.0           | 8640...63360 | 0.0           |
-
-These ranges should be sufficient in most cases. The minutes in the steps (ROI dict keys) are scaled linearly depending on the timeframe used. The ROI values in the steps (ROI dict values) are scaled logarithmically depending on the timeframe used.
-
-If you have the `generate_roi_table()` and `roi_space()` methods in your custom hyperopt, remove them in order to utilize these adaptive ROI tables and the ROI hyperoptimization space generated by Freqtrade by default.
-
-Override the `roi_space()` method if you need components of the ROI tables to vary in other ranges. Override the `generate_roi_table()` and `roi_space()` methods and implement your own custom approach for generation of the ROI tables during hyperoptimization if you need a different structure of the ROI tables or other amount of rows (steps).
-
-A sample for these methods can be found in the [overriding pre-defined spaces section](advanced-hyperopt.md#overriding-pre-defined-spaces).
-
-!!! Note "Reduced search space"
-    To limit the search space further, Decimals are limited to 3 decimal places (a precision of 0.001). This is usually sufficient, every value more precise than this will usually result in overfitted results. You can however [overriding pre-defined spaces](advanced-hyperopt.md#overriding-pre-defined-spaces) to change this to your needs.
-
-### Understand Hyperopt Stoploss results
-
-If you are optimizing stoploss values (i.e. if optimization search-space contains 'all', 'default' or 'stoploss'), your result will look as follows and include stoploss:
-
-```
-Best result:
-
-    44/100:    135 trades. Avg profit  0.57%. Total profit  0.03871918 BTC (0.7722%). Avg duration 180.4 mins. Objective: 1.94367
-
-    # Buy hyperspace params:
-    buy_params = {
-        'buy_adx': 44,
-        'buy_rsi': 29,
-        'buy_adx_enabled': False,
-        'buy_rsi_enabled': True,
-        'buy_trigger': 'bb_lower'
-    }
-
-    stoploss: -0.27996
-```
-
-In order to use this best stoploss value found by Hyperopt in backtesting and for live trades/dry-run, copy-paste it as the value of the `stoploss` attribute of your custom strategy:
-
-``` python
-    # Optimal stoploss designed for the strategy
-    # This attribute will be overridden if the config file contains "stoploss"
-    stoploss = -0.27996
-```
-
-As stated in the comment, you can also use it as the value of the `stoploss` setting in the configuration file.
-
-#### Default Stoploss Search Space
-
-If you are optimizing stoploss values, Freqtrade creates the 'stoploss' optimization hyperspace for you. By default, the stoploss values in that hyperspace vary in the range -0.35...-0.02, which is sufficient in most cases.
-
-If you have the `stoploss_space()` method in your custom hyperopt file, remove it in order to utilize Stoploss hyperoptimization space generated by Freqtrade by default.
-
-Override the `stoploss_space()` method and define the desired range in it if you need stoploss values to vary in other range during hyperoptimization. A sample for this method can be found in the [overriding pre-defined spaces section](advanced-hyperopt.md#overriding-pre-defined-spaces).
-
-!!! Note "Reduced search space"
-    To limit the search space further, Decimals are limited to 3 decimal places (a precision of 0.001). This is usually sufficient, every value more precise than this will usually result in overfitted results. You can however [overriding pre-defined spaces](advanced-hyperopt.md#overriding-pre-defined-spaces) to change this to your needs.
-
-### Understand Hyperopt Trailing Stop results
-
-If you are optimizing trailing stop values (i.e. if optimization search-space contains 'all' or 'trailing'), your result will look as follows and include trailing stop parameters:
-
-```
-Best result:
-
-    45/100:    606 trades. Avg profit  1.04%. Total profit  0.31555614 BTC ( 630.48%). Avg duration 150.3 mins. Objective: -1.10161
-
-    # Trailing stop:
-    trailing_stop = True
-    trailing_stop_positive = 0.02001
-    trailing_stop_positive_offset = 0.06038
-    trailing_only_offset_is_reached = True
-```
-
-In order to use these best trailing stop parameters found by Hyperopt in backtesting and for live trades/dry-run, copy-paste them as the values of the corresponding attributes of your custom strategy:
-
-``` python
-    # Trailing stop
-    # These attributes will be overridden if the config file contains corresponding values.
-    trailing_stop = True
-    trailing_stop_positive = 0.02001
-    trailing_stop_positive_offset = 0.06038
-    trailing_only_offset_is_reached = True
-```
-
-As stated in the comment, you can also use it as the values of the corresponding settings in the configuration file.
-
-#### Default Trailing Stop Search Space
-
-If you are optimizing trailing stop values, Freqtrade creates the 'trailing' optimization hyperspace for you. By default, the `trailing_stop` parameter is always set to True in that hyperspace, the value of the `trailing_only_offset_is_reached` vary between True and False, the values of the `trailing_stop_positive` and `trailing_stop_positive_offset` parameters vary in the ranges 0.02...0.35 and 0.01...0.1 correspondingly, which is sufficient in most cases.
-
-Override the `trailing_space()` method and define the desired range in it if you need values of the trailing stop parameters to vary in other ranges during hyperoptimization. A sample for this method can be found in the [overriding pre-defined spaces section](advanced-hyperopt.md#overriding-pre-defined-spaces).
-
-!!! Note "Reduced search space"
-    To limit the search space further, Decimals are limited to 3 decimal places (a precision of 0.001). This is usually sufficient, every value more precise than this will usually result in overfitted results. You can however [overriding pre-defined spaces](advanced-hyperopt.md#overriding-pre-defined-spaces) to change this to your needs.
-
-### Reproducible results
-
-The search for optimal parameters starts with a few (currently 30) random combinations in the hyperspace of parameters, random Hyperopt epochs. These random epochs are marked with an asterisk character (`*`) in the first column in the Hyperopt output.
-
-The initial state for generation of these random values (random state) is controlled by the value of the `--random-state` command line option. You can set it to some arbitrary value of your choice to obtain reproducible results.
-
-If you have not set this value explicitly in the command line options, Hyperopt seeds the random state with some random value for you. The random state value for each Hyperopt run is shown in the log, so you can copy and paste it into the `--random-state` command line option to repeat the set of the initial random epochs used.
-
-If you have not changed anything in the command line options, configuration, timerange, Strategy and Hyperopt classes, historical data and the Loss Function -- you should obtain same hyper-optimization results with same random state value used.
-
-## Output formatting
-
-By default, hyperopt prints colorized results -- epochs with positive profit are printed in the green color. This highlighting helps you find epochs that can be interesting for later analysis. Epochs with zero total profit or with negative profits (losses) are printed in the normal color. If you do not need colorization of results (for instance, when you are redirecting hyperopt output to a file) you can switch colorization off by specifying the `--no-color` option in the command line.
-
-You can use the `--print-all` command line option if you would like to see all results in the hyperopt output, not only the best ones. When `--print-all` is used, current best results are also colorized by default -- they are printed in bold (bright) style. This can also be switched off with the `--no-color` command line option.
-
-!!! Note "Windows and color output"
-    Windows does not support color-output natively, therefore it is automatically disabled. To have color-output for hyperopt running under windows, please consider using WSL.
-
-## Position stacking and disabling max market positions
-
-In some situations, you may need to run Hyperopt (and Backtesting) with the
-`--eps`/`--enable-position-staking` and `--dmmp`/`--disable-max-market-positions` arguments.
-
-By default, hyperopt emulates the behavior of the Freqtrade Live Run/Dry Run, where only one
-open trade is allowed for every traded pair. The total number of trades open for all pairs
-is also limited by the `max_open_trades` setting. During Hyperopt/Backtesting this may lead to
-some potential trades to be hidden (or masked) by previously open trades.
-
-The `--eps`/`--enable-position-stacking` argument allows emulation of buying the same pair multiple times,
-while `--dmmp`/`--disable-max-market-positions` disables applying `max_open_trades`
-during Hyperopt/Backtesting (which is equal to setting `max_open_trades` to a very high
-number).
-
-!!! Note
-    Dry/live runs will **NOT** use position stacking - therefore it does make sense to also validate the strategy without this as it's closer to reality.
-
-You can also enable position stacking in the configuration file by explicitly setting
-`"position_stacking"=true`.
-
-## Out of Memory errors
-
-As hyperopt consumes a lot of memory (the complete data needs to be in memory once per parallel backtesting process), it's likely that you run into "out of memory" errors.
-To combat these, you have multiple options:
-
-* Reduce the amount of pairs.
-* Reduce the timerange used (`--timerange <timerange>`).
-* Avoid using `--timeframe-detail` (this loads a lot of additional data into memory).
-* Reduce the number of parallel processes (`-j <n>`).
-* Increase the memory of your machine.
-* Use `--analyze-per-epoch` if you're using a lot of parameters with `.range` functionality.
-
-
-## The objective has been evaluated at this point before.
-
-If you see `The objective has been evaluated at this point before.` - then this is a sign that your space has been exhausted, or is close to that.
-Basically all points in your space have been hit (or a local minima has been hit) - and hyperopt does no longer find points in the multi-dimensional space it did not try yet.
-Freqtrade tries to counter the "local minima" problem by using new, randomized points in this case.
-
-Example:
-
-``` python
-buy_ema_short = IntParameter(5, 20, default=10, space="buy", optimize=True)
-# This is the only parameter in the buy space
-```
-
-The `buy_ema_short` space has 15 possible values (`5, 6, ... 19, 20`). If you now run hyperopt for the buy space, hyperopt will only have 15 values to try before running out of options.
-Your epochs should therefore be aligned to the possible values - or you should be ready to interrupt a run if you norice a lot of `The objective has been evaluated at this point before.` warnings.
-
-## Show details of Hyperopt results
-
-After you run Hyperopt for the desired amount of epochs, you can later list all results for analysis, select only best or profitable once, and show the details for any of the epochs previously evaluated. This can be done with the `hyperopt-list` and `hyperopt-show` sub-commands. The usage of these sub-commands is described in the [Utils](utils.md#list-hyperopt-results) chapter.
-
-## Validate backtesting results
-
-Once the optimized strategy has been implemented into your strategy, you should backtest this strategy to make sure everything is working as expected.
-
-To achieve same the results (number of trades, their durations, profit, etc.) as during Hyperopt, please use the same configuration and parameters (timerange, timeframe, ...) used for hyperopt `--dmmp`/`--disable-max-market-positions` and `--eps`/`--enable-position-stacking` for Backtesting.
-
-### Why do my backtest results not match my hyperopt results?
-Should results not match, check the following factors:
-
-* You may have added parameters to hyperopt in `populate_indicators()` where they will be calculated only once **for all epochs**. If you are, for example, trying to optimise multiple SMA timeperiod values, the hyperoptable timeperiod parameter should be placed in `populate_entry_trend()` which is calculated every epoch. See [Optimizing an indicator parameter](https://www.freqtrade.io/en/stable/hyperopt/#optimizing-an-indicator-parameter).
-* If you have disabled the auto-export of hyperopt parameters into the JSON parameters file, double-check to make sure you transferred all hyperopted values into your strategy correctly.
-* Check the logs to verify what parameters are being set and what values are being used.
-* Pay special care to the stoploss, max_open_trades and trailing stoploss parameters, as these are often set in configuration files, which override changes to the strategy. Check the logs of your backtest to ensure that there were no parameters inadvertently set by the configuration (like `stoploss`, `max_open_trades` or `trailing_stop`).
-* Verify that you do not have an unexpected parameters JSON file overriding the parameters or the default hyperopt settings in your strategy.
-* Verify that any protections that are enabled in backtesting are also enabled when hyperopting, and vice versa. When using `--space protection`, protections are auto-enabled for hyperopting.

docs/includes/cors.md

@@ -1,43 +0,0 @@
-## CORS
-
-This whole section is only necessary in cross-origin cases (where you multiple bot API's running on `localhost:8081`, `localhost:8082`, ...), and want to combine them into one FreqUI instance.
-
-??? info "Technical explanation"
-    All web-based front-ends are subject to [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) - Cross-Origin Resource Sharing.
-    Since most of the requests to the Freqtrade API must be authenticated, a proper CORS policy is key to avoid security problems.
-    Also, the standard disallows `*` CORS policies for requests with credentials, so this setting must be set appropriately.
-
-Users can allow access from different origin URL's to the bot API via the `CORS_origins` configuration setting.
-It consists of a list of allowed URL's that are allowed to consume resources from the bot's API.
-
-Assuming your application is deployed as `https://frequi.freqtrade.io/home/` - this would mean that the following configuration becomes necessary:
-
-```jsonc
-{
-    //...
-    "jwt_secret_key": "somethingrandom",
-    "CORS_origins": ["https://frequi.freqtrade.io"],
-    //...
-}
-```
-
-In the following (pretty common) case, FreqUI is accessible on `http://localhost:8080/trade` (this is what you see in your navbar when navigating to freqUI).
-![freqUI url](assets/frequi_url.png)
-
-The correct configuration for this case is `http://localhost:8080` - the main part of the URL including the port.
-
-```jsonc
-{
-    //...
-    "jwt_secret_key": "somethingrandom",
-    "CORS_origins": ["http://localhost:8080"],
-    //...
-}
-```
-
-!!! Tip "trailing Slash"
-    The trailing slash is not allowed in the `CORS_origins` configuration (e.g. `"http://localhots:8080/"`).
-    Such a configuration will not take effect, and the cors errors will remain.
-
-!!! Note
-    We strongly recommend to also set `jwt_secret_key` to something random and known only to yourself to avoid unauthorized access to your bot.

docs/includes/pairlists.md

@@ -1,615 +0,0 @@
-## Pairlists and Pairlist Handlers
-
-Pairlist Handlers define the list of pairs (pairlist) that the bot should trade. They are configured in the `pairlists` section of the configuration settings.
-
-In your configuration, you can use Static Pairlist (defined by the [`StaticPairList`](#static-pair-list) Pairlist Handler) and Dynamic Pairlist (defined by the [`VolumePairList`](#volume-pair-list) and [`PercentChangePairList`](#percent-change-pair-list) Pairlist Handlers).
-
-Additionally, [`AgeFilter`](#agefilter), [`PrecisionFilter`](#precisionfilter), [`PriceFilter`](#pricefilter), [`ShuffleFilter`](#shufflefilter), [`SpreadFilter`](#spreadfilter) and [`VolatilityFilter`](#volatilityfilter) act as Pairlist Filters, removing certain pairs and/or moving their positions in the pairlist.
-
-If multiple Pairlist Handlers are used, they are chained and a combination of all Pairlist Handlers forms the resulting pairlist the bot uses for trading and backtesting. Pairlist Handlers are executed in the sequence they are configured. You can define either `StaticPairList`, `VolumePairList`, `ProducerPairList`, `RemotePairList`, `MarketCapPairList` or `PercentChangePairList` as the starting Pairlist Handler.
-
-Inactive markets are always removed from the resulting pairlist. Explicitly blacklisted pairs (those in the `pair_blacklist` configuration setting) are also always removed from the resulting pairlist.
-
-### Pair blacklist
-
-The pair blacklist (configured via `exchange.pair_blacklist` in the configuration) disallows certain pairs from trading.
-This can be as simple as excluding `DOGE/BTC` - which will remove exactly this pair.
-
-The pair-blacklist does also support wildcards (in regex-style) - so `BNB/.*` will exclude ALL pairs that start with BNB.
-You may also use something like `.*DOWN/BTC` or `.*UP/BTC` to exclude leveraged tokens (check Pair naming conventions for your exchange!)
-
-### Available Pairlist Handlers
-
-* [`StaticPairList`](#static-pair-list) (default, if not configured differently)
-* [`VolumePairList`](#volume-pair-list)
-* [`PercentChangePairList`](#percent-change-pair-list)
-* [`ProducerPairList`](#producerpairlist)
-* [`RemotePairList`](#remotepairlist)
-* [`MarketCapPairList`](#marketcappairlist)
-* [`AgeFilter`](#agefilter)
-* [`FullTradesFilter`](#fulltradesfilter)
-* [`OffsetFilter`](#offsetfilter)
-* [`PerformanceFilter`](#performancefilter)
-* [`PrecisionFilter`](#precisionfilter)
-* [`PriceFilter`](#pricefilter)
-* [`ShuffleFilter`](#shufflefilter)
-* [`SpreadFilter`](#spreadfilter)
-* [`RangeStabilityFilter`](#rangestabilityfilter)
-* [`VolatilityFilter`](#volatilityfilter)
-
-!!! Tip "Testing pairlists"
-    Pairlist configurations can be quite tricky to get right. Best use the [`test-pairlist`](utils.md#test-pairlist) utility sub-command to test your configuration quickly.
-
-#### Static Pair List
-
-By default, the `StaticPairList` method is used, which uses a statically defined pair whitelist from the configuration. The pairlist also supports wildcards (in regex-style) - so `.*/BTC` will include all pairs with BTC as a stake.
-
-It uses configuration from `exchange.pair_whitelist` and `exchange.pair_blacklist`.
-
-```json
-"pairlists": [
-    {"method": "StaticPairList"}
-],
-```
-
-By default, only currently enabled pairs are allowed.
-To skip pair validation against active markets, set `"allow_inactive": true` within the `StaticPairList` configuration.
-This can be useful for backtesting expired pairs (like quarterly spot-markets).
-
-When used in a "follow-up" position (e.g. after VolumePairlist), all pairs in `'pair_whitelist'` will be added to the end of the pairlist.
-
-#### Volume Pair List
-
-`VolumePairList` employs sorting/filtering of pairs by their trading volume. It selects `number_assets` top pairs with sorting based on the `sort_key` (which can only be `quoteVolume`).
-
-When used in the chain of Pairlist Handlers in a non-leading position (after StaticPairList and other Pairlist Filters), `VolumePairList` considers outputs of previous Pairlist Handlers, adding its sorting/selection of the pairs by the trading volume.
-
-When used in the leading position of the chain of Pairlist Handlers, the `pair_whitelist` configuration setting is ignored. Instead, `VolumePairList` selects the top assets from all available markets with matching stake-currency on the exchange.
-
-The `refresh_period` setting allows to define the period (in seconds), at which the pairlist will be refreshed. Defaults to 1800s (30 minutes).
-The pairlist cache (`refresh_period`) on `VolumePairList` is only applicable to generating pairlists.
-Filtering instances (not the first position in the list) will not apply any cache (beyond caching candles for the duration of the candle in advanced mode) and will always use up-to-date data.
-
-`VolumePairList` is per default based on the ticker data from exchange, as reported by the ccxt library:
-
-* The `quoteVolume` is the amount of quote (stake) currency traded (bought or sold) in last 24 hours.
-
-```json
-"pairlists": [
-    {
-        "method": "VolumePairList",
-        "number_assets": 20,
-        "sort_key": "quoteVolume",
-        "min_value": 0,
-        "max_value": 8000000,
-        "refresh_period": 1800
-    }
-],
-```
-
-You can define a minimum volume with `min_value` - which will filter out pairs with a volume lower than the specified value in the specified timerange.
-In addition to that, you can also define a maximum volume with `max_value` - which will filter out pairs with a volume higher than the specified value in the specified timerange.
-
-##### VolumePairList Advanced mode
-
-`VolumePairList` can also operate in an advanced mode to build volume over a given timerange of specified candle size. It utilizes exchange historical candle data, builds a typical price (calculated by (open+high+low)/3) and multiplies the typical price with every candle's volume. The sum is the `quoteVolume` over the given range. This allows different scenarios, for a  more smoothened volume, when using longer ranges with larger candle sizes, or the opposite when using a short range with small candles.
-
-For convenience `lookback_days` can be specified, which will imply that 1d candles will be used for the lookback. In the example below the pairlist would be created based on the last 7 days:
-
-```json
-"pairlists": [
-    {
-        "method": "VolumePairList",
-        "number_assets": 20,
-        "sort_key": "quoteVolume",
-        "min_value": 0,
-        "refresh_period": 86400,
-        "lookback_days": 7
-    }
-],
-```
-
-!!! Warning "Range look back and refresh period"
-    When used in conjunction with `lookback_days` and `lookback_timeframe` the `refresh_period` can not be smaller than the candle size in seconds. As this will result in unnecessary requests to the exchanges API.
-
-!!! Warning "Performance implications when using lookback range"
-    If used in first position in combination with lookback, the computation of the range based volume can be time and resource consuming, as it downloads candles for all tradable pairs. Hence it's highly advised to use the standard approach with `VolumeFilter` to narrow the pairlist down for further range volume calculation.
-
-??? Tip "Unsupported exchanges"
-    On some exchanges (like Gemini), regular VolumePairList does not work as the api does not natively provide 24h volume. This can be worked around by using candle data to build the volume.
-    To roughly simulate 24h volume, you can use the following configuration.
-    Please note that These pairlists will only refresh once per day.
-
-    ```json
-    "pairlists": [
-        {
-            "method": "VolumePairList",
-            "number_assets": 20,
-            "sort_key": "quoteVolume",
-            "min_value": 0,
-            "refresh_period": 86400,
-            "lookback_days": 1
-        }
-    ],
-    ```
-
-More sophisticated approach can be used, by using `lookback_timeframe` for candle size and `lookback_period` which specifies the amount of candles. This example will build the volume pairs based on a rolling period of 3 days of 1h candles:
-
-```json
-"pairlists": [
-    {
-        "method": "VolumePairList",
-        "number_assets": 20,
-        "sort_key": "quoteVolume",
-        "min_value": 0,
-        "refresh_period": 3600,
-        "lookback_timeframe": "1h",
-        "lookback_period": 72
-    }
-],
-```
-
-!!! Note
-    `VolumePairList` does not support backtesting mode.
-
-#### Percent Change Pair List
-
-`PercentChangePairList` filters and sorts pairs based on the percentage change in their price over the last 24 hours or any defined timeframe as part of advanced options. This allows traders to focus on assets that have experienced significant price movements, either positive or negative.
-
-**Configuration Options**
-
-* `number_assets`: Specifies the number of top pairs to select based on the 24-hour percentage change.
-* `min_value`: Sets a minimum percentage change threshold. Pairs with a percentage change below this value will be filtered out.
-* `max_value`: Sets a maximum percentage change threshold. Pairs with a percentage change above this value will be filtered out.
-* `sort_direction`: Specifies the order in which pairs are sorted based on their percentage change. Accepts two values: `asc` for ascending order and `desc` for descending order.
-* `refresh_period`: Defines the interval (in seconds) at which the pairlist will be refreshed. The default is 1800 seconds (30 minutes).
-* `lookback_days`: Number of days to look back. When `lookback_days` is selected, the `lookback_timeframe` is defaulted to 1 day.
-* `lookback_timeframe`: Timeframe to use for the lookback period.
-* `lookback_period`: Number of periods to look back at. 
-
-When PercentChangePairList is used after other Pairlist Handlers, it will operate on the outputs of those handlers. If it is the leading Pairlist Handler, it will select pairs from all available markets with the specified stake currency.
-
-`PercentChangePairList` uses ticker data from the exchange, provided via the ccxt library:
-The percentage change is calculated as the change in price over the last 24 hours.
-
-??? Note "Unsupported exchanges"
-    On some exchanges (like HTX), regular PercentChangePairList does not work as the api does not natively provide 24h percent change in price. This can be worked around by using candle data to calculate the percentage change. To roughly simulate 24h percent change, you can use the following configuration. Please note that these pairlists will only refresh once per day.
-    ```json
-    "pairlists": [
-        {
-            "method": "PercentChangePairList",
-            "number_assets": 20,
-            "min_value": 0,
-            "refresh_period": 86400,
-            "lookback_days": 1
-        }
-    ],
-    ```
-
-**Example Configuration to Read from Ticker**
-
-```json
-"pairlists": [
-    {
-        "method": "PercentChangePairList",
-        "number_assets": 15,
-        "min_value": -10,
-        "max_value": 50
-    }
-],
-```
-
-In this configuration:
-
-1. The top 15 pairs are selected based on the highest percentage change in price over the last 24 hours.
-2. Only pairs with a percentage change between -10% and 50% are considered.
-
-**Example Configuration to Read from Candles**
-
-```json
-"pairlists": [
-    {
-        "method": "PercentChangePairList",
-        "number_assets": 15,
-        "sort_key": "percentage",
-        "min_value": 0,
-        "refresh_period": 3600,
-        "lookback_timeframe": "1h",
-        "lookback_period": 72
-    }
-],
-```
-
-This example builds the percent change pairs based on a rolling period of 3 days of 1-hour candles by using `lookback_timeframe` for candle size and `lookback_period` which specifies the number of candles.
-
-The percent change in price is calculated using the following formula, which expresses the percentage difference between the current candle's close price and the previous candle's close price, as defined by the specified timeframe and lookback period:
-
-$$ Percent Change = (\frac{Current Close - Previous Close}{Previous Close}) * 100 $$
-
-!!! Warning "Range look back and refresh period"
-    When used in conjunction with `lookback_days` and `lookback_timeframe` the `refresh_period` can not be smaller than the candle size in seconds. As this will result in unnecessary requests to the exchanges API.
-
-!!! Warning "Performance implications when using lookback range"
-    If used in first position in combination with lookback, the computation of the range-based percent change can be time and resource consuming, as it downloads candles for all tradable pairs. Hence it's highly advised to use the standard approach with `PercentChangePairList` to narrow the pairlist down for further percent-change calculation.
-
-!!! Note "Backtesting"
-    `PercentChangePairList` does not support backtesting mode.
-
-#### ProducerPairList
-
-With `ProducerPairList`, you can reuse the pairlist from a [Producer](producer-consumer.md) without explicitly defining the pairlist on each consumer.
-
-[Consumer mode](producer-consumer.md) is required for this pairlist to work.
-
-The pairlist will perform a check on active pairs against the current exchange configuration to avoid attempting to trade on invalid markets.
-
-You can limit the length of the pairlist with the optional parameter `number_assets`. Using `"number_assets"=0` or omitting this key will result in the reuse of all producer pairs valid for the current setup.
-
-```json
-"pairlists": [
-    {
-        "method": "ProducerPairList",
-        "number_assets": 5,
-        "producer_name": "default",
-    }
-],
-```
-
-
-!!! Tip "Combining pairlists"
-    This pairlist can be combined with all other pairlists and filters for further pairlist reduction, and can also act as an "additional" pairlist, on top of already defined pairs.
-    `ProducerPairList` can also be used multiple times in sequence, combining the pairs from multiple producers.
-    Obviously in complex such configurations, the Producer may not provide data for all pairs, so the strategy must be fit for this.
-
-#### RemotePairList
-
-It allows the user to fetch a pairlist from a remote server or a locally stored json file within the freqtrade directory, enabling dynamic updates and customization of the trading pairlist.
-
-The RemotePairList is defined in the pairlists section of the configuration settings. It uses the following configuration options:
-
-```json
-"pairlists": [
-    {
-        "method": "RemotePairList",
-        "mode": "whitelist",
-        "processing_mode": "filter",
-        "pairlist_url": "https://example.com/pairlist",
-        "number_assets": 10,
-        "refresh_period": 1800,
-        "keep_pairlist_on_failure": true,
-        "read_timeout": 60,
-        "bearer_token": "my-bearer-token",
-        "save_to_file": "user_data/filename.json" 
-    }
-]
-```
-
-The optional `mode` option specifies if the pairlist should be used as a `blacklist` or as a `whitelist`. The default value is "whitelist".
-
-The optional `processing_mode` option in the RemotePairList configuration determines how the retrieved pairlist is processed. It can have two values: "filter" or "append". The default value is "filter".
-
-In "filter" mode, the retrieved pairlist is used as a filter. Only the pairs present in both the original pairlist and the retrieved pairlist are included in the final pairlist. Other pairs are filtered out.
-
-In "append" mode, the retrieved pairlist is added to the original pairlist. All pairs from both lists are included in the final pairlist without any filtering.
-
-The `pairlist_url` option specifies the URL of the remote server where the pairlist is located, or the path to a local file (if file:/// is prepended). This allows the user to use either a remote server or a local file as the source for the pairlist.
-
-The `save_to_file` option, when provided with a valid filename, saves the processed pairlist to that file in JSON format. This option is optional, and by default, the pairlist is not saved to a file.
-
-??? Example "Multi bot with shared pairlist example"
-    
-    `save_to_file` can be used to save the pairlist to a file with Bot1:
-
-    ```json
-    "pairlists": [
-        {
-            "method": "RemotePairList",
-            "mode": "whitelist",
-            "pairlist_url": "https://example.com/pairlist",
-            "number_assets": 10,
-            "refresh_period": 1800,
-            "keep_pairlist_on_failure": true,
-            "read_timeout": 60,
-            "save_to_file": "user_data/filename.json" 
-        }
-    ]
-    ```
-
-    This saved pairlist file can be loaded by Bot2, or any additional bot with this configuration:
-
-    ```json
-    "pairlists": [
-        {
-            "method": "RemotePairList",
-            "mode": "whitelist",
-            "pairlist_url": "file:///user_data/filename.json",
-            "number_assets": 10,
-            "refresh_period": 10,
-            "keep_pairlist_on_failure": true,
-        }
-    ]
-    ```    
-
-The user is responsible for providing a server or local file that returns a JSON object with the following structure:
-
-```json
-{
-    "pairs": ["XRP/USDT", "ETH/USDT", "LTC/USDT"],
-    "refresh_period": 1800
-}
-```
-
-The `pairs` property should contain a list of strings with the trading pairs to be used by the bot. The `refresh_period` property is optional and specifies the number of seconds that the pairlist should be cached before being refreshed.
-
-The optional `keep_pairlist_on_failure` specifies whether the previous received pairlist should be used if the remote server is not reachable or returns an error. The default value is true.
-
-The optional `read_timeout` specifies the maximum amount of time (in seconds) to wait for a response from the remote source, The default value is 60.
-
-The optional `bearer_token` will be included in the requests Authorization Header.
-
-!!! Note
-    In case of a server error the last received pairlist will be kept if `keep_pairlist_on_failure` is set to true, when set to false a empty pairlist is returned.
-
-#### MarketCapPairList
-
-`MarketCapPairList` employs sorting/filtering of pairs by their marketcap rank based of CoinGecko. It will only recognize coins up to the coin placed at rank 250. The returned pairlist will be sorted based of their marketcap ranks.
-
-```json
-"pairlists": [
-    {
-        "method": "MarketCapPairList",
-        "number_assets": 20,
-        "max_rank": 50,
-        "refresh_period": 86400,
-        "categories": ["layer-1"]
-    }
-]
-```
-
-`number_assets` defines the maximum number of pairs returned by the pairlist. `max_rank` will determine the maximum rank used in creating/filtering the pairlist. It's expected that some coins within the top `max_rank` marketcap will not be included in the resulting pairlist since not all pairs will have active trading pairs in your preferred market/stake/exchange combination.
-
-The `refresh_period` setting defines the interval (in seconds) at which the marketcap rank data will be refreshed. The default is 86,400 seconds (1 day). The pairlist cache (`refresh_period`) applies to both generating pairlists (when in the first position in the list) and filtering instances (when not in the first position in the list).
-
-The `categories` setting specifies the [coingecko categories](https://www.coingecko.com/en/categories) from which to select coins from. The default is an empty list `[]`, meaning no category filtering is applied.
-If an incorrect category string is chosen, the plugin will print the available categories from CoinGecko and fail. The category should be the ID of the category, for example, for `https://www.coingecko.com/en/categories/layer-1`, the category ID would be `layer-1`. You can pass multiple categories such as `["layer-1", "meme-token"]` to select from several categories.
-
-!!! Warning "Many categories"
-    Each added category corresponds to one API call to CoinGecko. The more categories you add, the longer the pairlist generation will take, potentially causing rate limit issues.
-
-#### AgeFilter
-
-Removes pairs that have been listed on the exchange for less than `min_days_listed` days (defaults to `10`) or more than `max_days_listed` days (defaults `None` mean infinity).
-
-When pairs are first listed on an exchange they can suffer huge price drops and volatility
-in the first few days while the pair goes through its price-discovery period. Bots can often
-be caught out buying before the pair has finished dropping in price.
-
-This filter allows freqtrade to ignore pairs until they have been listed for at least `min_days_listed` days and listed before `max_days_listed`.
-
-#### FullTradesFilter
-
-Shrink whitelist to consist only in-trade pairs when the trade slots are full (when `max_open_trades` isn't being set to `-1` in the config).
-
-When the trade slots are full, there is no need to calculate indicators of the rest of the pairs (except informative pairs) since no new trade can be opened. By shrinking the whitelist to just the in-trade pairs, you can improve calculation speeds and reduce CPU usage. When a trade slot is free (either a trade is closed or `max_open_trades` value in config is increased), then the whitelist will return to normal state.
-
-When multiple pairlist filters are being used, it's recommended to put this filter at second position directly below the primary pairlist, so when the trade slots are full, the bot doesn't have to download data for the rest of the filters.
-
-!!! Warning "Backtesting"
-    `FullTradesFilter` does not support backtesting mode.
-
-#### OffsetFilter
-
-Offsets an incoming pairlist by a given `offset` value.
-
-As an example it can be used in conjunction with `VolumeFilter` to remove the top X volume pairs. Or to split a larger pairlist on two bot instances.
-
-Example to remove the first 10 pairs from the pairlist, and takes the next 20 (taking items 10-30 of the initial list):
-
-```json
-"pairlists": [
-    // ...
-    {
-        "method": "OffsetFilter",
-        "offset": 10,
-        "number_assets": 20
-    }
-],
-```
-
-!!! Warning
-    When `OffsetFilter` is used to split a larger pairlist among multiple bots in combination with `VolumeFilter` 
-    it can not be guaranteed that pairs won't overlap due to slightly different refresh intervals for the
-    `VolumeFilter`.
-
-!!! Note
-    An offset larger than the total length of the incoming pairlist will result in an empty pairlist.
-
-#### PerformanceFilter
-
-Sorts pairs by past trade performance, as follows:
-
-1. Positive performance.
-2. No closed trades yet.
-3. Negative performance.
-
-Trade count is used as a tie breaker.
-
-You can use the `minutes` parameter to only consider performance of the past X minutes (rolling window).
-Not defining this parameter (or setting it to 0) will use all-time performance.
-
-The optional `min_profit` (as ratio -> a setting of `0.01` corresponds to 1%) parameter defines the minimum profit a pair must have to be considered.
-Pairs below this level will be filtered out.
-Using this parameter without `minutes` is highly discouraged, as it can lead to an empty pairlist without a way to recover.
-
-```json
-"pairlists": [
-    // ...
-    {
-        "method": "PerformanceFilter",
-        "minutes": 1440,  // rolling 24h
-        "min_profit": 0.01  // minimal profit 1%
-    }
-],
-```
-
-As this Filter uses past performance of the bot, it'll have some startup-period - and should only be used after the bot has a few 100 trades in the database.
-
-!!! Warning "Backtesting"
-    `PerformanceFilter` does not support backtesting mode.
-
-#### PrecisionFilter
-
-Filters low-value coins which would not allow setting stoplosses.
-
-Namely, pairs are blacklisted if a variance of one percent or more in the stop price would be caused by precision rounding on the exchange, i.e. `rounded(stop_price) <= rounded(stop_price * 0.99)`. The idea is to avoid coins with a value VERY close to their lower trading boundary, not allowing setting of proper stoploss.
-
-!!! Tip "PrecisionFilter is pointless for futures trading"
-    The above does not apply to shorts. And for longs, in theory the trade will be liquidated first.
-
-!!! Warning "Backtesting"
-    `PrecisionFilter` does not support backtesting mode using multiple strategies.
-
-#### PriceFilter
-
-The `PriceFilter` allows filtering of pairs by price. Currently the following price filters are supported:
-
-* `min_price`
-* `max_price`
-* `max_value`
-* `low_price_ratio`
-
-The `min_price` setting removes pairs where the price is below the specified price. This is useful if you wish to avoid trading very low-priced pairs.
-This option is disabled by default, and will only apply if set to > 0.
-
-The `max_price` setting removes pairs where the price is above the specified price. This is useful if you wish to trade only low-priced pairs.
-This option is disabled by default, and will only apply if set to > 0.
-
-The `max_value` setting removes pairs where the minimum value change is above a specified value.
-This is useful when an exchange has unbalanced limits. For example, if step-size = 1 (so you can only buy 1, or 2, or 3, but not 1.1 Coins) - and the price is pretty high (like 20\$) as the coin has risen sharply since the last limit adaption.
-As a result of the above, you can only buy for 20\$, or 40\$ - but not for 25\$.
-On exchanges that deduct fees from the receiving currency (e.g. binance) - this can result in high value coins / amounts that are unsellable as the amount is slightly below the limit.
-
-The `low_price_ratio` setting removes pairs where a raise of 1 price unit (pip) is above the `low_price_ratio` ratio.
-This option is disabled by default, and will only apply if set to > 0.
-
-For `PriceFilter` at least one of its `min_price`, `max_price` or `low_price_ratio` settings must be applied.
-
-Calculation example:
-
-Min price precision for SHITCOIN/BTC is 8 decimals. If its price is 0.00000011 - one price step above would be 0.00000012, which is ~9% higher than the previous price value. You may filter out this pair by using PriceFilter with `low_price_ratio` set to 0.09 (9%) or with `min_price` set to 0.00000011, correspondingly.
-
-!!! Warning "Low priced pairs"
-    Low priced pairs with high "1 pip movements" are dangerous since they are often illiquid and it may also be impossible to place the desired stoploss, which can often result in high losses since price needs to be rounded to the next tradable price - so instead of having a stoploss of -5%, you could end up with a stoploss of -9% simply due to price rounding.
-
-#### ShuffleFilter
-
-Shuffles (randomizes) pairs in the pairlist. It can be used for preventing the bot from trading some of the pairs more frequently then others when you want all pairs be treated with the same priority.
-
-By default, ShuffleFilter will shuffle pairs once per candle.
-To shuffle on every iteration, set `"shuffle_frequency"` to `"iteration"` instead of  the default of `"candle"`.
-
-``` json
-    {
-        "method": "ShuffleFilter", 
-        "shuffle_frequency": "candle",
-        "seed": 42
-    }
-
-```
-
-!!! Tip
-    You may set the `seed` value for this Pairlist to obtain reproducible results, which can be useful for repeated backtesting sessions. If `seed` is not set, the pairs are shuffled in the non-repeatable random order. ShuffleFilter will automatically detect runmodes and apply the `seed` only for backtesting modes - if a `seed` value is set.
-
-#### SpreadFilter
-
-Removes pairs that have a difference between asks and bids above the specified ratio, `max_spread_ratio` (defaults to `0.005`).
-
-Example:
-
-If `DOGE/BTC` maximum bid is 0.00000026 and minimum ask is 0.00000027, the ratio is calculated as: `1 - bid/ask ~= 0.037` which is `> 0.005` and this pair will be filtered out.
-
-#### RangeStabilityFilter
-
-Removes pairs where the difference between lowest low and highest high over `lookback_days` days is below `min_rate_of_change` or above `max_rate_of_change`. Since this is a filter that requires additional data, the results are cached for `refresh_period`.
-
-In the below example:
-If the trading range over the last 10 days is <1% or >99%, remove the pair from the whitelist.
-
-```json
-"pairlists": [
-    {
-        "method": "RangeStabilityFilter",
-        "lookback_days": 10,
-        "min_rate_of_change": 0.01,
-        "max_rate_of_change": 0.99,
-        "refresh_period": 86400
-    }
-]
-```
-
-Adding `"sort_direction": "asc"` or `"sort_direction": "desc"` enables sorting for this pairlist.
-
-!!! Tip
-    This Filter can be used to automatically remove stable coin pairs, which have a very low trading range, and are therefore extremely difficult to trade with profit.
-    Additionally, it can also be used to automatically remove pairs with extreme high/low variance over a given amount of time.
-
-#### VolatilityFilter
-
-Volatility is the degree of historical variation of a pairs over time, it is measured by the standard deviation of logarithmic daily returns. Returns are assumed to be normally distributed, although actual distribution might be different. In a normal distribution, 68% of observations fall within one standard deviation and 95% of observations fall within two standard deviations. Assuming a volatility of 0.05 means that the expected returns for 20 out of 30 days is expected to be less than 5% (one standard deviation). Volatility is a positive ratio of the expected deviation of return and can be greater than 1.00. Please refer to the wikipedia definition of [`volatility`](https://en.wikipedia.org/wiki/Volatility_(finance)).
-
-This filter removes pairs if the average volatility over a `lookback_days` days is below `min_volatility` or above `max_volatility`. Since this is a filter that requires additional data, the results are cached for `refresh_period`.
-
-This filter can be used to narrow down your pairs to a certain volatility or avoid very volatile pairs.
-
-In the below example:
-If the volatility over the last 10 days is not in the range of 0.05-0.50, remove the pair from the whitelist. The filter is applied every 24h.
-
-```json
-"pairlists": [
-    {
-        "method": "VolatilityFilter",
-        "lookback_days": 10,
-        "min_volatility": 0.05,
-        "max_volatility": 0.50,
-        "refresh_period": 86400
-    }
-]
-```
-
-Adding `"sort_direction": "asc"` or `"sort_direction": "desc"` enables sorting mode for this pairlist.
-
-### Full example of Pairlist Handlers
-
-The below example blacklists `BNB/BTC`, uses `VolumePairList` with `20` assets, sorting pairs by `quoteVolume` and applies [`PrecisionFilter`](#precisionfilter) and [`PriceFilter`](#pricefilter), filtering all assets where 1 price unit is > 1%. Then the [`SpreadFilter`](#spreadfilter) and [`VolatilityFilter`](#volatilityfilter) is applied and pairs are finally shuffled with the random seed set to some predefined value.
-
-```json
-"exchange": {
-    "pair_whitelist": [],
-    "pair_blacklist": ["BNB/BTC"]
-},
-"pairlists": [
-    {
-        "method": "VolumePairList",
-        "number_assets": 20,
-        "sort_key": "quoteVolume"
-    },
-    {"method": "AgeFilter", "min_days_listed": 10},
-    {"method": "PrecisionFilter"},
-    {"method": "PriceFilter", "low_price_ratio": 0.01},
-    {"method": "SpreadFilter", "max_spread_ratio": 0.005},
-    {
-        "method": "RangeStabilityFilter",
-        "lookback_days": 10,
-        "min_rate_of_change": 0.01,
-        "refresh_period": 86400
-    },
-    {
-        "method": "VolatilityFilter",
-        "lookback_days": 10,
-        "min_volatility": 0.05,
-        "max_volatility": 0.50,
-        "refresh_period": 86400
-    },
-    {"method": "ShuffleFilter", "seed": 42}
-],
-```

docs/includes/pricing.md

@@ -1,146 +0,0 @@
-## Prices used for orders
-
-Prices for regular orders can be controlled via the parameter structures `entry_pricing` for trade entries and `exit_pricing` for trade exits.
-Prices are always retrieved right before an order is placed, either by querying the exchange tickers or by using the orderbook data.
-
-!!! Note
-    Orderbook data used by Freqtrade are the data retrieved from exchange by the ccxt's function `fetch_order_book()`, i.e. are usually data from the L2-aggregated orderbook, while the ticker data are the structures returned by the ccxt's `fetch_ticker()`/`fetch_tickers()` functions. Refer to the ccxt library [documentation](https://github.com/ccxt/ccxt/wiki/Manual#market-data) for more details.
-
-!!! Warning "Using market orders"
-    Please read the section [Market order pricing](#market-order-pricing) section when using market orders.
-
-### Entry price
-
-#### Enter price side
-
-The configuration setting `entry_pricing.price_side` defines the side of the orderbook the bot looks for when buying.
-
-The following displays an orderbook.
-
-``` explanation
-...
-103
-102
-101  # ask
--------------Current spread
-99   # bid
-98
-97
-...
-```
-
-If `entry_pricing.price_side` is set to `"bid"`, then the bot will use 99 as entry price.  
-In line with that, if `entry_pricing.price_side` is set to `"ask"`, then the bot will use 101 as entry price.
-
-Depending on the order direction (_long_/_short_), this will lead to different results. Therefore we recommend to use `"same"` or `"other"` for this configuration instead.
-This would result in the following pricing matrix:
-
-| direction | Order | setting | price | crosses spread |
-|------ |--------|-----|-----|-----|
-| long  | buy  | ask   | 101 | yes |
-| long  | buy  | bid   | 99  | no  |
-| long  | buy  | same  | 99  | no  |
-| long  | buy  | other | 101 | yes |
-| short | sell | ask   | 101 | no  |
-| short | sell | bid   | 99  | yes |
-| short | sell | same  | 101 | no  |
-| short | sell | other | 99  | yes |
-
-Using the other side of the orderbook often guarantees quicker filled orders, but the bot can also end up paying more than what would have been necessary.
-Taker fees instead of maker fees will most likely apply even when using limit buy orders.
-Also, prices at the "other" side of the spread are higher than prices at the "bid" side in the orderbook, so the order behaves similar to a market order (however with a maximum price).
-
-#### Entry price with Orderbook enabled
-
-When entering a trade with the orderbook enabled (`entry_pricing.use_order_book=True`), Freqtrade fetches the `entry_pricing.order_book_top` entries from the orderbook and uses the entry specified as `entry_pricing.order_book_top` on the configured side (`entry_pricing.price_side`) of the orderbook. 1 specifies the topmost entry in the orderbook, while 2 would use the 2nd entry in the orderbook, and so on.
-
-#### Entry price without Orderbook enabled
-
-The following section uses `side` as the configured `entry_pricing.price_side` (defaults to `"same"`).
-
-When not using orderbook (`entry_pricing.use_order_book=False`), Freqtrade uses the best `side` price from the ticker if it's below the `last` traded price from the ticker. Otherwise (when the `side` price is above the `last` price), it calculates a rate between `side` and `last` price based on `entry_pricing.price_last_balance`.
-
-The `entry_pricing.price_last_balance` configuration parameter controls this. A value of `0.0` will use `side` price, while `1.0` will use the `last` price and values between those interpolate between ask and last price.
-
-#### Check depth of market
-
-When check depth of market is enabled (`entry_pricing.check_depth_of_market.enabled=True`), the entry signals are filtered based on the orderbook depth (sum of all amounts) for each orderbook side.
-
-Orderbook `bid` (buy) side depth is then divided by the orderbook `ask` (sell) side depth and the resulting delta is compared to the value of the `entry_pricing.check_depth_of_market.bids_to_ask_delta` parameter. The entry order is only executed if the orderbook delta is greater than or equal to the configured delta value.
-
-!!! Note
-    A delta value below 1 means that `ask` (sell) orderbook side depth is greater than the depth of the `bid` (buy) orderbook side, while a value greater than 1 means opposite (depth of the buy side is higher than the depth of the sell side).
-
-### Exit price
-
-#### Exit price side
-
-The configuration setting `exit_pricing.price_side` defines the side of the spread the bot looks for when exiting a trade.
-
-The following displays an orderbook:
-
-``` explanation
-...
-103
-102
-101  # ask
--------------Current spread
-99   # bid
-98
-97
-...
-```
-
-If `exit_pricing.price_side` is set to `"ask"`, then the bot will use 101 as exiting price.  
-In line with that, if `exit_pricing.price_side` is set to `"bid"`, then the bot will use 99 as exiting price.
-
-Depending on the order direction (_long_/_short_), this will lead to different results. Therefore we recommend to use `"same"` or `"other"` for this configuration instead.
-This would result in the following pricing matrix:
-
-| Direction | Order | setting | price | crosses spread |
-|------ |--------|-----|-----|-----|
-| long  | sell | ask   | 101 | no  |
-| long  | sell | bid   | 99  | yes |
-| long  | sell | same  | 101 | no  |
-| long  | sell | other | 99  | yes |
-| short | buy  | ask   | 101 | yes |
-| short | buy  | bid   | 99  | no  |
-| short | buy  | same  | 99  | no  |
-| short | buy  | other | 101 | yes |
-
-#### Exit price with Orderbook enabled
-
-When exiting with the orderbook enabled (`exit_pricing.use_order_book=True`), Freqtrade fetches the `exit_pricing.order_book_top` entries in the orderbook and uses the entry specified as `exit_pricing.order_book_top` from the configured side (`exit_pricing.price_side`) as trade exit price.
-
-1 specifies the topmost entry in the orderbook, while 2 would use the 2nd entry in the orderbook, and so on.
-
-#### Exit price without Orderbook enabled
-
-The following section uses `side` as the configured `exit_pricing.price_side` (defaults to `"ask"`).
-
-When not using orderbook (`exit_pricing.use_order_book=False`), Freqtrade uses the best `side` price from the ticker if it's above the `last` traded price from the ticker. Otherwise (when the `side` price is below the `last` price), it calculates a rate between `side` and `last` price based on `exit_pricing.price_last_balance`.
-
-The `exit_pricing.price_last_balance` configuration parameter controls this. A value of `0.0` will use `side` price, while `1.0` will use the last price and values between those interpolate between `side` and last price.
-
-### Market order pricing
-
-When using market orders, prices should be configured to use the "correct" side of the orderbook to allow realistic pricing detection.
-Assuming both entry and exits are using market orders, a configuration similar to the following must be used
-
-``` jsonc
-  "order_types": {
-    "entry": "market",
-    "exit": "market"
-    // ...
-  },
-  "entry_pricing": {
-    "price_side": "other",
-    // ...
-  },
-  "exit_pricing":{
-    "price_side": "other",
-    // ...
-  },
-```
-
-Obviously, if only one side is using limit orders, different pricing combinations can be used.

docs/includes/protections.md

@@ -1,199 +0,0 @@
-## Protections
-
-!!! Warning "Beta feature"
-    This feature is still in it's testing phase. Should you notice something you think is wrong please let us know via Discord or via Github Issue.
-
-Protections will protect your strategy from unexpected events and market conditions by temporarily stop trading for either one pair, or for all pairs.
-All protection end times are rounded up to the next candle to avoid sudden, unexpected intra-candle buys.
-
-!!! Note
-    Not all Protections will work for all strategies, and parameters will need to be tuned for your strategy to improve performance.  
-
-!!! Tip
-    Each Protection can be configured multiple times with different parameters, to allow different levels of protection (short-term / long-term).
-
-!!! Note "Backtesting"
-    Protections are supported by backtesting and hyperopt, but must be explicitly enabled by using the `--enable-protections` flag.
-
-!!! Warning "Setting protections from the configuration"
-    Setting protections from the configuration via `"protections": [],` key should be considered deprecated and will be removed in a future version.
-    It is also no longer guaranteed that your protections apply to the strategy in cases where the strategy defines [protections as property](hyperopt.md#optimizing-protections).
-
-### Available Protections
-
-* [`StoplossGuard`](#stoploss-guard) Stop trading if a certain amount of stoploss occurred within a certain time window.
-* [`MaxDrawdown`](#maxdrawdown) Stop trading if max-drawdown is reached.
-* [`LowProfitPairs`](#low-profit-pairs) Lock pairs with low profits
-* [`CooldownPeriod`](#cooldown-period) Don't enter a trade right after selling a trade.
-
-### Common settings to all Protections
-
-|  Parameter| Description |
-|------------|-------------|
-| `method` | Protection name to use. <br> **Datatype:** String, selected from [available Protections](#available-protections)
-| `stop_duration_candles` | For how many candles should the lock be set? <br> **Datatype:** Positive integer (in candles)
-| `stop_duration` | how many minutes should protections be locked. <br>Cannot be used together with `stop_duration_candles`. <br> **Datatype:** Float (in minutes)
-| `lookback_period_candles` | Only trades that completed within the last `lookback_period_candles` candles will be considered. This setting may be ignored by some Protections. <br> **Datatype:** Positive integer (in candles).
-| `lookback_period` | Only trades that completed after `current_time - lookback_period` will be considered. <br>Cannot be used together with `lookback_period_candles`. <br>This setting may be ignored by some Protections. <br> **Datatype:**  Float (in minutes)
-| `trade_limit` | Number of trades required at minimum (not used by all Protections). <br> **Datatype:** Positive integer
-| `unlock_at` | Time when trading will be unlocked regularly (not used by all Protections). <br> **Datatype:** string <br>**Input Format:** "HH:MM" (24-hours)
-
-!!! Note "Durations"
-    Durations (`stop_duration*` and `lookback_period*` can be defined in either minutes or candles).
-    For more flexibility when testing different timeframes, all below examples will use the "candle" definition.
-
-#### Stoploss Guard
-
-`StoplossGuard` selects all trades within `lookback_period` in minutes (or in candles when using `lookback_period_candles`).
-If `trade_limit` or more trades resulted in stoploss, trading will stop for `stop_duration` in minutes (or in candles when using `stop_duration_candles`, or until the set time when using `unlock_at`).
-
-This applies across all pairs, unless `only_per_pair` is set to true, which will then only look at one pair at a time.
-
-Similarly, this protection will by default look at all trades (long and short). For futures bots, setting `only_per_side` will make the bot only consider one side, and will then only lock this one side, allowing for example shorts to continue after a series of long stoplosses.
-
-`required_profit` will determine the required relative profit (or loss) for stoplosses to consider. This should normally not be set and defaults to 0.0 - which means all losing stoplosses will be triggering a block.
-
-The below example stops trading for all pairs for 4 candles after the last trade if the bot hit stoploss 4 times within the last 24 candles.
-
-``` python
-@property
-def protections(self):
-    return [
-        {
-            "method": "StoplossGuard",
-            "lookback_period_candles": 24,
-            "trade_limit": 4,
-            "stop_duration_candles": 4,
-            "required_profit": 0.0,
-            "only_per_pair": False,
-            "only_per_side": False
-        }
-    ]
-```
-
-!!! Note
-    `StoplossGuard` considers all trades with the results `"stop_loss"`, `"stoploss_on_exchange"` and `"trailing_stop_loss"` if the resulting profit was negative.
-    `trade_limit` and `lookback_period` will need to be tuned for your strategy.
-
-#### MaxDrawdown
-
-`MaxDrawdown` uses all trades within `lookback_period` in minutes (or in candles when using `lookback_period_candles`) to determine the maximum drawdown. If the drawdown is below `max_allowed_drawdown`, trading will stop for `stop_duration` in minutes (or in candles when using `stop_duration_candles`) after the last trade - assuming that the bot needs some time to let markets recover.
-
-The below sample stops trading for 12 candles if max-drawdown is > 20% considering all pairs - with a minimum of `trade_limit` trades - within the last 48 candles. If desired, `lookback_period` and/or `stop_duration` can be used.
-
-``` python
-@property
-def protections(self):
-    return  [
-        {
-            "method": "MaxDrawdown",
-            "lookback_period_candles": 48,
-            "trade_limit": 20,
-            "stop_duration_candles": 12,
-            "max_allowed_drawdown": 0.2
-        },
-    ]
-```
-
-#### Low Profit Pairs
-
-`LowProfitPairs` uses all trades for a pair within `lookback_period` in minutes (or in candles when using `lookback_period_candles`) to determine the overall profit ratio.
-If that ratio is below `required_profit`, that pair will be locked for `stop_duration` in minutes (or in candles when using `stop_duration_candles`, or until the set time when using `unlock_at`).
-
-For futures bots, setting `only_per_side` will make the bot only consider one side, and will then only lock this one side, allowing for example shorts to continue after a series of long losses.
-
-The below example will stop trading a pair for 60 minutes if the pair does not have a required profit of 2% (and a minimum of 2 trades) within the last 6 candles.
-
-``` python
-@property
-def protections(self):
-    return [
-        {
-            "method": "LowProfitPairs",
-            "lookback_period_candles": 6,
-            "trade_limit": 2,
-            "stop_duration": 60,
-            "required_profit": 0.02,
-            "only_per_pair": False,
-        }
-    ]
-```
-
-#### Cooldown Period
-
-`CooldownPeriod` locks a pair for `stop_duration` in minutes (or in candles when using `stop_duration_candles`, or until the set time when using `unlock_at`) after exiting, avoiding a re-entry for this pair for `stop_duration` minutes.
-
-The below example will stop trading a pair for 2 candles after closing a trade, allowing this pair to "cool down".
-
-``` python
-@property
-def protections(self):
-    return  [
-        {
-            "method": "CooldownPeriod",
-            "stop_duration_candles": 2
-        }
-    ]
-```
-
-!!! Note
-    This Protection applies only at pair-level, and will never lock all pairs globally.
-    This Protection does not consider `lookback_period` as it only looks at the latest trade.
-
-### Full example of Protections
-
-All protections can be combined at will, also with different parameters, creating a increasing wall for under-performing pairs.
-All protections are evaluated in the sequence they are defined.
-
-The below example assumes a timeframe of 1 hour:
-
-* Locks each pair after selling for an additional 5 candles (`CooldownPeriod`), giving other pairs a chance to get filled.
-* Stops trading for 4 hours (`4 * 1h candles`) if the last 2 days (`48 * 1h candles`) had 20 trades, which caused a max-drawdown of more than 20%. (`MaxDrawdown`).
-* Stops trading if more than 4 stoploss occur for all pairs within a 1 day (`24 * 1h candles`) limit (`StoplossGuard`).
-* Locks all pairs that had 2 Trades within the last 6 hours (`6 * 1h candles`) with a combined profit ratio of below 0.02 (<2%) (`LowProfitPairs`).
-* Locks all pairs for 2 candles that had a profit of below 0.01 (<1%) within the last 24h (`24 * 1h candles`), a minimum of 4 trades.
-
-``` python
-from freqtrade.strategy import IStrategy
-
-class AwesomeStrategy(IStrategy)
-    timeframe = '1h'
-    
-    @property
-    def protections(self):
-        return [
-            {
-                "method": "CooldownPeriod",
-                "stop_duration_candles": 5
-            },
-            {
-                "method": "MaxDrawdown",
-                "lookback_period_candles": 48,
-                "trade_limit": 20,
-                "stop_duration_candles": 4,
-                "max_allowed_drawdown": 0.2
-            },
-            {
-                "method": "StoplossGuard",
-                "lookback_period_candles": 24,
-                "trade_limit": 4,
-                "stop_duration_candles": 2,
-                "only_per_pair": False
-            },
-            {
-                "method": "LowProfitPairs",
-                "lookback_period_candles": 6,
-                "trade_limit": 2,
-                "stop_duration_candles": 60,
-                "required_profit": 0.02
-            },
-            {
-                "method": "LowProfitPairs",
-                "lookback_period_candles": 24,
-                "trade_limit": 4,
-                "stop_duration_candles": 2,
-                "required_profit": 0.01
-            }
-        ]
-    # ...
-```

docs/includes/release_template.md

@@ -1,37 +0,0 @@
-## Highlighted changes
-
-- ...
-
-### How to update
-
-As always, you can update your bot using one of the following commands:
-
-#### docker-compose
-
-```bash
-docker-compose pull
-docker-compose up -d
-```
-
-#### Installation via setup script
-
-```
-# Deactivate venv and run 
-./setup.sh --update
-```
-
-#### Plain native installation
-
-```
-git pull
-pip install -U -r requirements.txt
-```
-
-<details>
-<summary>Expand full changelog</summary>
-
-```
-<Paste your changelog here>
-```
-
-</details>

docs/includes/showcase.md

@@ -1,11 +0,0 @@
-This section will highlight a few projects from members of the community.
-!!! Note
-    The projects below are for the most part not maintained by the freqtrade , therefore use your own caution before using them.
-
-- [Example freqtrade strategies](https://github.com/freqtrade/freqtrade-strategies/)
-- [FrequentHippo - Grafana dashboard with dry/live runs and backtests](http://frequenthippo.ddns.net:3000/) (by hippocritical).
-- [Online pairlist generator](https://remotepairlist.com/) (by Blood4rc).
-- [Freqtrade Backtesting Project](https://strat.ninja/) (by Blood4rc).
-- [Freqtrade analysis notebook](https://github.com/froggleston/freqtrade_analysis_notebook) (by Froggleston).
-- [TUI for freqtrade](https://github.com/froggleston/freqtrade-frogtrade9000) (by Froggleston).
-- [Bot Academy](https://botacademy.ddns.net/) (by stash86) - Blog about crypto bot projects.

docs/includes/strategy-imports.md

@@ -1,45 +0,0 @@
-## Imports necessary for a strategy
-
-When creating a strategy, you will need to import the necessary modules and classes. The following imports are required for a strategy:
-
-By default, we recommend the following imports as a base line for your strategy:
-This will cover all imports necessary for freqtrade functions to work.
-Obviously you can add more imports as needed for your strategy.
-
-``` python
-# flake8: noqa: F401
-# isort: skip_file
-# --- Do not remove these imports ---
-import numpy as np
-import pandas as pd
-from datetime import datetime, timedelta, timezone
-from pandas import DataFrame
-from typing import Dict, Optional, Union, Tuple
-
-from freqtrade.strategy import (
-    IStrategy,
-    Trade, 
-    Order,
-    PairLocks,
-    informative,  # @informative decorator
-    # Hyperopt Parameters
-    BooleanParameter,
-    CategoricalParameter,
-    DecimalParameter,
-    IntParameter,
-    RealParameter,
-    # timeframe helpers
-    timeframe_to_minutes,
-    timeframe_to_next_date,
-    timeframe_to_prev_date,
-    # Strategy helper functions
-    merge_informative_pair,
-    stoploss_from_absolute,
-    stoploss_from_open,
-)
-
-# --------------------------------
-# Add your lib to import here
-import talib.abstract as ta
-from technical import qtpylib
-```

docs/index.md

@@ -1,102 +0,0 @@
-![freqtrade](assets/freqtrade_poweredby.svg)
-
-[![Freqtrade CI](https://github.com/freqtrade/freqtrade/workflows/Freqtrade%20CI/badge.svg)](https://github.com/freqtrade/freqtrade/actions/)
-[![DOI](https://joss.theoj.org/papers/10.21105/joss.04864/status.svg)](https://doi.org/10.21105/joss.04864)
-[![Coverage Status](https://coveralls.io/repos/github/freqtrade/freqtrade/badge.svg?branch=develop&service=github)](https://coveralls.io/github/freqtrade/freqtrade?branch=develop)
-[![Maintainability](https://api.codeclimate.com/v1/badges/5737e6d668200b7518ff/maintainability)](https://codeclimate.com/github/freqtrade/freqtrade/maintainability)
-
-<!-- Place this tag where you want the button to render. -->
-<a class="github-button" href="https://github.com/freqtrade/freqtrade" data-icon="octicon-star" data-size="large" aria-label="Star freqtrade/freqtrade on GitHub">Star</a>
-<a class="github-button" href="https://github.com/freqtrade/freqtrade/fork" data-icon="octicon-repo-forked" data-size="large" aria-label="Fork freqtrade/freqtrade on GitHub">Fork</a>
-<a class="github-button" href="https://github.com/freqtrade/freqtrade/archive/stable.zip" data-icon="octicon-cloud-download" data-size="large" aria-label="Download freqtrade/freqtrade on GitHub">Download</a>
-
-## Introduction
-
-Freqtrade is a free and open source crypto trading bot written in Python. It is designed to support all major exchanges and be controlled via Telegram or webUI. It contains backtesting, plotting and money management tools as well as strategy optimization by machine learning.
-
-!!! Danger "DISCLAIMER"
-    This software is for educational purposes only. Do not risk money which you are afraid to lose. USE THE SOFTWARE AT YOUR OWN RISK. THE AUTHORS AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR TRADING RESULTS.
-
-    Always start by running a trading bot in Dry-run and do not engage money before you understand how it works and what profit/loss you should expect.
-
-    We strongly recommend you to have basic coding skills and Python knowledge. Do not hesitate to read the source code and understand the mechanisms of this bot, algorithms and techniques implemented in it.
-
-![freqtrade screenshot](assets/freqtrade-screenshot.png)
-
-## Features
-
-- Develop your Strategy: Write your strategy in python, using [pandas](https://pandas.pydata.org/). Example strategies to inspire you are available in the [strategy repository](https://github.com/freqtrade/freqtrade-strategies).
-- Download market data: Download historical data of the exchange and the markets your may want to trade with.
-- Backtest: Test your strategy on downloaded historical data.
-- Optimize: Find the best parameters for your strategy using hyperoptimization which employs machining learning methods. You can optimize buy, sell, take profit (ROI), stop-loss and trailing stop-loss parameters for your strategy.
-- Select markets: Create your static list or use an automatic one based on top traded volumes and/or prices (not available during backtesting). You can also explicitly blacklist markets you don't want to trade.
-- Run: Test your strategy with simulated money (Dry-Run mode) or deploy it with real money (Live-Trade mode).
-- Run using Edge (optional module): The concept is to find the best historical [trade expectancy](edge.md#expectancy) by markets based on variation of the stop-loss and then allow/reject markets to trade. The sizing of the trade is based on a risk of a percentage of your capital.
-- Control/Monitor: Use Telegram or a WebUI (start/stop the bot, show profit/loss, daily summary, current open trades results, etc.).
-- Analyze: Further analysis can be performed on either Backtesting data or Freqtrade trading history (SQL database), including automated standard plots, and methods to load the data into [interactive environments](data-analysis.md).
-
-## Supported exchange marketplaces
-
-Please read the [exchange specific notes](exchanges.md) to learn about eventual, special configurations needed for each exchange.
-
-- [X] [Binance](https://www.binance.com/)
-- [X] [Bitmart](https://bitmart.com/)
-- [X] [BingX](https://bingx.com/invite/0EM9RX)
-- [X] [Bybit](https://bybit.com/)
-- [X] [Gate.io](https://www.gate.io/ref/6266643)
-- [X] [HTX](https://www.htx.com/) (Former Huobi)
-- [X] [Kraken](https://kraken.com/)
-- [X] [OKX](https://okx.com/) (Former OKEX)
-- [ ] [potentially many others through <img alt="ccxt" width="30px" src="assets/ccxt-logo.svg" />](https://github.com/ccxt/ccxt/). _(We cannot guarantee they will work)_
-
-### Supported Futures Exchanges (experimental)
-
-- [X] [Binance](https://www.binance.com/)
-- [X] [Gate.io](https://www.gate.io/ref/6266643)
-- [X] [OKX](https://okx.com/)
-- [X] [Bybit](https://bybit.com/)
-
-Please make sure to read the [exchange specific notes](exchanges.md), as well as the [trading with leverage](leverage.md) documentation before diving in.
-
-### Community tested
-
-Exchanges confirmed working by the community:
-
-- [X] [Bitvavo](https://bitvavo.com/)
-- [X] [Kucoin](https://www.kucoin.com/)
-
-## Community showcase
-
---8<-- "includes/showcase.md"
-
-## Requirements
-
-### Hardware requirements
-
-To run this bot we recommend you a linux cloud instance with a minimum of:
-
-- 2GB RAM
-- 1GB disk space
-- 2vCPU
-
-### Software requirements
-
-- Docker (Recommended)
-
-Alternatively
-
-- Python 3.9+
-- pip (pip3)
-- git
-- TA-Lib
-- virtualenv (Recommended)
-
-## Support
-
-### Help / Discord
-
-For any questions not covered by the documentation or for further information about the bot, or to simply engage with like-minded individuals, we encourage you to join the Freqtrade [discord server](https://discord.gg/p7nuUNVfP7).
-
-## Ready to try?
-
-Begin by reading the installation guide [for docker](docker_quickstart.md) (recommended), or for [installation without docker](installation.md).

docs/installation.md

@@ -1,429 +0,0 @@
-# Installation
-
-This page explains how to prepare your environment for running the bot.
-
-The freqtrade documentation describes various ways to install freqtrade
-
-* [Docker images](docker_quickstart.md) (separate page)
-* [Script Installation](#script-installation)
-* [Manual Installation](#manual-installation)
-* [Installation with Conda](#installation-with-conda)
-
-Please consider using the prebuilt [docker images](docker_quickstart.md) to get started quickly while evaluating how freqtrade works.
-
-------
-
-## Information
-
-For Windows installation, please use the [windows installation guide](windows_installation.md).
-
-The easiest way to install and run Freqtrade is to clone the bot Github repository and then run the `./setup.sh` script, if it's available for your platform.
-
-!!! Note "Version considerations"
-    When cloning the repository the default working branch has the name `develop`. This branch contains all last features (can be considered as relatively stable, thanks to automated tests).
-    The `stable` branch contains the code of the last release (done usually once per month on an approximately one week old snapshot of the `develop` branch to prevent packaging bugs, so potentially it's more stable).
-
-!!! Note
-    Python3.9 or higher and the corresponding `pip` are assumed to be available. The install-script will warn you and stop if that's not the case. `git` is also needed to clone the Freqtrade repository.  
-    Also, python headers (`python<yourversion>-dev` / `python<yourversion>-devel`) must be available for the installation to complete successfully.
-
-!!! Warning "Up-to-date clock"
-    The clock on the system running the bot must be accurate, synchronized to a NTP server frequently enough to avoid problems with communication to the exchanges.
-
-------
-
-## Requirements
-
-These requirements apply to both [Script Installation](#script-installation) and [Manual Installation](#manual-installation).
-
-!!! Note "ARM64 systems"
-    If you are running an ARM64 system (like a MacOS M1 or an Oracle VM), please use [docker](docker_quickstart.md) to run freqtrade.
-    While native installation is possible with some manual effort, this is not supported at the moment.
-
-### Install guide
-
-* [Python >= 3.9](http://docs.python-guide.org/en/latest/starting/installation/)
-* [pip](https://pip.pypa.io/en/stable/installing/)
-* [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
-* [virtualenv](https://virtualenv.pypa.io/en/stable/installation.html) (Recommended)
-* [TA-Lib](https://ta-lib.github.io/ta-lib-python/) (install instructions [below](#install-ta-lib))
-
-### Install code
-
-We've included/collected install instructions for Ubuntu, MacOS, and Windows. These are guidelines and your success may vary with other distros.
-OS Specific steps are listed first, the common section below is necessary for all systems.
-
-!!! Note
-    Python3.9 or higher and the corresponding pip are assumed to be available.
-
-=== "Debian/Ubuntu"
-    #### Install necessary dependencies
-
-    ```bash
-    # update repository
-    sudo apt-get update
-
-    # install packages
-    sudo apt install -y python3-pip python3-venv python3-dev python3-pandas git curl
-    ```
-
-=== "RaspberryPi/Raspbian"
-    The following assumes the latest [Raspbian Buster lite image](https://www.raspberrypi.org/downloads/raspbian/).
-    This image comes with python3.9 preinstalled, making it easy to get freqtrade up and running.
-
-    Tested using a Raspberry Pi 3 with the Raspbian Buster lite image, all updates applied.
-
-
-    ```bash
-    sudo apt-get install python3-venv libatlas-base-dev cmake curl
-    # Use pywheels.org to speed up installation
-    sudo echo "[global]\nextra-index-url=https://www.piwheels.org/simple" > tee /etc/pip.conf
-
-    git clone https://github.com/freqtrade/freqtrade.git
-    cd freqtrade
-
-    bash setup.sh -i
-    ```
-
-    !!! Note "Installation duration"
-        Depending on your internet speed and the Raspberry Pi version, installation can take multiple hours to complete.
-        Due to this, we recommend to use the pre-build docker-image for Raspberry, by following the [Docker quickstart documentation](docker_quickstart.md)
-
-    !!! Note
-        The above does not install hyperopt dependencies. To install these, please use `python3 -m pip install -e .[hyperopt]`.
-        We do not advise to run hyperopt on a Raspberry Pi, since this is a very resource-heavy operation, which should be done on powerful machine.
-
-------
-
-## Freqtrade repository
-
-Freqtrade is an open source crypto-currency trading bot, whose code is hosted on `github.com`
-
-```bash
-# Download `develop` branch of freqtrade repository
-git clone https://github.com/freqtrade/freqtrade.git
-
-# Enter downloaded directory
-cd freqtrade
-
-# your choice (1): novice user
-git checkout stable
-
-# your choice (2): advanced user
-git checkout develop
-```
-
-(1) This command switches the cloned repository to the use of the `stable` branch. It's not needed, if you wish to stay on the (2) `develop` branch.
-
-You may later switch between branches at any time with the `git checkout stable`/`git checkout develop` commands.
-
-??? Note "Install from pypi"
-    An alternative way to install Freqtrade is from [pypi](https://pypi.org/project/freqtrade/). The downside is that this method requires ta-lib to be correctly installed beforehand, and is therefore currently not the recommended way to install Freqtrade.
-
-    ``` bash
-    pip install freqtrade
-    ```
-
-------
-
-## Script Installation
-
-First of the ways to install Freqtrade, is to use provided the Linux/MacOS `./setup.sh` script, which install all dependencies and help you configure the bot.
-
-Make sure you fulfill the [Requirements](#requirements) and have downloaded the [Freqtrade repository](#freqtrade-repository).
-
-### Use /setup.sh -install (Linux/MacOS)
-
-If you are on Debian, Ubuntu or MacOS, freqtrade provides the script to install freqtrade.
-
-```bash
-# --install, Install freqtrade from scratch
-./setup.sh -i
-```
-
-### Activate your virtual environment
-
-Each time you open a new terminal, you must run `source .venv/bin/activate` to activate your virtual environment.
-
-```bash
-# activate virtual environment
-source ./.venv/bin/activate
-```
-
-### Congratulations
-
-[You are ready](#you-are-ready), and run the bot
-
-### Other options of /setup.sh script
-
-You can as well update, configure and reset the codebase of your bot with `./script.sh`
-
-```bash
-# --update, Command git pull to update.
-./setup.sh -u
-# --reset, Hard reset your develop/stable branch.
-./setup.sh -r
-```
-
-```
-** --install **
-
-With this option, the script will install the bot and most dependencies:
-You will need to have git and python3.9+ installed beforehand for this to work.
-
-* Mandatory software as: `ta-lib`
-* Setup your virtualenv under `.venv/`
-
-This option is a combination of installation tasks and `--reset`
-
-** --update **
-
-This option will pull the last version of your current branch and update your virtualenv. Run the script with this option periodically to update your bot.
-
-** --reset **
-
-This option will hard reset your branch (only if you are on either `stable` or `develop`) and recreate your virtualenv.
-```
-
------
-
-## Manual Installation
-
-Make sure you fulfill the [Requirements](#requirements) and have downloaded the [Freqtrade repository](#freqtrade-repository).
-
-### Install TA-Lib
-
-#### TA-Lib script installation
-
-```bash
-sudo ./build_helpers/install_ta-lib.sh
-```
-
-!!! Note
-    This will use the ta-lib tar.gz included in this repository.
-
-##### TA-Lib manual installation
-
-[Official installation guide](https://ta-lib.github.io/ta-lib-python/install.html)
-
-```bash
-wget http://prdownloads.sourceforge.net/ta-lib/ta-lib-0.4.0-src.tar.gz
-tar xvzf ta-lib-0.4.0-src.tar.gz
-cd ta-lib
-sed -i.bak "s|0.00000001|0.000000000000000001 |g" src/ta_func/ta_utility.h
-./configure --prefix=/usr/local
-make
-sudo make install
-# On debian based systems (debian, ubuntu, ...) - updating ldconfig might be necessary.
-sudo ldconfig  
-cd ..
-rm -rf ./ta-lib*
-```
-
-#### Setup Python virtual environment (virtualenv)
-
-You will run freqtrade in separated `virtual environment`
-
-```bash
-# create virtualenv in directory /freqtrade/.venv
-python3 -m venv .venv
-
-# run virtualenv
-source .venv/bin/activate
-```
-
-#### Install python dependencies
-
-```bash
-python3 -m pip install --upgrade pip
-python3 -m pip install -r requirements.txt
-python3 -m pip install -e .
-```
-
-### Congratulations
-
-[You are ready](#you-are-ready), and run the bot
-
-#### (Optional) Post-installation Tasks
-
-!!! Note 
-    If you run the bot on a server, you should consider using [Docker](docker_quickstart.md) or a terminal multiplexer like `screen` or [`tmux`](https://en.wikipedia.org/wiki/Tmux) to avoid that the bot is stopped on logout.
-
-On Linux with software suite `systemd`, as an optional post-installation task, you may wish to setup the bot to run as a `systemd service` or configure it to send the log messages to the `syslog`/`rsyslog` or `journald` daemons. See [Advanced Logging](advanced-setup.md#advanced-logging) for details.
-
-------
-
-## Installation with Conda
-
-Freqtrade can also be installed with Miniconda or Anaconda. We recommend using Miniconda as it's installation footprint is smaller. Conda will automatically prepare and manage the extensive library-dependencies of the Freqtrade program.
-
-### What is Conda?
-
-Conda is a package, dependency and environment manager for multiple programming languages: [conda docs](https://docs.conda.io/projects/conda/en/latest/index.html)
-
-### Installation with conda
-
-#### Install Conda
-
-[Installing on linux](https://conda.io/projects/conda/en/latest/user-guide/install/linux.html#install-linux-silent)
-
-[Installing on windows](https://conda.io/projects/conda/en/latest/user-guide/install/windows.html)
-
-Answer all questions. After installation, it is mandatory to turn your terminal OFF and ON again.
-
-#### Freqtrade download
-
-Download and install freqtrade.
-
-```bash
-# download freqtrade
-git clone https://github.com/freqtrade/freqtrade.git
-
-# enter downloaded directory 'freqtrade'
-cd freqtrade      
-```
-
-#### Freqtrade install: Conda Environment
-
-```bash
-conda create --name freqtrade python=3.12
-```
-
-!!! Note "Creating Conda Environment"
-    The conda command `create -n` automatically installs all nested dependencies for the selected libraries, general structure of installation command is:
-
-    ```bash
-    # choose your own packages
-    conda env create -n [name of the environment] [python version] [packages]
-    ```
-
-#### Enter/exit freqtrade environment
-
-To check available environments, type
-
-```bash
-conda env list
-```
-
-Enter installed environment
-
-```bash
-# enter conda environment
-conda activate freqtrade
-
-# exit conda environment - don't do it now
-conda deactivate
-```
-
-Install last python dependencies with pip
-
-```bash
-python3 -m pip install --upgrade pip
-python3 -m pip install -r requirements.txt
-python3 -m pip install -e .
-```
-
-Patch conda libta-lib (Linux only)
-
-```bash
-# Ensure that the environment is active!
-conda activate freqtrade
-
-cd build_helpers
-bash install_ta-lib.sh ${CONDA_PREFIX} nosudo
-```
-
-### Congratulations
-
-[You are ready](#you-are-ready), and run the bot
-
-### Important shortcuts
-
-```bash
-# list installed conda environments
-conda env list
-
-# activate base environment
-conda activate
-
-# activate freqtrade environment
-conda activate freqtrade
-
-#deactivate any conda environments
-conda deactivate                              
-```
-
-### Further info on anaconda
-
-!!! Info "New heavy packages"
-    It may happen that creating a new Conda environment, populated with selected packages at the moment of creation takes less time than installing a large, heavy library or application, into previously set environment.
-
-!!! Warning "pip install within conda"
-    The documentation of conda says that pip should NOT be used within conda, because internal problems can occur.
-    However, they are rare. [Anaconda Blogpost](https://www.anaconda.com/blog/using-pip-in-a-conda-environment)
-
-    Nevertheless, that is why, the `conda-forge` channel is preferred:
-
-    * more libraries are available (less need for `pip`)
-    * `conda-forge` works better with `pip`
-    * the libraries are newer
-
-Happy trading!
-
------
-
-## You are ready
-
-You've made it this far, so you have successfully installed freqtrade.
-
-### Initialize the configuration
-
-```bash
-# Step 1 - Initialize user folder
-freqtrade create-userdir --userdir user_data
-
-# Step 2 - Create a new configuration file
-freqtrade new-config --config user_data/config.json
-```
-
-You are ready to run, read [Bot Configuration](configuration.md), remember to start with `dry_run: True` and verify that everything is working.
-
-To learn how to setup your configuration, please refer to the [Bot Configuration](configuration.md) documentation page.
-
-### Start the Bot
-
-```bash
-freqtrade trade --config user_data/config.json --strategy SampleStrategy
-```
-
-!!! Warning
-    You should read through the rest of the documentation, backtest the strategy you're going to use, and use dry-run before enabling trading with real money.
-
------
-
-## Troubleshooting
-
-### Common problem: "command not found"
-
-If you used (1)`Script` or (2)`Manual` installation, you need to run the bot in virtual environment. If you get error as below, make sure venv is active.
-
-```bash
-# if:
-bash: freqtrade: command not found
-
-# then activate your virtual environment
-source ./.venv/bin/activate
-```
-
-### MacOS installation error
-
-Newer versions of MacOS may have installation failed with errors like `error: command 'g++' failed with exit status 1`.
-
-This error will require explicit installation of the SDK Headers, which are not installed by default in this version of MacOS.
-For MacOS 10.14, this can be accomplished with the below command.
-
-```bash
-open /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg
-```
-
-If this file is inexistent, then you're probably on a different version of MacOS, so you may need to consult the internet for specific resolution details.

docs/leverage.md

@@ -1,143 +0,0 @@
-# Trading with Leverage
-
-!!! Warning "Beta feature"
-    This feature is still in it's testing phase. Should you notice something you think is wrong please let us know via Discord or via Github Issue.
-
-!!! Note "Multiple bots on one account"
-    You can't run 2 bots on the same account with leverage. For leveraged / margin trading, freqtrade assumes it's the only user of the account, and all liquidation levels are calculated based on this assumption.
-
-!!! Danger "Trading with leverage is very risky"
-    Do not trade with a leverage > 1 using a strategy that hasn't shown positive results in a live run using the spot market. Check the stoploss of your strategy. With a leverage of 2, a stoploss of 0.5 (50%) would be too low, and these trades would be liquidated before reaching that stoploss.
-    We do not assume any responsibility for eventual losses that occur from using this software or this mode.
-
-    Please only use advanced trading modes when you know how freqtrade (and your strategy) works.
-    Also, never risk more than what you can afford to lose.
-
-If you already have an existing strategy, please read the [strategy migration guide](strategy_migration.md#strategy-migration-between-v2-and-v3) to migrate your strategy from a freqtrade v2 strategy, to strategy of version 3 which can short and trade futures.
-
-## Shorting
-
-Shorting is not possible when trading with [`trading_mode`](#leverage-trading-modes) set to `spot`. To short trade, `trading_mode` must be set to `margin`(currently unavailable) or [`futures`](#futures), with [`margin_mode`](#margin-mode) set to `cross`(currently unavailable) or [`isolated`](#isolated-margin-mode)
-
-For a strategy to short, the strategy class must set the class variable `can_short = True`
-
-Please read [strategy customization](strategy-customization.md#entry-signal-rules) for instructions on how to set signals to enter and exit short trades.
-
-## Understand `trading_mode`
-
-The possible values are: `spot` (default), `margin`(*Currently unavailable*) or `futures`.
-
-### Spot
-
-Regular trading mode (low risk)
-
-- Long trades only (No short trades).
-- No leverage.
-- No Liquidation.
-- Profits gained/lost are equal to the change in value of the assets (minus trading fees).
-
-### Leverage trading modes
-
-With leverage, a trader borrows capital from the exchange. The capital must be re-payed fully to the exchange (potentially with interest), and the trader keeps any profits, or pays any losses, from any trades made using the borrowed capital.
-
-Because the capital must always be re-payed, exchanges will **liquidate** (forcefully sell the traders assets) a trade made using borrowed capital when the total value of assets in the leverage account drops to a certain point (a point where the total value of losses is less than the value of the collateral that the trader actually owns in the leverage account), in order to ensure that the trader has enough capital to pay the borrowed assets back to the exchange. The exchange will also charge a **liquidation fee**, adding to the traders losses.
-
-For this reason, **DO NOT TRADE WITH LEVERAGE IF YOU DON'T KNOW EXACTLY WHAT YOUR DOING. LEVERAGE TRADING IS HIGH RISK, AND CAN RESULT IN THE VALUE OF YOUR ASSETS DROPPING TO 0 VERY QUICKLY, WITH NO CHANCE OF INCREASING IN VALUE AGAIN.**
-
-#### Margin (currently unavailable)
-
-Trading occurs on the spot market, but the exchange lends currency to you in an amount equal to the chosen leverage. You pay the amount lent to you back to the exchange with interest, and your profits/losses are multiplied by the leverage specified.
-
-#### Futures
-
-Perpetual swaps (also known as Perpetual Futures) are contracts traded at a price that is closely tied to the underlying asset they are based off of (ex.). You are not trading the actual asset but instead are trading a derivative contract. Perpetual swap contracts can last indefinitely, in contrast to futures or option contracts.
-
-In addition to the gains/losses from the change in price of the futures contract, traders also exchange _funding fees_, which are gains/losses worth an amount that is derived from the difference in price between the futures contract and the underlying asset. The difference in price between a futures contract and the underlying asset varies between exchanges.
-
-To trade in futures markets, you'll have to set `trading_mode` to "futures".
-You will also have to pick a "margin mode" (explanation below) - with freqtrade currently only supporting isolated margin.
-
-``` json
-"trading_mode": "futures",
-"margin_mode": "isolated"
-```
-
-##### Pair namings
-
-Freqtrade follows the [ccxt naming conventions for futures](https://docs.ccxt.com/#/README?id=perpetual-swap-perpetual-future).
-A futures pair will therefore have the naming of `base/quote:settle` (e.g. `ETH/USDT:USDT`).
-
-### Margin mode
-
-On top of `trading_mode` - you will also have to configure your `margin_mode`.
-While freqtrade currently only supports one margin mode, this will change, and by configuring it now you're all set for future updates.
-
-The possible values are: `isolated`, or `cross`(*currently unavailable*).
-
-#### Isolated margin mode
-
-Each market(trading pair), keeps collateral in a separate account
-
-``` json
-"margin_mode": "isolated"
-```
-
-#### Cross margin mode (currently unavailable)
-
-One account is used to share collateral between markets (trading pairs). Margin is taken from total account balance to avoid liquidation when needed.
-
-``` json
-"margin_mode": "cross"
-```
-
-Please read the [exchange specific notes](exchanges.md) for exchanges that support this mode and how they differ.
-
-## Set leverage to use
-
-Different strategies and risk profiles will require different levels of leverage.
-While you could configure one static leverage value - freqtrade offers you the flexibility to adjust this via [strategy leverage callback](strategy-callbacks.md#leverage-callback) - which allows you to use different leverages by pair, or based on some other factor benefitting your strategy result.
-
-If not implemented, leverage defaults to 1x (no leverage).
-
-!!! Warning
-    Higher leverage also equals higher risk - be sure you fully understand the implications of using leverage!
-
-## Understand `liquidation_buffer`
-
-*Defaults to `0.05`*
-
-A ratio specifying how large of a safety net to place between the liquidation price and the stoploss to prevent a position from reaching the liquidation price.
-This artificial liquidation price is calculated as:
-
-`freqtrade_liquidation_price = liquidation_price ± (abs(open_rate - liquidation_price) * liquidation_buffer)`
-
-- `±` = `+` for long trades
-- `±` = `-` for short trades
-
-Possible values are any floats between 0.0 and 0.99
-
-**ex:** If a trade is entered at a price of 10 coin/USDT, and the liquidation price of this trade is 8 coin/USDT, then with `liquidation_buffer` set to `0.05` the minimum stoploss for this trade would be $8 + ((10 - 8) * 0.05) = 8 + 0.1 = 8.1$
-
-!!! Danger "A `liquidation_buffer` of 0.0, or a low `liquidation_buffer` is likely to result in liquidations, and liquidation fees"
-    Currently Freqtrade is able to calculate liquidation prices, but does not calculate liquidation fees. Setting your `liquidation_buffer` to 0.0, or using a low `liquidation_buffer` could result in your positions being liquidated. Freqtrade does not track liquidation fees, so liquidations will result in inaccurate profit/loss results for your bot. If you use a low `liquidation_buffer`, it is recommended to use `stoploss_on_exchange` if your exchange supports this.
-
-## Unavailable funding rates
-
-For futures data, exchanges commonly provide the futures candles, the marks, and the funding rates. However, it is common that whilst candles and marks might be available, the funding rates are not. This can affect backtesting timeranges, i.e. you may only be able to test recent timeranges and not earlier, experiencing the `No data found. Terminating.` error. To get around this, add the `futures_funding_rate` config option as listed in [configuration.md](configuration.md), and it is recommended that you set this to `0`, unless you know a given specific funding rate for your pair, exchange and timerange. Setting this to anything other than `0` can have drastic effects on your profit calculations within strategy, e.g. within the `custom_exit`, `custom_stoploss`, etc functions.
-
-!!! Warning "This will mean your backtests are inaccurate."
-    This will not overwrite funding rates that are available from the exchange, but bear in mind that setting a false funding rate will mean backtesting results will be inaccurate for historical timeranges where funding rates are not available.
-
-### Developer
-
-#### Margin mode
-
-For shorts, the currency which pays the interest fee for the `borrowed` currency is purchased at the same time of the closing trade (This means that the amount purchased in short closing trades is greater than the amount sold in short opening trades).
-
-For longs, the currency which pays the interest fee for the `borrowed` will already be owned by the user and does not need to be purchased. The interest is subtracted from the `close_value` of the trade.
-
-All Fees are included in `current_profit` calculations during the trade.
-
-#### Futures mode
-
-Funding fees are either added or subtracted from the total amount of a trade

docs/lookahead-analysis.md

@@ -1,104 +0,0 @@
-# Lookahead analysis
-
-This page explains how to validate your strategy in terms of look ahead bias.
-
-Checking look ahead bias is the bane of any strategy since it is sometimes very easy to introduce backtest bias -
-but very hard to detect.
-
-Backtesting initializes all timestamps at once and calculates all indicators in the beginning.
-This means that if your indicators or entry/exit signals could look into future candles and falsify your backtest.
-
-Lookahead-analysis requires historic data to be available.
-To learn how to get data for the pairs and exchange you're interested in,
-head over to the [Data Downloading](data-download.md) section of the documentation.
-
-This command is built upon backtesting since it internally chains backtests and pokes at the strategy to provoke it to show look ahead bias.
-This is done by not looking at the strategy itself - but at the results it returned.
-The results are things like changed indicator-values and moved entries/exits compared to the full backtest.
-
-You can use commands of [Backtesting](backtesting.md).
-It also supports the lookahead-analysis of freqai strategies.
-
-- `--cache` is forced to "none".
-- `--max-open-trades` is forced to be at least equal to the number of pairs.
-- `--dry-run-wallet` is forced to be basically infinite (1 billion).
-- `--stake-amount` is forced to be a static 10000 (10k).
-- `--enable-protections` is forced to be off.
-
-Those are set to avoid users accidentally generating false positives.
-
-## Lookahead-analysis command reference
-
-```
-usage: freqtrade lookahead-analysis [-h] [-v] [--logfile FILE] [-V] [-c PATH]
-                                    [-d PATH] [--userdir PATH] [-s NAME]
-                                    [--strategy-path PATH]
-                                    [--recursive-strategy-search]
-                                    [--freqaimodel NAME]
-                                    [--freqaimodel-path PATH] [-i TIMEFRAME]
-                                    [--timerange TIMERANGE]
-                                    [--data-format-ohlcv {json,jsongz,hdf5,feather,parquet}]
-                                    [--max-open-trades INT]
-                                    [--stake-amount STAKE_AMOUNT]
-                                    [--fee FLOAT] [-p PAIRS [PAIRS ...]]
-                                    [--dry-run-wallet DRY_RUN_WALLET]
-                                    [--timeframe-detail TIMEFRAME_DETAIL]
-                                    [--strategy-list STRATEGY_LIST [STRATEGY_LIST ...]]
-                                    [--export {none,trades,signals}]
-                                    [--export-filename PATH]
-                                    [--breakdown {day,week,month} [{day,week,month} ...]]
-                                    [--cache {none,day,week,month}]
-                                    [--freqai-backtest-live-models]
-                                    [--minimum-trade-amount INT]
-                                    [--targeted-trade-amount INT]
-                                    [--lookahead-analysis-exportfilename LOOKAHEAD_ANALYSIS_EXPORTFILENAME]
-
-options:
-  --minimum-trade-amount INT
-                        Minimum trade amount for lookahead-analysis
-  --targeted-trade-amount INT
-                        Targeted trade amount for lookahead analysis
-  --lookahead-analysis-exportfilename LOOKAHEAD_ANALYSIS_EXPORTFILENAME
-                        Use this csv-filename to store lookahead-analysis-
-                        results
-```
-
-!!! Note ""
-    The above Output was reduced to options `lookahead-analysis` adds on top of regular backtesting commands.
-
-### Summary
-
-Checks a given strategy for look ahead bias via lookahead-analysis
-Look ahead bias means that the backtest uses data from future candles thereby not making it viable beyond backtesting
-and producing false hopes for the one backtesting.
-
-### Introduction
-
-Many strategies - without the programmer knowing - have fallen prey to look ahead bias.
-
-Any backtest will populate the full dataframe including all time stamps at the beginning.
-If the programmer is not careful or oblivious how things work internally
-(which sometimes can be really hard to find out) then it will just look into the future making the strategy amazing
-but not realistic.
-
-This command is made to try to verify the validity in the form of the aforementioned look ahead bias.
-
-### How does the command work?
-
-It will start with a backtest of all pairs to generate a baseline for indicators and entries/exits.
-After the backtest ran, it will look if the `minimum-trade-amount` is met
-and if not cancel the lookahead-analysis for this strategy.
-
-After setting the baseline it will then do additional runs for every entry and exit separately.
-When a verification-backtest is done, it will compare the indicators as the signal (either entry or exit) and report the bias.
-After all signals have been verified or falsified a result-table will be generated for the user to see.
-
-### Caveats
-
-- `lookahead-analysis` can only verify / falsify the trades it calculated and verified.
-If the strategy has many different signals / signal types, it's up to you to select appropriate parameters to ensure that all signals have triggered at least once. Not triggered signals will not have been verified.
-This could lead to a false-negative (the strategy will then be reported as non-biased).
-- `lookahead-analysis` has access to everything that backtesting has too.
-Please don't provoke any configs like enabling position stacking.
-If you decide to do so, then make doubly sure that you won't ever run out of `max_open_trades` amount and neither leftover money in your wallet.
-- In the results table, the `biased_indicators` column will falsely flag FreqAI target indicators defined in `set_freqai_targets()` as biased. These are not biased and can safely be ignored.

docs/plotting.md

@@ -1,384 +0,0 @@
-# Plotting
-
-This page explains how to plot prices, indicators and profits.
-
-!!! Warning "Deprecated"
-    The commands described in this page (`plot-dataframe`, `plot-profit`) should be considered deprecated and are in maintenance mode.
-    This is mostly for the performance problems even medium sized plots can cause, but also because "store a file and open it in a browser" isn't very intuitive from a UI perspective.
-
-    While there are no immediate plans to remove them, they are not actively maintained - and may be removed short-term should major changes be required to keep them working.
-    
-    Please use [FreqUI](freq-ui.md) for plotting needs, which doesn't struggle with the same performance problems.
-
-## Installation / Setup
-
-Plotting modules use the Plotly library. You can install / upgrade this by running the following command:
-
-``` bash
-pip install -U -r requirements-plot.txt
-```
-
-## Plot price and indicators
-
-The `freqtrade plot-dataframe` subcommand shows an interactive graph with three subplots:
-
-* Main plot with candlesticks and indicators following price (sma/ema)
-* Volume bars
-* Additional indicators as specified by `--indicators2`
-
-![plot-dataframe](assets/plot-dataframe.png)
-
-Possible arguments:
-
-```
-usage: freqtrade plot-dataframe [-h] [-v] [--logfile FILE] [-V] [-c PATH]
-                                [-d PATH] [--userdir PATH] [-s NAME]
-                                [--strategy-path PATH] [-p PAIRS [PAIRS ...]]
-                                [--indicators1 INDICATORS1 [INDICATORS1 ...]]
-                                [--indicators2 INDICATORS2 [INDICATORS2 ...]]
-                                [--plot-limit INT] [--db-url PATH]
-                                [--trade-source {DB,file}] [--export EXPORT]
-                                [--export-filename PATH]
-                                [--timerange TIMERANGE] [-i TIMEFRAME]
-                                [--no-trades]
-
-optional arguments:
-  -h, --help            show this help message and exit
-  -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
-                        Limit command to these pairs. Pairs are space-
-                        separated.
-  --indicators1 INDICATORS1 [INDICATORS1 ...]
-                        Set indicators from your strategy you want in the
-                        first row of the graph. Space-separated list. Example:
-                        `ema3 ema5`. Default: `['sma', 'ema3', 'ema5']`.
-  --indicators2 INDICATORS2 [INDICATORS2 ...]
-                        Set indicators from your strategy you want in the
-                        third row of the graph. Space-separated list. Example:
-                        `fastd fastk`. Default: `['macd', 'macdsignal']`.
-  --plot-limit INT      Specify tick limit for plotting. Notice: too high
-                        values cause huge files. Default: 750.
-  --db-url PATH         Override trades database URL, this is useful in custom
-                        deployments (default: `sqlite:///tradesv3.sqlite` for
-                        Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for
-                        Dry Run).
-  --trade-source {DB,file}
-                        Specify the source for trades (Can be DB or file
-                        (backtest file)) Default: file
-  --export EXPORT       Export backtest results, argument are: trades.
-                        Example: `--export=trades`
-  --export-filename PATH
-                        Save backtest results to the file with this filename.
-                        Requires `--export` to be set as well. Example:
-                        `--export-filename=user_data/backtest_results/backtest
-                        _today.json`
-  --timerange TIMERANGE
-                        Specify what timerange of data to use.
-  -i TIMEFRAME, --timeframe TIMEFRAME
-                        Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
-  --no-trades           Skip using trades from backtesting file and DB.
-
-Common arguments:
-  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
-  --logfile FILE        Log to the file specified. Special values are:
-                        'syslog', 'journald'. See the documentation for more
-                        details.
-  -V, --version         show program's version number and exit
-  -c PATH, --config PATH
-                        Specify configuration file (default:
-                        `userdir/config.json` or `config.json` whichever
-                        exists). Multiple --config options may be used. Can be
-                        set to `-` to read config from stdin.
-  -d PATH, --datadir PATH
-                        Path to directory with historical backtesting data.
-  --userdir PATH, --user-data-dir PATH
-                        Path to userdata directory.
-
-Strategy arguments:
-  -s NAME, --strategy NAME
-                        Specify strategy class name which will be used by the
-                        bot.
-  --strategy-path PATH  Specify additional strategy lookup path.
-
-```
-
-Example:
-
-``` bash
-freqtrade plot-dataframe -p BTC/ETH --strategy AwesomeStrategy
-```
-
-The `-p/--pairs` argument can be used to specify pairs you would like to plot.
-
-!!! Note
-    The `freqtrade plot-dataframe` subcommand generates one plot-file per pair.
-
-Specify custom indicators.
-Use `--indicators1` for the main plot and `--indicators2` for the subplot below (if values are in a different range than prices).
-
-``` bash
-freqtrade plot-dataframe --strategy AwesomeStrategy -p BTC/ETH --indicators1 sma ema --indicators2 macd
-```
-
-### Further usage examples
-
-To plot multiple pairs, separate them with a space:
-
-``` bash
-freqtrade plot-dataframe --strategy AwesomeStrategy -p BTC/ETH XRP/ETH
-```
-
-To plot a timerange (to zoom in)
-
-``` bash
-freqtrade plot-dataframe --strategy AwesomeStrategy -p BTC/ETH --timerange=20180801-20180805
-```
-
-To plot trades stored in a database use `--db-url` in combination with `--trade-source DB`:
-
-``` bash
-freqtrade plot-dataframe --strategy AwesomeStrategy --db-url sqlite:///tradesv3.dry_run.sqlite -p BTC/ETH --trade-source DB
-```
-
-To plot trades from a backtesting result, use `--export-filename <filename>`
-
-``` bash
-freqtrade plot-dataframe --strategy AwesomeStrategy --export-filename user_data/backtest_results/backtest-result.json -p BTC/ETH
-```
-
-### Plot dataframe basics
-
-![plot-dataframe2](assets/plot-dataframe2.png)
-
-The `plot-dataframe` subcommand requires backtesting data, a strategy and either a backtesting-results file or a database, containing trades corresponding to the strategy.
-
-The resulting plot will have the following elements:
-
-* Green triangles: Buy signals from the strategy. (Note: not every buy signal generates a trade, compare to cyan circles.)
-* Red triangles: Sell signals from the strategy. (Also, not every sell signal terminates a trade, compare to red and green squares.)
-* Cyan circles: Trade entry points.
-* Red squares: Trade exit points for trades with loss or 0% profit.
-* Green squares: Trade exit points for profitable trades.
-* Indicators with values corresponding to the candle scale (e.g. SMA/EMA), as specified with `--indicators1`.
-* Volume (bar chart at the bottom of the main chart).
-* Indicators with values in different scales (e.g. MACD, RSI) below the volume bars, as specified with `--indicators2`.
-
-!!! Note "Bollinger Bands"
-    Bollinger bands are automatically added to the plot if the columns `bb_lowerband` and `bb_upperband` exist, and are painted as a light blue area spanning from the lower band to the upper band.
-
-#### Advanced plot configuration
-
-An advanced plot configuration can be specified in the strategy in the `plot_config` parameter.
-
-Additional features when using `plot_config` include:
-
-* Specify colors per indicator
-* Specify additional subplots
-* Specify indicator pairs to fill area in between
-
-The sample plot configuration below specifies fixed colors for the indicators. Otherwise, consecutive plots may produce different color schemes each time, making comparisons difficult.
-It also allows multiple subplots to display both MACD and RSI at the same time.
-
-Plot type can be configured using `type` key. Possible types are:
-
-* `scatter` corresponding to `plotly.graph_objects.Scatter` class (default).
-* `bar` corresponding to `plotly.graph_objects.Bar` class.
-
-Extra parameters to `plotly.graph_objects.*` constructor can be specified in `plotly` dict.
-
-Sample configuration with inline comments explaining the process:
-
-``` python
-@property
-def plot_config(self):
-    """
-        There are a lot of solutions how to build the return dictionary.
-        The only important point is the return value.
-        Example:
-            plot_config = {'main_plot': {}, 'subplots': {}}
-
-    """
-    plot_config = {}
-    plot_config['main_plot'] = {
-        # Configuration for main plot indicators.
-        # Assumes 2 parameters, emashort and emalong to be specified.
-        f'ema_{self.emashort.value}': {'color': 'red'},
-        f'ema_{self.emalong.value}': {'color': '#CCCCCC'},
-        # By omitting color, a random color is selected.
-        'sar': {},
-        # fill area between senkou_a and senkou_b
-        'senkou_a': {
-            'color': 'green', #optional
-            'fill_to': 'senkou_b',
-            'fill_label': 'Ichimoku Cloud', #optional
-            'fill_color': 'rgba(255,76,46,0.2)', #optional
-        },
-        # plot senkou_b, too. Not only the area to it.
-        'senkou_b': {}
-    }
-    plot_config['subplots'] = {
-         # Create subplot MACD
-        "MACD": {
-            'macd': {'color': 'blue', 'fill_to': 'macdhist'},
-            'macdsignal': {'color': 'orange'},
-            'macdhist': {'type': 'bar', 'plotly': {'opacity': 0.9}}
-        },
-        # Additional subplot RSI
-        "RSI": {
-            'rsi': {'color': 'red'}
-        }
-    }
-
-    return plot_config
-```
-
-??? Note "As attribute (former method)"
-    Assigning plot_config is also possible as Attribute (this used to be the default way).
-    This has the disadvantage that strategy parameters are not available, preventing certain configurations from working.
-
-    ``` python
-        plot_config = {
-            'main_plot': {
-                # Configuration for main plot indicators.
-                # Specifies `ema10` to be red, and `ema50` to be a shade of gray
-                'ema10': {'color': 'red'},
-                'ema50': {'color': '#CCCCCC'},
-                # By omitting color, a random color is selected.
-                'sar': {},
-            # fill area between senkou_a and senkou_b
-            'senkou_a': {
-                'color': 'green', #optional
-                'fill_to': 'senkou_b',
-                'fill_label': 'Ichimoku Cloud', #optional
-                'fill_color': 'rgba(255,76,46,0.2)', #optional
-            },
-            # plot senkou_b, too. Not only the area to it.
-            'senkou_b': {}
-            },
-            'subplots': {
-                # Create subplot MACD
-                "MACD": {
-                    'macd': {'color': 'blue', 'fill_to': 'macdhist'},
-                    'macdsignal': {'color': 'orange'},
-                    'macdhist': {'type': 'bar', 'plotly': {'opacity': 0.9}}
-                },
-                # Additional subplot RSI
-                "RSI": {
-                    'rsi': {'color': 'red'}
-                }
-            }
-        }
-
-    ```
-
-
-!!! Note
-    The above configuration assumes that `ema10`, `ema50`, `senkou_a`, `senkou_b`,
-    `macd`, `macdsignal`, `macdhist` and `rsi` are columns in the DataFrame created by the strategy.
-
-!!! Warning
-    `plotly` arguments are only supported with plotly library and will not work with freq-ui.
-
-!!! Note "Trade position adjustments"
-    If `position_adjustment_enable` / `adjust_trade_position()` is used, the trade initial buy price is averaged over multiple orders and the trade start price will most likely appear outside the candle range.
-
-## Plot profit
-
-![plot-profit](assets/plot-profit.png)
-
-The `plot-profit` subcommand shows an interactive graph with three plots:
-
-* Average closing price for all pairs.
-* The summarized profit made by backtesting.
-Note that this is not the real-world profit, but more of an estimate.
-* Profit for each individual pair.
-* Parallelism of trades.
-* Underwater (Periods of drawdown).
-
-The first graph is good to get a grip of how the overall market progresses.
-
-The second graph will show if your algorithm works or doesn't.
-Perhaps you want an algorithm that steadily makes small profits, or one that acts less often, but makes big swings.
-This graph will also highlight the start (and end) of the Max drawdown period.
-
-The third graph can be useful to spot outliers, events in pairs that cause profit spikes.
-
-The forth graph can help you analyze trade parallelism, showing how often max_open_trades have been maxed out.
-
-Possible options for the `freqtrade plot-profit` subcommand:
-
-```
-usage: freqtrade plot-profit [-h] [-v] [--logfile FILE] [-V] [-c PATH]
-                             [-d PATH] [--userdir PATH] [-s NAME]
-                             [--strategy-path PATH] [-p PAIRS [PAIRS ...]]
-                             [--timerange TIMERANGE] [--export EXPORT]
-                             [--export-filename PATH] [--db-url PATH]
-                             [--trade-source {DB,file}] [-i TIMEFRAME]
-
-optional arguments:
-  -h, --help            show this help message and exit
-  -p PAIRS [PAIRS ...], --pairs PAIRS [PAIRS ...]
-                        Limit command to these pairs. Pairs are space-
-                        separated.
-  --timerange TIMERANGE
-                        Specify what timerange of data to use.
-  --export EXPORT       Export backtest results, argument are: trades.
-                        Example: `--export=trades`
-  --export-filename PATH, --backtest-filename PATH
-                        Use backtest results from this filename.
-                        Requires `--export` to be set as well. Example:
-                        `--export-filename=user_data/backtest_results/backtest
-                        _today.json`
-  --db-url PATH         Override trades database URL, this is useful in custom
-                        deployments (default: `sqlite:///tradesv3.sqlite` for
-                        Live Run mode, `sqlite:///tradesv3.dryrun.sqlite` for
-                        Dry Run).
-  --trade-source {DB,file}
-                        Specify the source for trades (Can be DB or file
-                        (backtest file)) Default: file
-  -i TIMEFRAME, --timeframe TIMEFRAME
-                        Specify timeframe (`1m`, `5m`, `30m`, `1h`, `1d`).
-  --auto-open           Automatically open generated plot.
-
-Common arguments:
-  -v, --verbose         Verbose mode (-vv for more, -vvv to get all messages).
-  --logfile FILE        Log to the file specified. Special values are:
-                        'syslog', 'journald'. See the documentation for more
-                        details.
-  -V, --version         show program's version number and exit
-  -c PATH, --config PATH
-                        Specify configuration file (default:
-                        `userdir/config.json` or `config.json` whichever
-                        exists). Multiple --config options may be used. Can be
-                        set to `-` to read config from stdin.
-  -d PATH, --datadir PATH
-                        Path to directory with historical backtesting data.
-  --userdir PATH, --user-data-dir PATH
-                        Path to userdata directory.
-
-Strategy arguments:
-  -s NAME, --strategy NAME
-                        Specify strategy class name which will be used by the
-                        bot.
-  --strategy-path PATH  Specify additional strategy lookup path.
-
-```
-
-The `-p/--pairs`  argument, can be used to limit the pairs that are considered for this calculation.
-
-Examples:
-
-Use custom backtest-export file
-
-``` bash
-freqtrade plot-profit  -p LTC/BTC --export-filename user_data/backtest_results/backtest-result.json
-```
-
-Use custom database
-
-``` bash
-freqtrade plot-profit  -p LTC/BTC --db-url sqlite:///tradesv3.sqlite --trade-source DB
-```
-
-``` bash
-freqtrade --datadir user_data/data/binance_save/ plot-profit -p LTC/BTC
-```