adelorenzo
/
stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: fix typo and fix markdown list rendering

This commit is contained in:
TheJoeSchr 2022-01-31 20:23:02 +01:00
parent 421079ebb7
commit 1a838680e7
1 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/data-analysis.md
View File

@ -1,6 +1,6 @@
# Analyzing bot data with Jupyter notebooks # 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`. 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 ## Quick start with docker
@ -41,32 +41,35 @@ ipython kernel install --user --name=freqtrade
!!! Warning !!! 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. 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 ## Recommended workflow
| Task | Tool | | Task | Tool |
--- | --- --- | ---
Bot operations | CLI Bot operations | CLI
Repetitive tasks | Shell scripts Repetitive tasks | Shell scripts
Data analysis & visualization | Notebook Data analysis & visualization | Notebook
1. Use the CLI to 1. Use the CLI to
* download historical data * download historical data
* run a backtest * run a backtest
* run with real-time data * run with real-time data
* export results * export results
1. Collect these actions in shell scripts 1. Collect these actions in shell scripts
* save complicated commands with arguments * save complicated commands with arguments
* execute multi-step operations * execute multi-step operations
* automate testing strategies and preparing data for analysis * automate testing strategies and preparing data for analysis
1. Use a notebook to 1. Use a notebook to
* visualize data * visualize data
* munge and plot to generate insights * mangle and plot to generate insights
## Example utility snippets ## Example utility snippets
### Change directory to root ### Change directory to root
Jupyter notebooks execute from the notebook directory. The following snippet searches for the project root, so relative paths remain consistent. Jupyter notebooks execute from the notebook directory. The following snippet searches for the project root, so relative paths remain consistent.