diff --git a/README.md b/README.md index 972684909..2dc2a59ff 100644 --- a/README.md +++ b/README.md @@ -25,9 +25,7 @@ This repository is under active development. Feedback, issues, and PRs are highl appreciated. Your input is valuable as it helps us persuade our business guys to support open source. -## Installation - -### Manual installation +## Setting up - Clone the repo @@ -68,21 +66,3 @@ open source. ```shell pytest tests ``` - -### From installation scripts - -1. Clone the repository. -2. Navigate to the `scripts` folder and start an installer that matches your OS: - - Linux: `run_linux.sh` - - Windows: `run_windows.bat` - - macOS: `run_macos.sh` -3. After the installation, the installer will ask to launch the ktem's UI,answer to continue. -4. If launched, the application will be available at `http://localhost:7860/`. -5. The conda environment is located in the `install_dir/env` folder. - -Here is the setup and update strategy: - -- **Run the `run_*` script**: This setup environment, including downloading Miniconda (in case Conda is not available in your machine) and installing necessary dependencies in `install_dir` folder. -- **Launch the UI**: To launch the ktem's UI after initial setup or any changes, simply run `run_*` script again. -- **Reinstall dependencies**: Simply delete the `install_dir/env` folder and run `run_*` - script again. The script will recreate the folder with fresh dependencies. diff --git a/docs/development/contributing.md b/docs/development/contributing.md index 26540f094..af9f12997 100644 --- a/docs/development/contributing.md +++ b/docs/development/contributing.md @@ -9,13 +9,13 @@ like Langchain, llama-index,... when possible) commonly used components in kotaemon use cases. Some of these components are: LLM, vector store, document store, retriever... For a detailed list and description of these - components, please refer to the [API Reference](/reference/nav/) section. + components, please refer to the [API Reference](../reference/Summary.md) section. - List of utilities: `kotaemon` provides utilities and tools that are usually needed in client project. For example, it provides a prompt engineering UI for AI developers in a project to quickly create a prompt engineering tool for DMs and QALs. It also provides a command to quickly spin up a project code base. For a full list and description of these utilities, - please refer to the [Utilities](/development/utilities) section. + please refer to the [Utilities](utilities.md) section. ```mermaid mindmap diff --git a/docs/images/chat-tab.png b/docs/images/chat-tab.png index 6fa5e4ce6..42e9edfd6 100644 Binary files a/docs/images/chat-tab.png and b/docs/images/chat-tab.png differ diff --git a/docs/images/file-index-tab.png b/docs/images/file-index-tab.png index 488285fb3..83dccbb53 100644 Binary files a/docs/images/file-index-tab.png and b/docs/images/file-index-tab.png differ diff --git a/docs/images/resources-tab.png b/docs/images/resources-tab.png index db3938aa6..0bfb8a90b 100644 Binary files a/docs/images/resources-tab.png and b/docs/images/resources-tab.png differ diff --git a/docs/index.md b/docs/index.md index 542625533..f4b4e0098 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,8 @@ # Getting Started with Kotaemon -This page is intended for end users who want to use the `kotaemon` tool for Question Answering on local documents. +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. ## Download @@ -31,9 +33,9 @@ A browser window will be opened and greet you with this screen: ## Usage -For how to use the application, see [Usage](/usage). This page will also be available to +For how to use the application, see [Usage](usage.md). This page will also be available to you within the application. ## Feedback -Feel free to create a bug report or a feature request or join a discussion at https://github.com/Cinnamon/kotaemon/issues. +Feel free to create a bug report or a feature request on our [repo](https://github.com/Cinnamon/kotaemon/issues). diff --git a/docs/scripts/generate_reference_docs.py b/docs/scripts/generate_reference_docs.py index 33bdad4d0..596d73c6f 100644 --- a/docs/scripts/generate_reference_docs.py +++ b/docs/scripts/generate_reference_docs.py @@ -68,7 +68,7 @@ def generate_docs_for_src_code( full_doc_path, Path("..") / path.relative_to(code_dir.parent) ) - with mkdocs_gen_files.open(f"{target_doc_folder}/NAV.md", "w") as nav_file: + with mkdocs_gen_files.open(f"{target_doc_folder}/Summary.md", "w") as nav_file: nav_file.writelines(nav.build_literate_nav()) diff --git a/docs/usage.md b/docs/usage.md index 3d5ed83ba..0e7d8e6d0 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -14,18 +14,19 @@ To add a model: 1. Navigate to the `Resources` tab. -2. Select `LLM Management`. -3. Select `Add`. +2. Select the `LLMs` sub-tab. +3. Select the `Add` sub-tab. 4. Config the model to add: - Give it a name. - Pick a vendor/provider (e.g. `ChatOpenAI`). - Provide the specifications. - - Optionally, set the model as default. -5. Click `Add LLM`. + - (Optional) Set the model as default. +5. Click `Add` to add the model. +6. Select `Embedding Models` sub-tab and repeat the step 3 to 5 to add an embedding model. -
+
-Configures model via the .env file +(Optional) Configure model via the .env file Alternatively, you can configure the models via the `.env` file with the information needed to connect to the LLMs. This file is located in the folder of the application. If you don't see it, you can create one. @@ -104,7 +105,7 @@ Here is how to get the full path of your model file: - On Windows 11: right click the file and select `Copy as Path`.
-## Upload your documents +## 2. Upload your documents ![file index tab](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/file-index-tab.png) @@ -118,7 +119,7 @@ Navigate to the `File Index` tab and you will see 2 sections: 2. File list: - This section shows the list of files that have been uploaded to the application and allows users to delete them. -## Chat with your documents +## 3. Chat with your documents ![chat tab](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/chat-tab.png) diff --git a/mkdocs.yml b/mkdocs.yml index 3380b3711..71dfb9011 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,29 +7,31 @@ nav: - Getting Started: - Quick Start: index.md - Basic Usage: usage.md - - Application: - - Features: pages/app/features.md - - Index: - - File index: pages/app/index/file.md - - Settings: - - pages/app/settings/overview.md - - pages/app/settings/user-settings.md - - Extension: - - User management: pages/app/ext/user-management.md - - Customize flow logic: pages/app/customize-flows.md - - Customize UI: pages/app/customize-ui.md - - Functional description: pages/app/functional-description.md + # - Application: + # - Customize UI: pages/app/customize-ui.md + # - Functional description: pages/app/functional-description.md - Development: - development/index.md - Contributing: development/contributing.md - - Data & Data Structure Components: development/data-components.md + # - Data & Data Structure Components: development/data-components.md + # - Features: pages/app/features.md + - Components: + - Index: + - File index: pages/app/index/file.md + - Settings: + - pages/app/settings/overview.md + - pages/app/settings/user-settings.md + - Extension: + - User management: pages/app/ext/user-management.md + - Customize flow logic: pages/app/customize-flows.md - Creating a Component: development/create-a-component.md - - Utilities: development/utilities.md # generated using gen-files + literate-nav - API Reference: reference/ + - Issue Tracker: "https://github.com/Cinnamon/kotaemon/issues" markdown_extensions: - admonition + - md_in_html - pymdownx.highlight: use_pygments: true anchor_linenums: true @@ -58,7 +60,7 @@ plugins: scripts: - docs/scripts/generate_reference_docs.py - literate-nav: - nav_file: NAV.md + nav_file: Summary.md - mkdocstrings: handlers: python: