Skip to content

Commit

Permalink
Extend install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
schmelczer committed Jul 29, 2022
1 parent a86da41 commit fc25128
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/how-to-guides/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.

0 comments on commit fc25128

Please sign in to comment.