Skip to content

Commit

Permalink
Update jupyter notebook slightly
Browse files Browse the repository at this point in the history
  • Loading branch information
xmatthias committed Sep 21, 2019
1 parent 9a3bad2 commit 5234f8b
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 55 deletions.
3 changes: 2 additions & 1 deletion docs/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,8 @@ If the day shows the same day, then the last candle can be assumed as incomplete
To keep the jupyter notebooks aligned with the documentation, the following should be ran after updating a example notebook.

``` bash
jupyter nbconvert --to markdown user_data/notebooks/strategy_analysis_example.ipynb --stdout > docs/strategy_analysis_example.md
jupyter nbconvert --ClearOutputPreprocessor.enabled=True --inplace user_data/notebooks/strategy_analysis_example.ipynb
jupyter nbconvert --ClearOutputPreprocessor.enabled=True --to markdown user_data/notebooks/strategy_analysis_example.ipynb --stdout > docs/strategy_analysis_example.md
```

## Creating a release
Expand Down
28 changes: 4 additions & 24 deletions docs/strategy_analysis_example.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,22 @@
## Strategy debugging example
# Strategy analysis example

Debugging a strategy can be time-consuming. FreqTrade offers helper functions to visualize raw data.

## Setup

```python
# Change directory
# Modify this cell to insure that the output shows the correct path.
import os
from pathlib import Path

# Define all paths relative to the project root shown in the cell output
project_root = "somedir/freqtrade"
i=0
try:
os.chdirdir(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())
```


```python
from pathlib import Path
# Customize these according to your needs.

# Define some constants
ticker_interval = "5m"
# Name of the strategy class
strategy_name = 'SampleStrategy'
# Path to user data
user_data_dir = 'user_data'
user_data_dir = Path('user_data')
# Location of the strategy
strategy_location = Path(user_data_dir, 'strategies')
strategy_location = user_data_dir / 'strategies'
# Location of the data
data_location = Path(user_data_dir, 'data', 'binance')
# Pair to analyze - Only use one pair here
Expand All @@ -45,7 +26,6 @@ pair = "BTC_USDT"

```python
# Load data using values set above
from pathlib import Path
from freqtrade.data.history import load_pair_history

candles = load_pair_history(datadir=data_location,
Expand Down
35 changes: 5 additions & 30 deletions user_data/notebooks/strategy_analysis_example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Strategy debugging example\n",
"# Strategy analysis example\n",
"\n",
"Debugging a strategy can be time-consuming. FreqTrade offers helper functions to visualize raw data."
]
Expand All @@ -22,41 +22,17 @@
"metadata": {},
"outputs": [],
"source": [
"# Change directory\n",
"# Modify this cell to insure that the output shows the correct path.\n",
"import os\n",
"from pathlib import Path\n",
"\n",
"# Define all paths relative to the project root shown in the cell output\n",
"project_root = \"somedir/freqtrade\"\n",
"i=0\n",
"try:\n",
" os.chdirdir(project_root)\n",
" assert Path('LICENSE').is_file()\n",
"except:\n",
" while i<4 and (not Path('LICENSE').is_file()):\n",
" os.chdir(Path(Path.cwd(), '../'))\n",
" i+=1\n",
" project_root = Path.cwd()\n",
"print(Path.cwd())"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"# Customize these according to your needs.\n",
"\n",
"# Define some constants\n",
"ticker_interval = \"5m\"\n",
"# Name of the strategy class\n",
"strategy_name = 'SampleStrategy'\n",
"# Path to user data\n",
"user_data_dir = 'user_data'\n",
"user_data_dir = Path('user_data')\n",
"# Location of the strategy\n",
"strategy_location = Path(user_data_dir, 'strategies')\n",
"strategy_location = user_data_dir / 'strategies'\n",
"# Location of the data\n",
"data_location = Path(user_data_dir, 'data', 'binance')\n",
"# Pair to analyze - Only use one pair here\n",
Expand All @@ -70,7 +46,6 @@
"outputs": [],
"source": [
"# Load data using values set above\n",
"from pathlib import Path\n",
"from freqtrade.data.history import load_pair_history\n",
"\n",
"candles = load_pair_history(datadir=data_location,\n",
Expand Down Expand Up @@ -161,7 +136,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.3"
"version": "3.7.4"
},
"mimetype": "text/x-python",
"name": "python",
Expand Down Expand Up @@ -212,5 +187,5 @@
"version": 3
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}

0 comments on commit 5234f8b

Please sign in to comment.