From 733ea61b1824ab738306d4b6f9b173b830200395 Mon Sep 17 00:00:00 2001 From: Stefan Jansen Date: Sun, 5 Mar 2023 12:13:16 -0500 Subject: [PATCH] updated install instructions --- README.md | 7 +++++-- installation/README.md | 4 ++++ installation/ml4t-base.yml | 1 - 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5078d15c0..8bf0dd8b6 100644 --- a/README.md +++ b/README.md @@ -52,10 +52,13 @@ Another innovation of the second edition is to replicate several trading applica All applications now use the latest available (at the time of writing) software versions such as pandas 1.0 and TensorFlow 2.2. There is also a customized version of Zipline that makes it easy to include machine learning model predictions when designing a trading strategy. - ## Installation, data sources and bug reports -The code examples rely on a wide range of Python libraries from the data science and finance domains. To facilitate installation, we use [Docker](https://www.docker.com/get-started) to provide containerized [conda](https://docs.conda.io/en/latest/) environments. +The code examples rely on a wide range of Python libraries from the data science and finance domains. + +It is not necessary to try and install all libraries at once because this increases the likeliihood of encountering version conflicts. Instead, we recommend that you install the libraries required for a specific chapter as you go along. + +> Update March 2022: `zipline-reloaded`, `pyfolio-reloaded`, `alphalens-reloaded`, and `empyrical-reloaded` are now available on the `conda-forge` channel. The channel `ml4t` only contains outdated versions and will soon be removed. > Update April 2021: with the update of [Zipline](https://zipline.ml4trading.io), it is no longer necessary to use Docker. The installation instructions now refer to OS-specific environment files that should simplify your running of the notebooks. diff --git a/installation/README.md b/installation/README.md index 9d01a948a..775bfc18b 100644 --- a/installation/README.md +++ b/installation/README.md @@ -1,5 +1,9 @@ # Installation instructions +It is not necessary to try and install all libraries at once because this increases the likeliihood of encountering version conflicts. Instead, we recommend that you install the libraries required for a specific chapter as you go along. + +> Update March 2022: `zipline-reloaded`, `pyfolio-reloaded`, `alphalens-reloaded`, and `empyrical-reloaded` are now available on the `conda-forge` channel. The channel `ml4t` only contains outdated versions and will soon be removed. + > There is still incomplete support for MacOS using M1/Silicone chips. Some packages compatible with new architecture are only available via `conda`/`mamba`, others only via `pip`. As a result, there is no single installation script yet - I hope to be able to simplify this as the support across the PyData ecosystem matures. For now, please create separate `conda`/`pip`-based environments to install packages as needed and supported. > Update September 10, 2021: New OS-agnostic environment files `ml4t-base.[txt, yml]` for `pip` (Linux, MacOS) and `conda` (Linux, MacOS, Windows) installs available that include the latest [Zipline](https://github.com/stefan-jansen/zipline-reloaded), [Alphalens](https://github.com/stefan-jansen/alphalens-reloaded) and [Pyfolio](https://github.com/stefan-jansen/pyfolio-reloaded) versions. These files are OS-agnostic because they include only the main libraries and not OS-specific dependencies, leaving the selection of the latest compatible versions and OS-specific depencies to your package manager of choice. diff --git a/installation/ml4t-base.yml b/installation/ml4t-base.yml index 0374ab30f..cfc8ea6e5 100644 --- a/installation/ml4t-base.yml +++ b/installation/ml4t-base.yml @@ -1,6 +1,5 @@ name: ml4t channels: - - ml4t - conda-forge - defaults - anaconda