From fc251281a8bf7a74cc4b2c9fd44823f4155f5964 Mon Sep 17 00:00:00 2001 From: Andras Schmelczer Date: Fri, 29 Jul 2022 13:13:58 +0200 Subject: [PATCH] Extend install instructions --- docs/how-to-guides/install.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/how-to-guides/install.md b/docs/how-to-guides/install.md index 84d0058..4b82086 100644 --- a/docs/how-to-guides/install.md +++ b/docs/how-to-guides/install.md @@ -9,6 +9,15 @@ pip install great-ai This will work on all major operating systems. +## Google Colab + +In order to use GreatAI in [Google Colab](https://colab.research.google.com){ target=_blank }, you need to downgrade `pyyaml` to a Colab compatible version. [See related StackOverflow question](https://stackoverflow.com/questions/69564817/typeerror-load-missing-1-required-positional-argument-loader-in-google-col){ target=_blank }. + +```sh +pip install great-ai pyyaml==5.4.1 +``` +> This will make GreatAI work in Colab. + ## Command-line tools After installation, `great-ai` and `large-file` are available as commands. The former is required for deploying your application while the latter lets you manage models and datasets from your terminal. @@ -33,3 +42,12 @@ If you wish to update to the latest version execute: ```sh pip install --upgrade great-ai ``` + +## Bleeding edge + +You can also install the latest (usually unreleased) version from GitHub. + +```sh +pip install --upgrade git+https://github.com/schmelczer/great-ai.git +``` +> Python 3.7 or later is required.