From 87f4d0f1174a590c76490f1b75830b5b62cc60be Mon Sep 17 00:00:00 2001 From: Tadashi Date: Mon, 23 Sep 2024 21:58:23 +0700 Subject: [PATCH] docs: update docs #none --- docs/index.md | 32 +++----------------------------- docs/online_install.md | 13 +++++++++++++ 2 files changed, 16 insertions(+), 29 deletions(-) create mode 100644 docs/online_install.md diff --git a/docs/index.md b/docs/index.md index 9cef5cf..49633bc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,37 +5,11 @@ This page is intended for **end users** who want to use the `kotaemon` tool for Question Answering on local documents. If you are a **developer** who wants contribute to the project, please visit the [development](development/index.md) page. -## Installation (Online HuggingFace Space) +## Installation (Online HuggingFace Space) - easy (10 mins) -
+Visit this [guide](online_install.md). -View instruction - -1. Go to [kotaemon_template](https://huggingface.co/spaces/cin-model/kotaemon_template) - -2. Use Duplicate function to create your own space - -![Duplicate space](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/duplicate_space.png) - -![Change space params](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/change_space_params.png) - -3. Wait for the build to complete and start up (apprx 10 mins). - -![Wait space build](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/space_build.png) - -![Close space build](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/close_logs_space.png) - -4. Follow the first setup instructions (and register for Cohere API key if needed) - -![Cohere API](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/cohere_api_key.png) - -5. Complete the setup and use your own private space! - -![App Startup](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/initial_startup.png) - -
- -## Installation (Offline) +## Installation (Offline) - intermediate (20 mins) ### Download diff --git a/docs/online_install.md b/docs/online_install.md new file mode 100644 index 0000000..9f7eaf4 --- /dev/null +++ b/docs/online_install.md @@ -0,0 +1,13 @@ +## Installation (Online HuggingFace Space) + +1. Go to [HF kotaemon_template](https://huggingface.co/spaces/cin-model/kotaemon_template). +2. Use Duplicate function to create your own space. + ![Duplicate space](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/duplicate_space.png) + ![Change space params](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/change_space_params.png) +3. Wait for the build to complete and start up (apprx 10 mins). + ![Wait space build](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/space_build.png) + ![Close space build](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/close_logs_space.png) +4. Follow the first setup instructions (and register for Cohere API key if needed). + ![Cohere API](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/cohere_api_key.png) +5. Complete the setup and use your own private space! + ![App Startup](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/initial_startup.png)