From 83a9bf3ee88fac01f1cd0b8d35af6ec02d44ec8f Mon Sep 17 00:00:00 2001 From: Andras Schmelczer Date: Tue, 12 Jul 2022 19:12:56 +0200 Subject: [PATCH] Add installation guide --- docs/how-to-guides/install.md | 21 +++++++++++++++++++++ mkdocs.yaml | 1 + 2 files changed, 22 insertions(+) create mode 100644 docs/how-to-guides/install.md diff --git a/docs/how-to-guides/install.md b/docs/how-to-guides/install.md new file mode 100644 index 0000000..0cef181 --- /dev/null +++ b/docs/how-to-guides/install.md @@ -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. diff --git a/mkdocs.yaml b/mkdocs.yaml index 5dbdbc5..83d66e8 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -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