From cf9ec50b73936aa8a339dfa020a7c1a707cf56cd Mon Sep 17 00:00:00 2001 From: imotai Date: Sat, 7 Oct 2023 11:32:58 +0800 Subject: [PATCH] doc: update the document --- docs/source/getstarted.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/source/getstarted.rst b/docs/source/getstarted.rst index 29880ff..ef27b50 100644 --- a/docs/source/getstarted.rst +++ b/docs/source/getstarted.rst @@ -11,7 +11,7 @@ Octopus requires the following enviroment - Python 3.10.0 and above. - `Pip `_ -- `Docker Desktop 24.0.0 and above `_ +- `Docker Desktop 24.0.0 and above `_ or `Podman `_ To use codellama, your host must have at least 8 CPUs and 16 GB of RAM @@ -28,10 +28,12 @@ the second step, use ``og_up`` to setup the octopus service and cli:: You have the option to select from -- OpenAI, [apply](https://platform.openai.com/account/api-keys) the openai api key -- Azure OpenAI, [apply](https://azure.microsoft.com/en-us/products/ai-services/openai-service) the azure api key +- OpenAI, `apply `_ the openai api key +- Azure OpenAI, `apply `_ the azure api key - CodeLlama -- Octogen(beta) agent services, [apply](https://www.octogen.dev/) the octogen agent service key +- Octogen(beta) agent services, `apply `_ the octogen agent service key + +the default is using docker as container engine, use podman with flag ``--use_podman`` If you opt for CodeLlama, Octogen will automatically download it from huggingface.co. In case the installation of the Octogen Terminal CLI is taking longer than expected,