Add installation guide

This commit is contained in:
Andras Schmelczer 2022-07-12 19:12:56 +02:00
parent 74bacb5a56
commit 83a9bf3ee8
No known key found for this signature in database
GPG key ID: 0EA1BC97D0AB076E
2 changed files with 22 additions and 0 deletions

View file

@ -0,0 +1,21 @@
# Installation guide
Provided you already have [Python3](https://www.python.org/downloads/){ target=_blank } (and pip) installed, simply execute:
```sh
pip install great-ai
```
> Python 3.8 or later is required.
This will work on all major operating systems.
## 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.
!!! warning "Windows"
On Windows, you might encounter a similar ==warning== from `pip`:
> WARNING: The scripts great-ai.exe, great_ai.exe, large-file.exe and large_file.exe are installed in 'C:\Users\...\Scripts' which is not on PATH.
> Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.
This means that `great-ai.exe` and `large-file.exe` are not in your `PATH`. Either add their containing directory ('C:\Users\...\Scripts' in this case) to your `PATH` or use `python3 -m great_ai` and `python3 -m great_ai.large_file` instead of the exe-s.

View file

@ -93,6 +93,7 @@ nav:
- tutorial/train.ipynb
- tutorial/deploy.ipynb
- User Guides:
- how-to-guides/install.md
- how-to-guides/create-service.md
- how-to-guides/configure-service.md
- how-to-guides/use-service.md