diff --git a/docs/agent-integrations/agent-zero-01.png b/docs/agent-integrations/agent-zero/agent-zero-01.png similarity index 100% rename from docs/agent-integrations/agent-zero-01.png rename to docs/agent-integrations/agent-zero/agent-zero-01.png diff --git a/docs/agent-integrations/agent-zero-02.png b/docs/agent-integrations/agent-zero/agent-zero-02.png similarity index 100% rename from docs/agent-integrations/agent-zero-02.png rename to docs/agent-integrations/agent-zero/agent-zero-02.png diff --git a/docs/agent-integrations/agent-zero-03.png b/docs/agent-integrations/agent-zero/agent-zero-03.png similarity index 100% rename from docs/agent-integrations/agent-zero-03.png rename to docs/agent-integrations/agent-zero/agent-zero-03.png diff --git a/docs/agent-integrations/agent-zero-04.png b/docs/agent-integrations/agent-zero/agent-zero-04.png similarity index 100% rename from docs/agent-integrations/agent-zero-04.png rename to docs/agent-integrations/agent-zero/agent-zero-04.png diff --git a/docs/agent-integrations/agent-zero-05.png b/docs/agent-integrations/agent-zero/agent-zero-05.png similarity index 100% rename from docs/agent-integrations/agent-zero-05.png rename to docs/agent-integrations/agent-zero/agent-zero-05.png diff --git a/docs/agent-integrations/agent-zero-06.png b/docs/agent-integrations/agent-zero/agent-zero-06.png similarity index 100% rename from docs/agent-integrations/agent-zero-06.png rename to docs/agent-integrations/agent-zero/agent-zero-06.png diff --git a/docs/agent-integrations/agent-zero-07.png b/docs/agent-integrations/agent-zero/agent-zero-07.png similarity index 100% rename from docs/agent-integrations/agent-zero-07.png rename to docs/agent-integrations/agent-zero/agent-zero-07.png diff --git a/docs/agent-integrations/agent-zero-08.png b/docs/agent-integrations/agent-zero/agent-zero-08.png similarity index 100% rename from docs/agent-integrations/agent-zero-08.png rename to docs/agent-integrations/agent-zero/agent-zero-08.png diff --git a/docs/agent-integrations/agent-zero-09.png b/docs/agent-integrations/agent-zero/agent-zero-09.png similarity index 100% rename from docs/agent-integrations/agent-zero-09.png rename to docs/agent-integrations/agent-zero/agent-zero-09.png diff --git a/docs/agent-integrations/agent-zero.md b/docs/agent-integrations/agent-zero/agent-zero.md similarity index 98% rename from docs/agent-integrations/agent-zero.md rename to docs/agent-integrations/agent-zero/agent-zero.md index b93a2672..d3e90e7b 100644 --- a/docs/agent-integrations/agent-zero.md +++ b/docs/agent-integrations/agent-zero/agent-zero.md @@ -12,7 +12,7 @@ It is designed to be dynamic, organically growing, and learning as users use it. You will need a Gaia node to provide LLM services to the agent app. You can * [run your own node](../../getting-started/quick-start) -* [use a public node](../nodes) +* [use a public node](../../nodes) In this tutorial, we will use the public [Llama-3.1-8B node](https://github.com/GaiaNet-AI/node-configs/tree/main/llama-3.1-8b-instruct) to power the Agent Zero. diff --git a/docs/agent-integrations/anything-llm-01.png b/docs/agent-integrations/anything_llm/anything-llm-01.png similarity index 100% rename from docs/agent-integrations/anything-llm-01.png rename to docs/agent-integrations/anything_llm/anything-llm-01.png diff --git a/docs/agent-integrations/anything-llm-02.png b/docs/agent-integrations/anything_llm/anything-llm-02.png similarity index 100% rename from docs/agent-integrations/anything-llm-02.png rename to docs/agent-integrations/anything_llm/anything-llm-02.png diff --git a/docs/agent-integrations/anything-llm-03.png b/docs/agent-integrations/anything_llm/anything-llm-03.png similarity index 100% rename from docs/agent-integrations/anything-llm-03.png rename to docs/agent-integrations/anything_llm/anything-llm-03.png diff --git a/docs/agent-integrations/anything_llm.md b/docs/agent-integrations/anything_llm/anything_llm.md similarity index 100% rename from docs/agent-integrations/anything_llm.md rename to docs/agent-integrations/anything_llm/anything_llm.md diff --git a/docs/agent-integrations/book-01.png b/docs/agent-integrations/book/book-01.png similarity index 100% rename from docs/agent-integrations/book-01.png rename to docs/agent-integrations/book/book-01.png diff --git a/docs/agent-integrations/book-02.png b/docs/agent-integrations/book/book-02.png similarity index 100% rename from docs/agent-integrations/book-02.png rename to docs/agent-integrations/book/book-02.png diff --git a/docs/agent-integrations/book-03.png b/docs/agent-integrations/book/book-03.png similarity index 100% rename from docs/agent-integrations/book-03.png rename to docs/agent-integrations/book/book-03.png diff --git a/docs/agent-integrations/codegpt-01.png b/docs/agent-integrations/codegpt/codegpt-01.png similarity index 100% rename from docs/agent-integrations/codegpt-01.png rename to docs/agent-integrations/codegpt/codegpt-01.png diff --git a/docs/agent-integrations/codegpt-02.png b/docs/agent-integrations/codegpt/codegpt-02.png similarity index 100% rename from docs/agent-integrations/codegpt-02.png rename to docs/agent-integrations/codegpt/codegpt-02.png diff --git a/docs/agent-integrations/codegpt-03.png b/docs/agent-integrations/codegpt/codegpt-03.png similarity index 100% rename from docs/agent-integrations/codegpt-03.png rename to docs/agent-integrations/codegpt/codegpt-03.png diff --git a/docs/agent-integrations/codegpt-04.png b/docs/agent-integrations/codegpt/codegpt-04.png similarity index 100% rename from docs/agent-integrations/codegpt-04.png rename to docs/agent-integrations/codegpt/codegpt-04.png diff --git a/docs/agent-integrations/codegpt.md b/docs/agent-integrations/codegpt/codegpt.md similarity index 94% rename from docs/agent-integrations/codegpt.md rename to docs/agent-integrations/codegpt/codegpt.md index d169b21e..4ccaf44a 100644 --- a/docs/agent-integrations/codegpt.md +++ b/docs/agent-integrations/codegpt/codegpt.md @@ -11,7 +11,7 @@ CodeGPT is a pair-programming partner for developers. It offers AI chat assistan You will need a Gaia node ready to provide LLM services through a public URL. You can * [run your own node](../../getting-started/quick-start) -* [use a public node](../nodes) +* [use a public node](../../nodes) In this tutorial, we will use the public CodeStral nodes to power the CodeGPT plugin. @@ -49,7 +49,7 @@ Click the CODEGPT on the right sidebar and enter the settings page for CodeGPT. Save the above settings. -> If you're using a Domain service, not your own node, you will [need to get an API key from Gaia](../getting-started/authentication.md). +> If you're using a Domain service, not your own node, you will [need to get an API key from Gaia](../../getting-started/authentication/authentication.md). ## Use the plugin diff --git a/docs/agent-integrations/continue-01.png b/docs/agent-integrations/continue/continue-01.png similarity index 100% rename from docs/agent-integrations/continue-01.png rename to docs/agent-integrations/continue/continue-01.png diff --git a/docs/agent-integrations/continue.md b/docs/agent-integrations/continue/continue.md similarity index 98% rename from docs/agent-integrations/continue.md rename to docs/agent-integrations/continue/continue.md index 9a9e5326..fee15e7e 100644 --- a/docs/agent-integrations/continue.md +++ b/docs/agent-integrations/continue/continue.md @@ -17,7 +17,7 @@ It is a copilot-like plugin for VSCode and JetBrains to provide custom autocompl You will need a Gaia node ready to provide LLM services through a public URL. You can * [Run your own node](../../getting-started/quick-start) -* [Use a public node](../nodes) +* [Use a public node](../../nodes/nodes.md) In this tutorial, we will use public nodes to power the Continue plugin. diff --git a/docs/agent-integrations/cursor-01.png b/docs/agent-integrations/cursor/cursor-01.png similarity index 100% rename from docs/agent-integrations/cursor-01.png rename to docs/agent-integrations/cursor/cursor-01.png diff --git a/docs/agent-integrations/cursor-02.png b/docs/agent-integrations/cursor/cursor-02.png similarity index 100% rename from docs/agent-integrations/cursor-02.png rename to docs/agent-integrations/cursor/cursor-02.png diff --git a/docs/agent-integrations/cursor.md b/docs/agent-integrations/cursor/cursor.md similarity index 98% rename from docs/agent-integrations/cursor.md rename to docs/agent-integrations/cursor/cursor.md index 9eaf303d..942515ea 100644 --- a/docs/agent-integrations/cursor.md +++ b/docs/agent-integrations/cursor/cursor.md @@ -17,7 +17,7 @@ You can use Cursor with your own Gaia node as the LLM backend. There are two big You will need a Gaia node to provide LLM API services. You can * [Run your own node](../../getting-started/quick-start) -* [Use a public node](../nodes) +* [Use a public node](../../nodes) In this tutorial, we will use public [Qwen 2.5 Coder](https://github.com/QwenLM/Qwen2.5-Coder) nodes to power Cursor. diff --git a/docs/agent-integrations/dify.md b/docs/agent-integrations/dify/dify.md similarity index 95% rename from docs/agent-integrations/dify.md rename to docs/agent-integrations/dify/dify.md index 04032d65..a2cc64ac 100644 --- a/docs/agent-integrations/dify.md +++ b/docs/agent-integrations/dify/dify.md @@ -14,13 +14,13 @@ You can configure the Dify framework using any Gaia node as the backend LLM API. First, log into Dify's web portal and select `Settings | Model Provider`. From the list, you can add an OpenAI-API-compatible provider. -Add an LLM model with the model name and API endpoint listed on your Gaia node's web dashboard. Or, you can just add [a popular Gaia node](../nodes). +Add an LLM model with the model name and API endpoint listed on your Gaia node's web dashboard. Or, you can just add [a popular Gaia node](../../nodes/nodes.md). Leave the API Key field empty. ![Configure a Gaia Llama3 8b model in Dify](dify_chat.png) Most Dify applications also require an embedding model to search text in the vector space. -Add an embedding model with the model name and API endpoint listed on your Gaia node's web dashboard. Or, you can just add [a popular Gaia node](../nodes). +Add an embedding model with the model name and API endpoint listed on your Gaia node's web dashboard. Or, you can just add [a popular Gaia node](../../nodes). Leave the API Key field empty. ![Configure a Gaia embedding model in Dify](dify_embedding.png) diff --git a/docs/agent-integrations/dify_chat.png b/docs/agent-integrations/dify/dify_chat.png similarity index 100% rename from docs/agent-integrations/dify_chat.png rename to docs/agent-integrations/dify/dify_chat.png diff --git a/docs/agent-integrations/dify_chatbot_ui.png b/docs/agent-integrations/dify/dify_chatbot_ui.png similarity index 100% rename from docs/agent-integrations/dify_chatbot_ui.png rename to docs/agent-integrations/dify/dify_chatbot_ui.png diff --git a/docs/agent-integrations/dify_embedding.png b/docs/agent-integrations/dify/dify_embedding.png similarity index 100% rename from docs/agent-integrations/dify_embedding.png rename to docs/agent-integrations/dify/dify_embedding.png diff --git a/docs/agent-integrations/dify_select.png b/docs/agent-integrations/dify/dify_select.png similarity index 100% rename from docs/agent-integrations/dify_select.png rename to docs/agent-integrations/dify/dify_select.png diff --git a/docs/agent-integrations/flowise-01.png b/docs/agent-integrations/flowise/flowise-01.png similarity index 100% rename from docs/agent-integrations/flowise-01.png rename to docs/agent-integrations/flowise/flowise-01.png diff --git a/docs/agent-integrations/flowise-02.png b/docs/agent-integrations/flowise/flowise-02.png similarity index 100% rename from docs/agent-integrations/flowise-02.png rename to docs/agent-integrations/flowise/flowise-02.png diff --git a/docs/agent-integrations/flowise-03.png b/docs/agent-integrations/flowise/flowise-03.png similarity index 100% rename from docs/agent-integrations/flowise-03.png rename to docs/agent-integrations/flowise/flowise-03.png diff --git a/docs/agent-integrations/flowise-04.png b/docs/agent-integrations/flowise/flowise-04.png similarity index 100% rename from docs/agent-integrations/flowise-04.png rename to docs/agent-integrations/flowise/flowise-04.png diff --git a/docs/agent-integrations/flowise-tool-01.png b/docs/agent-integrations/flowise/flowise-tool-01.png similarity index 100% rename from docs/agent-integrations/flowise-tool-01.png rename to docs/agent-integrations/flowise/flowise-tool-01.png diff --git a/docs/agent-integrations/flowise-tool-02.png b/docs/agent-integrations/flowise/flowise-tool-02.png similarity index 100% rename from docs/agent-integrations/flowise-tool-02.png rename to docs/agent-integrations/flowise/flowise-tool-02.png diff --git a/docs/agent-integrations/flowise-tool-03.png b/docs/agent-integrations/flowise/flowise-tool-03.png similarity index 100% rename from docs/agent-integrations/flowise-tool-03.png rename to docs/agent-integrations/flowise/flowise-tool-03.png diff --git a/docs/agent-integrations/flowise-tool-04.png b/docs/agent-integrations/flowise/flowise-tool-04.png similarity index 100% rename from docs/agent-integrations/flowise-tool-04.png rename to docs/agent-integrations/flowise/flowise-tool-04.png diff --git a/docs/agent-integrations/flowise-tool-05.png b/docs/agent-integrations/flowise/flowise-tool-05.png similarity index 100% rename from docs/agent-integrations/flowise-tool-05.png rename to docs/agent-integrations/flowise/flowise-tool-05.png diff --git a/docs/agent-integrations/flowise-tool-06.png b/docs/agent-integrations/flowise/flowise-tool-06.png similarity index 100% rename from docs/agent-integrations/flowise-tool-06.png rename to docs/agent-integrations/flowise/flowise-tool-06.png diff --git a/docs/agent-integrations/flowiseai-tool-call.md b/docs/agent-integrations/flowise/flowiseai-tool-call.md similarity index 100% rename from docs/agent-integrations/flowiseai-tool-call.md rename to docs/agent-integrations/flowise/flowiseai-tool-call.md diff --git a/docs/agent-integrations/flowiseai.md b/docs/agent-integrations/flowise/flowiseai.md similarity index 98% rename from docs/agent-integrations/flowiseai.md rename to docs/agent-integrations/flowise/flowiseai.md index 80896150..9f840d0e 100644 --- a/docs/agent-integrations/flowiseai.md +++ b/docs/agent-integrations/flowise/flowiseai.md @@ -11,7 +11,7 @@ FlowiseAI is a low-code tool for developers to build customized LLM orchestratio You will need a Gaia node ready to provide LLM services through a public URL. You can * [run your own node](../../getting-started/quick-start) -* [use a public node](../nodes) +* [use a public node](../../nodes/nodes.md) In this tutorial, we will use public nodes to power the Continue plugin. diff --git a/docs/agent-integrations/gpt-planner.md b/docs/agent-integrations/gpt-planner/gpt-planner.md similarity index 94% rename from docs/agent-integrations/gpt-planner.md rename to docs/agent-integrations/gpt-planner/gpt-planner.md index 79f769a2..c70b3477 100644 --- a/docs/agent-integrations/gpt-planner.md +++ b/docs/agent-integrations/gpt-planner/gpt-planner.md @@ -12,8 +12,8 @@ Since the program uses the official OpenAI Python library, we can [easily change You will need a Gaia node ready to provide LLM services through a public URL. You can -* [run your own node](../../getting-started/quick-start) -* [use a public node](../nodes) +* [run your own node](../../getting-started/quick-start/quick-start.md) +* [use a public node](../../nodes/nodes.md) In this tutorial, we will use a public node. diff --git a/docs/agent-integrations/intro.md b/docs/agent-integrations/intro.md index 850c7b4f..24fe36a3 100644 --- a/docs/agent-integrations/intro.md +++ b/docs/agent-integrations/intro.md @@ -21,7 +21,7 @@ pip install openai ``` When you create an OpenAI client using the library, you can pass in the API endpoint point as the `base_url`. -Remember to append the `/v1` after the host name. You can find a list of public nodes [here](../nodes.md). +Remember to append the `/v1` after the host name. You can find a list of public nodes [here](../nodes/nodes.md). ``` import openai diff --git a/docs/agent-integrations/langchain.md b/docs/agent-integrations/langchain/langchain.md similarity index 93% rename from docs/agent-integrations/langchain.md rename to docs/agent-integrations/langchain/langchain.md index 8740856c..a21e3eb6 100644 --- a/docs/agent-integrations/langchain.md +++ b/docs/agent-integrations/langchain/langchain.md @@ -19,8 +19,8 @@ You can configure Langchain to use any Gaia node as the LLM backend, that way yo You will need a Gaia node ready to provide LLM services through a public URL. You can: -- [Run your own node](../../getting-started/quick-start) -- [Use a public node](../nodes) +- [Run your own node](../../getting-started/quick-start/quick-start.md) +- [Use a public node](../../nodes/nodes.md) If you are using a public node, you will need an [API key](https://www.gaianet.ai/setting/gaia-api-keys). **Gaia offers free 50,000 API credits to use with available services such as public nodes when you apply for a developer account**. @@ -47,7 +47,7 @@ If you are using a public node, you will need an [API key](https://www.gaianet.a ## Integration with Gaia -To get started with running your Gaia node, you can follow the guide on the [Setting up your own node](/getting-started/quick-start) page for a quickstart. +To get started with running your Gaia node, you can follow the guide on the [Setting up your own node](../../getting-started/quick-start/quick-start.md) page for a quickstart. In this guide, we will be running our Gaia node locally so we do not need an API key, you can use a string like: "Gaia" as a placeholder. Create a `.env` file and store your API key: diff --git a/docs/agent-integrations/llamacoder.md b/docs/agent-integrations/llama/llamacoder.md similarity index 92% rename from docs/agent-integrations/llamacoder.md rename to docs/agent-integrations/llama/llamacoder.md index d47e7962..fd5331b5 100644 --- a/docs/agent-integrations/llamacoder.md +++ b/docs/agent-integrations/llama/llamacoder.md @@ -10,8 +10,8 @@ LlamaCoder is an open-source tool designed to generate small apps with a single You will need a Gaia node ready to provide LLM services through a public URL. You can -* [run your own node](../../getting-started/quick-start) -* [use a public node](../nodes) +* [run your own node](../../getting-started/quick-start/quick-start.md) +* [use a public node](../../nodes/nodes.md) In this tutorial, we will use a public Llama3 node. diff --git a/docs/agent-integrations/llamacoder.png b/docs/agent-integrations/llama/llamacoder.png similarity index 100% rename from docs/agent-integrations/llamacoder.png rename to docs/agent-integrations/llama/llamacoder.png diff --git a/docs/agent-integrations/llamaedgebook.md b/docs/agent-integrations/llama/llamaedgebook.md similarity index 95% rename from docs/agent-integrations/llamaedgebook.md rename to docs/agent-integrations/llama/llamaedgebook.md index 4d58b055..1eedb305 100644 --- a/docs/agent-integrations/llamaedgebook.md +++ b/docs/agent-integrations/llama/llamaedgebook.md @@ -55,12 +55,12 @@ Collecting usage statistics. To deactivate, set browser.gatherUsageStats to fals Finally, you can open the `http://localhost:8501` in your browser to generate a book. -![](book-01.png) +![](../book/book-01.png) The LlamaEdgeBook will first generate an outline based on your prompt, and then create the chapter content based on the outline. -![](book-02.png) +![](../book/book-02.png) You can also download the book after the generation is complete. -![](book-03.png) \ No newline at end of file +![](../book/book-03.png) \ No newline at end of file diff --git a/docs/agent-integrations/llamaparse-01.png b/docs/agent-integrations/llama/llamaparse-01.png similarity index 100% rename from docs/agent-integrations/llamaparse-01.png rename to docs/agent-integrations/llama/llamaparse-01.png diff --git a/docs/agent-integrations/llamaparse.md b/docs/agent-integrations/llama/llamaparse.md similarity index 95% rename from docs/agent-integrations/llamaparse.md rename to docs/agent-integrations/llama/llamaparse.md index c0dc65e6..275ff2a8 100644 --- a/docs/agent-integrations/llamaparse.md +++ b/docs/agent-integrations/llama/llamaparse.md @@ -12,8 +12,8 @@ You can configure LlamaParse to use the Gaia node as the LLM backend, hence you You will need a Gaia node ready to provide LLM services through a public URL. You can -* [run your own node](../../getting-started/quick-start) -* [use a public node](../nodes) +* [run your own node](../../getting-started/quick-start/quick-start.md) +* [use a public node](../../nodes/nodes.md) In this tutorial, we will use public nodes to power the Continue plugin. diff --git a/docs/agent-integrations/llamatutor-01.png b/docs/agent-integrations/llama/llamatutor-01.png similarity index 100% rename from docs/agent-integrations/llamatutor-01.png rename to docs/agent-integrations/llama/llamatutor-01.png diff --git a/docs/agent-integrations/llamatutor.md b/docs/agent-integrations/llama/llamatutor.md similarity index 88% rename from docs/agent-integrations/llamatutor.md rename to docs/agent-integrations/llama/llamatutor.md index 55ff0e66..a5b1cd71 100644 --- a/docs/agent-integrations/llamatutor.md +++ b/docs/agent-integrations/llama/llamatutor.md @@ -7,14 +7,14 @@ sidebar_position: 105 The [LlamaTutor](https://github.com/Nutlope/llamatutor) is a TypeScript application using Llama 3.1 to act as an open-source AI personal tutor. When you run it, it will ask the LLM to search on the web based on your inquiry topic and then generate content for you to learn. -The program didn't use the official OpenAI library, we can use the forked one that supports [using a Gaia node](intro.md) as the LLM backend. +The program didn't use the official OpenAI library, we can use the forked one that supports [using a Gaia node](../intro.md) as the LLM backend. ## Prerequisites You will need a Gaia node ready to provide LLM services through a public URL. You can -* [Run your own node](../../getting-started/quick-start) -* [Use a public node](../nodes) +* [Run your own node](../../getting-started/quick-start/quick-start.md) +* [Use a public node](../../nodes/nodes.md) In this tutorial, we will use a public Llama3 node. diff --git a/docs/agent-integrations/lobechat-gaianet-01.png b/docs/agent-integrations/lobechat/lobechat-gaianet-01.png similarity index 100% rename from docs/agent-integrations/lobechat-gaianet-01.png rename to docs/agent-integrations/lobechat/lobechat-gaianet-01.png diff --git a/docs/agent-integrations/lobechat-gaianet-02.png b/docs/agent-integrations/lobechat/lobechat-gaianet-02.png similarity index 100% rename from docs/agent-integrations/lobechat-gaianet-02.png rename to docs/agent-integrations/lobechat/lobechat-gaianet-02.png diff --git a/docs/agent-integrations/lobechat.md b/docs/agent-integrations/lobechat/lobechat.md similarity index 100% rename from docs/agent-integrations/lobechat.md rename to docs/agent-integrations/lobechat/lobechat.md diff --git a/docs/agent-integrations/obsidian-configure.png b/docs/agent-integrations/obsidian/obsidian-configure.png similarity index 100% rename from docs/agent-integrations/obsidian-configure.png rename to docs/agent-integrations/obsidian/obsidian-configure.png diff --git a/docs/agent-integrations/obsidian-enable.png b/docs/agent-integrations/obsidian/obsidian-enable.png similarity index 100% rename from docs/agent-integrations/obsidian-enable.png rename to docs/agent-integrations/obsidian/obsidian-enable.png diff --git a/docs/agent-integrations/obsidian-extract.png b/docs/agent-integrations/obsidian/obsidian-extract.png similarity index 100% rename from docs/agent-integrations/obsidian-extract.png rename to docs/agent-integrations/obsidian/obsidian-extract.png diff --git a/docs/agent-integrations/obsidian-grammar.png b/docs/agent-integrations/obsidian/obsidian-grammar.png similarity index 100% rename from docs/agent-integrations/obsidian-grammar.png rename to docs/agent-integrations/obsidian/obsidian-grammar.png diff --git a/docs/agent-integrations/obsidian-hotkey.png b/docs/agent-integrations/obsidian/obsidian-hotkey.png similarity index 100% rename from docs/agent-integrations/obsidian-hotkey.png rename to docs/agent-integrations/obsidian/obsidian-hotkey.png diff --git a/docs/agent-integrations/obsidian-model.png b/docs/agent-integrations/obsidian/obsidian-model.png similarity index 100% rename from docs/agent-integrations/obsidian-model.png rename to docs/agent-integrations/obsidian/obsidian-model.png diff --git a/docs/agent-integrations/obsidian-summarization.png b/docs/agent-integrations/obsidian/obsidian-summarization.png similarity index 100% rename from docs/agent-integrations/obsidian-summarization.png rename to docs/agent-integrations/obsidian/obsidian-summarization.png diff --git a/docs/agent-integrations/obsidian-text-continuation.png b/docs/agent-integrations/obsidian/obsidian-text-continuation.png similarity index 100% rename from docs/agent-integrations/obsidian-text-continuation.png rename to docs/agent-integrations/obsidian/obsidian-text-continuation.png diff --git a/docs/agent-integrations/obsidian.md b/docs/agent-integrations/obsidian/obsidian.md similarity index 98% rename from docs/agent-integrations/obsidian.md rename to docs/agent-integrations/obsidian/obsidian.md index d1873ada..c6b9c08f 100644 --- a/docs/agent-integrations/obsidian.md +++ b/docs/agent-integrations/obsidian/obsidian.md @@ -16,8 +16,8 @@ This guide explains how to set up and use the plugin with a Gaia node as an alte You will need a Gaia node ready to provide LLM services through a public URL. You can -* [Run your own node](../../getting-started/quick-start) -* [Use a public node](../nodes) +* [Run your own node](../../getting-started/quick-start/quick-start.md) +* [Use a public node](../../nodes/nodes.md) In this tutorial, we will use a public node. diff --git a/docs/agent-integrations/openwebui-01.png b/docs/agent-integrations/openwebui/openwebui-01.png similarity index 100% rename from docs/agent-integrations/openwebui-01.png rename to docs/agent-integrations/openwebui/openwebui-01.png diff --git a/docs/agent-integrations/openwebui-02.png b/docs/agent-integrations/openwebui/openwebui-02.png similarity index 100% rename from docs/agent-integrations/openwebui-02.png rename to docs/agent-integrations/openwebui/openwebui-02.png diff --git a/docs/agent-integrations/openwebui-03.png b/docs/agent-integrations/openwebui/openwebui-03.png similarity index 100% rename from docs/agent-integrations/openwebui-03.png rename to docs/agent-integrations/openwebui/openwebui-03.png diff --git a/docs/agent-integrations/openwebui-04.png b/docs/agent-integrations/openwebui/openwebui-04.png similarity index 100% rename from docs/agent-integrations/openwebui-04.png rename to docs/agent-integrations/openwebui/openwebui-04.png diff --git a/docs/agent-integrations/openwebui-05.png b/docs/agent-integrations/openwebui/openwebui-05.png similarity index 100% rename from docs/agent-integrations/openwebui-05.png rename to docs/agent-integrations/openwebui/openwebui-05.png diff --git a/docs/agent-integrations/openwebui.md b/docs/agent-integrations/openwebui/openwebui.md similarity index 95% rename from docs/agent-integrations/openwebui.md rename to docs/agent-integrations/openwebui/openwebui.md index fd72f310..44f18433 100644 --- a/docs/agent-integrations/openwebui.md +++ b/docs/agent-integrations/openwebui/openwebui.md @@ -10,8 +10,8 @@ You can configure the Open WebUI framework, a self-hosted WebUI, using any Gaia You will need a Gaia node ready to provide LLM services through a public URL. You can -* [run your own node](../../getting-started/quick-start) -* [use a public node](../nodes) +* [run your own node](../../getting-started/quick-start/quick-start.md) +* [use a public node](../../nodes/nodes.md) In this tutorial, we will use public nodes to power the Continue plugin. diff --git a/docs/agent-integrations/stockbot-01.png b/docs/agent-integrations/stockbot/stockbot-01.png similarity index 100% rename from docs/agent-integrations/stockbot-01.png rename to docs/agent-integrations/stockbot/stockbot-01.png diff --git a/docs/agent-integrations/stockbot.md b/docs/agent-integrations/stockbot/stockbot.md similarity index 92% rename from docs/agent-integrations/stockbot.md rename to docs/agent-integrations/stockbot/stockbot.md index fa23f488..3046cb12 100644 --- a/docs/agent-integrations/stockbot.md +++ b/docs/agent-integrations/stockbot/stockbot.md @@ -13,8 +13,8 @@ Stockbot is a lightning fast AI Chatbot that responds with live interactive stoc You will need a Gaia node ready to provide LLM services through a public URL. You can -* [run your own node](../../getting-started/quick-start) -* [use a public node](../nodes) +* [run your own node](../../getting-started/quick-start/quick-start.md) +* [use a public node](../../nodes/nodes.md) In this tutorial, we will use a public Llama3 node with the function call support. diff --git a/docs/agent-integrations/translation-agent.md b/docs/agent-integrations/translation-agent/translation-agent.md similarity index 100% rename from docs/agent-integrations/translation-agent.md rename to docs/agent-integrations/translation-agent/translation-agent.md diff --git a/docs/agent-integrations/zed-01.png b/docs/agent-integrations/zed/zed-01.png similarity index 100% rename from docs/agent-integrations/zed-01.png rename to docs/agent-integrations/zed/zed-01.png diff --git a/docs/agent-integrations/zed-02.png b/docs/agent-integrations/zed/zed-02.png similarity index 100% rename from docs/agent-integrations/zed-02.png rename to docs/agent-integrations/zed/zed-02.png diff --git a/docs/agent-integrations/zed-03.png b/docs/agent-integrations/zed/zed-03.png similarity index 100% rename from docs/agent-integrations/zed-03.png rename to docs/agent-integrations/zed/zed-03.png diff --git a/docs/agent-integrations/zed-04.png b/docs/agent-integrations/zed/zed-04.png similarity index 100% rename from docs/agent-integrations/zed-04.png rename to docs/agent-integrations/zed/zed-04.png diff --git a/docs/agent-integrations/zed-05.png b/docs/agent-integrations/zed/zed-05.png similarity index 100% rename from docs/agent-integrations/zed-05.png rename to docs/agent-integrations/zed/zed-05.png diff --git a/docs/agent-integrations/zed.md b/docs/agent-integrations/zed/zed.md similarity index 97% rename from docs/agent-integrations/zed.md rename to docs/agent-integrations/zed/zed.md index 449d8aff..93330d26 100644 --- a/docs/agent-integrations/zed.md +++ b/docs/agent-integrations/zed/zed.md @@ -16,8 +16,8 @@ sidebar_position: 10 You will need a Gaia node to provide LLM services to Zed. You can -* [run your own node](../../getting-started/quick-start) -* [use a public node](../nodes) +* [run your own node](../../getting-started/quick-start/quick-start.md) +* [use a public node](../../nodes/nodes.md) In this tutorial, we will use public [Qwen 2.5 Coder](https://github.com/QwenLM/Qwen2.5-Coder) nodes to power Cursor. diff --git a/docs/closed_vs_open.jpg b/docs/closed_vs_open/closed_vs_open.jpg similarity index 100% rename from docs/closed_vs_open.jpg rename to docs/closed_vs_open/closed_vs_open.jpg diff --git a/docs/gaianet_agent.png b/docs/gaianet/gaianet_agent.png similarity index 100% rename from docs/gaianet_agent.png rename to docs/gaianet/gaianet_agent.png diff --git a/docs/gaianet_eco.png b/docs/gaianet/gaianet_eco.png similarity index 100% rename from docs/gaianet_eco.png rename to docs/gaianet/gaianet_eco.png diff --git a/docs/gaianet_node.png b/docs/gaianet/gaianet_node.png similarity index 100% rename from docs/gaianet_node.png rename to docs/gaianet/gaianet_node.png diff --git a/docs/getting-started/advanced-deployment-options/aws.md b/docs/getting-started/advanced-deployment-options/aws/aws.md similarity index 93% rename from docs/getting-started/advanced-deployment-options/aws.md rename to docs/getting-started/advanced-deployment-options/aws/aws.md index 4f9e94c5..2c0b02fe 100644 --- a/docs/getting-started/advanced-deployment-options/aws.md +++ b/docs/getting-started/advanced-deployment-options/aws/aws.md @@ -43,7 +43,7 @@ gaianet start The node is ready when it shows `The Gaia node is started at: https://...` on the console. You can go to that URL from your browser to interact with the Gaia node. -You can [customize your Gaia node](../customize.md) with your own choice of LLMs and knowledge base snapshots. +You can [customize your Gaia node](../../customize/customize.md) with your own choice of LLMs and knowledge base snapshots. ## Running a CPU-only AWS instance @@ -70,4 +70,4 @@ gaianet start The node is ready when it shows `The Gaia node is started at: https://...` on the console. You can go to that URL from your browser to interact with the Gaia node. -You can [customize your Gaia node](../customize.md) with your own choice of LLMs and knowledge base snapshots. +You can [customize your Gaia node](../../customize/customize.md) with your own choice of LLMs and knowledge base snapshots. diff --git a/docs/getting-started/advanced-deployment-options/aws_ami.png b/docs/getting-started/advanced-deployment-options/aws/aws_ami.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/aws_ami.png rename to docs/getting-started/advanced-deployment-options/aws/aws_ami.png diff --git a/docs/getting-started/advanced-deployment-options/aws_instance_type.png b/docs/getting-started/advanced-deployment-options/aws/aws_instance_type.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/aws_instance_type.png rename to docs/getting-started/advanced-deployment-options/aws/aws_instance_type.png diff --git a/docs/getting-started/advanced-deployment-options/aws_network.png b/docs/getting-started/advanced-deployment-options/aws/aws_network.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/aws_network.png rename to docs/getting-started/advanced-deployment-options/aws/aws_network.png diff --git a/docs/getting-started/advanced-deployment-options/cli-installation.png b/docs/getting-started/advanced-deployment-options/cli/cli-installation.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/cli-installation.png rename to docs/getting-started/advanced-deployment-options/cli/cli-installation.png diff --git a/docs/getting-started/advanced-deployment-options/gaia-cli-installation.png b/docs/getting-started/advanced-deployment-options/cli/gaia-cli-installation.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/gaia-cli-installation.png rename to docs/getting-started/advanced-deployment-options/cli/gaia-cli-installation.png diff --git a/docs/getting-started/advanced-deployment-options/cuda.md b/docs/getting-started/advanced-deployment-options/cuda/cuda.md similarity index 100% rename from docs/getting-started/advanced-deployment-options/cuda.md rename to docs/getting-started/advanced-deployment-options/cuda/cuda.md diff --git a/docs/getting-started/advanced-deployment-options/docker.md b/docs/getting-started/advanced-deployment-options/docker/docker.md similarity index 100% rename from docs/getting-started/advanced-deployment-options/docker.md rename to docs/getting-started/advanced-deployment-options/docker/docker.md diff --git a/docs/getting-started/advanced-deployment-options/gaianet-init.png b/docs/getting-started/advanced-deployment-options/gaia/gaianet-init.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/gaianet-init.png rename to docs/getting-started/advanced-deployment-options/gaia/gaianet-init.png diff --git a/docs/getting-started/advanced-deployment-options/gaianet-start.png b/docs/getting-started/advanced-deployment-options/gaia/gaianet-start.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/gaianet-start.png rename to docs/getting-started/advanced-deployment-options/gaia/gaianet-start.png diff --git a/docs/getting-started/advanced-deployment-options/multiple.md b/docs/getting-started/advanced-deployment-options/multiple.md index d91bd5e6..03578bda 100644 --- a/docs/getting-started/advanced-deployment-options/multiple.md +++ b/docs/getting-started/advanced-deployment-options/multiple.md @@ -4,7 +4,7 @@ sidebar_position: 103 # Install multiple nodes on a single machine -The [default Gaia installer](../quick-start) installs the node into the `$HOME/gaianet` base directory. +The [default Gaia installer](../quick-start/quick-start.md) installs the node into the `$HOME/gaianet` base directory. You could install multiple nodes on the same machine. Each node has its own "base directory". To do that, you just need to use the `--base` option. diff --git a/docs/getting-started/advanced-deployment-options/windows.md b/docs/getting-started/advanced-deployment-options/windows.md index 75123036..96c56fb2 100644 --- a/docs/getting-started/advanced-deployment-options/windows.md +++ b/docs/getting-started/advanced-deployment-options/windows.md @@ -11,7 +11,7 @@ Here is the complete guide to installing and running your own decentralised AI i - Windows Sub-system for Linux - Ubuntu (Latest distribution) -Learn more about [system requirements](../system-requirements). +Learn more about [system requirements](../system-requirements/system-requirements.md). ## Step 1 @@ -23,10 +23,10 @@ wsl --install Ubuntu-24.04 Following is the progress that you should notice when WSL and Ubuntu-24.04 is being installed. -![](wsl-install-ubuntu.png) -![](wsl-installer.png) -![](launching-ubuntu.png) -![](installation-complete.png) +![](../advanced-deployment-options/wsl-ubuntu/wsl-install-ubuntu.png) +![](../advanced-deployment-options/wsl-ubuntu/wsl-installer.png) +![](../advanced-deployment-options/wsl-ubuntu/launching-ubuntu.png) +![](../advanced-deployment-options/wsl-ubuntu/installation-complete.png) ## Step 2 @@ -37,15 +37,15 @@ Make sure to: Once WSL is installed and your choice of Ubuntu is installed, you should see the following: -![Ubuntu-24.04 Installation Complete](installation-complete.png) +![Ubuntu-24.04 Installation Complete](../advanced-deployment-options/wsl-ubuntu/installation-complete.png) ## Step 3 Once you see the user account logged in as shown in the above screenshot, you can follow the Gaia CLI installation steps from [here](https://docs.gaianet.ai/getting-started/quick-start/#installing-the-node). -![Gaia CLI Installation](gaia-cli-installation.png) -![Gaia CLI Installation Complete](cli-installation.png) -![Gaianet Init](gaianet-init.png) -![Gaianet Start](gaianet-start.png) +![Gaia CLI Installation](./cli/gaia-cli-installation.png) +![Gaia CLI Installation Complete](./cli/cli-installation.png) +![Gaianet Init](./gaia/gaianet-init.png) +![Gaianet Start](./gaia/gaianet-start.png) > That's it! Gaia now runs on your Windows machine! diff --git a/docs/getting-started/advanced-deployment-options/installation-complete.png b/docs/getting-started/advanced-deployment-options/wsl-ubuntu/installation-complete.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/installation-complete.png rename to docs/getting-started/advanced-deployment-options/wsl-ubuntu/installation-complete.png diff --git a/docs/getting-started/advanced-deployment-options/launching-ubuntu.png b/docs/getting-started/advanced-deployment-options/wsl-ubuntu/launching-ubuntu.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/launching-ubuntu.png rename to docs/getting-started/advanced-deployment-options/wsl-ubuntu/launching-ubuntu.png diff --git a/docs/getting-started/advanced-deployment-options/wsl-install-ubuntu.png b/docs/getting-started/advanced-deployment-options/wsl-ubuntu/wsl-install-ubuntu.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/wsl-install-ubuntu.png rename to docs/getting-started/advanced-deployment-options/wsl-ubuntu/wsl-install-ubuntu.png diff --git a/docs/getting-started/advanced-deployment-options/wsl-installer.png b/docs/getting-started/advanced-deployment-options/wsl-ubuntu/wsl-installer.png similarity index 100% rename from docs/getting-started/advanced-deployment-options/wsl-installer.png rename to docs/getting-started/advanced-deployment-options/wsl-ubuntu/wsl-installer.png diff --git a/docs/getting-started/api-key-created.png b/docs/getting-started/api/api-key-created.png similarity index 100% rename from docs/getting-started/api-key-created.png rename to docs/getting-started/api/api-key-created.png diff --git a/docs/getting-started/create-api-key.png b/docs/getting-started/api/create-api-key.png similarity index 100% rename from docs/getting-started/create-api-key.png rename to docs/getting-started/api/create-api-key.png diff --git a/docs/getting-started/authentication.md b/docs/getting-started/authentication/authentication.md similarity index 81% rename from docs/getting-started/authentication.md rename to docs/getting-started/authentication/authentication.md index b53cd808..2079cc01 100644 --- a/docs/getting-started/authentication.md +++ b/docs/getting-started/authentication/authentication.md @@ -10,11 +10,11 @@ We're introducing API keys for authentication. You can create API keys by follow 2. Click **CONNECT** and connect your Metamask Wallet 3. After connecting your wallet, click on the profile drop down and then click **Setting** -![](settings-for-api.png) +![](../settings-for-api/settings-for-api.png) 4. Under **Setting**, click on **Gaia API Keys** and then **Create API Key** -![](settings-for-api-keys.png) +![](../settings-for-api/settings-for-api-keys.png) 5. Give your API Key a name and click **Create** @@ -24,9 +24,9 @@ Remember that your API key is a secret! Do not share it with others or expose it ::: -![](create-api-key.png) +![](../api/create-api-key.png) -![](api-key-created.png) +![](../api/api-key-created.png) :::tip Tip @@ -40,4 +40,4 @@ Your API Key is like a password and helps verify your usage. This will be one of Currently, we don't charge anything for usage or API key creation. However, it is highly recommended that you start using and updating your existing applications or new ones with your own API keys to avoid any disruption in the future. -Please refer to the [API Reference](../getting-started/api-reference) page for the updated examples with the API keys usage. +Please refer to the [API Reference](../../getting-started/api-reference.md) page for the updated examples with the API keys usage. diff --git a/docs/getting-started/chat_button.png b/docs/getting-started/chat_button/chat_button.png similarity index 100% rename from docs/getting-started/chat_button.png rename to docs/getting-started/chat_button/chat_button.png diff --git a/docs/getting-started/cli-options.md b/docs/getting-started/cli-options/cli-options.md similarity index 100% rename from docs/getting-started/cli-options.md rename to docs/getting-started/cli-options/cli-options.md diff --git a/docs/getting-started/customize.md b/docs/getting-started/customize/customize.md similarity index 93% rename from docs/getting-started/customize.md rename to docs/getting-started/customize/customize.md index 51f6136f..7b8f4ad0 100644 --- a/docs/getting-started/customize.md +++ b/docs/getting-started/customize/customize.md @@ -4,7 +4,7 @@ sidebar_position: 4 # Customizing Your Gaia Node -A key goal of the Gaia project is to enable each individual to create and run his or her own agent service node using finetuned LLMs and proprietary knowledge. In all likelihood, you are not going to run a node with the [default](quick-start) Llama 3.2 LLM and Paris guidebook knowledge base. +A key goal of the Gaia project is to enable each individual to create and run his or her own agent service node using finetuned LLMs and proprietary knowledge. In all likelihood, you are not going to run a node with the [default](../quick-start) Llama 3.2 LLM and Paris guidebook knowledge base. In this chapter, we will discuss ways to customize your node. @@ -59,7 +59,7 @@ gaianet config \ > The llama 3 8B model requires at least 16GB of RAM. -If none of the published finetuned models are perfect for your use case, you can also finetune your own LLM by following [these guides](../tutorial/llamacpp). Your Gaia node can run your own finetuned models. +If none of the published finetuned models are perfect for your use case, you can also finetune your own LLM by following [these guides](../../tutorial/llamacpp). Your Gaia node can run your own finetuned models. > The `--chat-url` argument could point to a local file under `$HOME/gaianet` instead of a public URL. That allows you to use a privately trained or finetuned LLM model file. @@ -67,7 +67,7 @@ If none of the published finetuned models are perfect for your use case, you can A key feature of Gaia is that users can create and deploy proprietary knowledge base on the node to supplement the LLM. Each knowledge base is a snapshot file for a vector collection. -We encourage you to [create your own knowledge base](../knowledge-bases/how-to). But you can also use +We encourage you to [create your own knowledge base](../../knowledge-bases/how-to). But you can also use ready-made knowledge bases. You will need to do the following. * specify the URL to the vector collection (i.e., the `snapshot` or `snapshot.tar.gz` file) in the `snapshot` option. @@ -130,8 +130,8 @@ gaianet start Next, you can -* [Create a knowledge base](../knowledge-bases/how-to) from your proprietary knowledge or skills. -* [Finetune](../tutorial/llamacpp) your own LLM. +* [Create a knowledge base](../../knowledge-bases/how-to) from your proprietary knowledge or skills. +* [Finetune](../../tutorial/llamacpp) your own LLM. Have fun! diff --git a/docs/getting-started/disable_autoMemoryReclaim_wsl.png b/docs/getting-started/disable-automemory/disable_autoMemoryReclaim_wsl.png similarity index 100% rename from docs/getting-started/disable_autoMemoryReclaim_wsl.png rename to docs/getting-started/disable-automemory/disable_autoMemoryReclaim_wsl.png diff --git a/docs/getting-started/gaia-protocol copy.png b/docs/getting-started/gaia-protocol/gaia-protocol copy.png similarity index 100% rename from docs/getting-started/gaia-protocol copy.png rename to docs/getting-started/gaia-protocol/gaia-protocol copy.png diff --git a/docs/getting-started/gaia-protocol.png b/docs/getting-started/gaia-protocol/gaia-protocol.png similarity index 100% rename from docs/getting-started/gaia-protocol.png rename to docs/getting-started/gaia-protocol/gaia-protocol.png diff --git a/docs/getting-started/install.md b/docs/getting-started/install/install.md similarity index 100% rename from docs/getting-started/install.md rename to docs/getting-started/install/install.md diff --git a/docs/getting-started/mynode.md b/docs/getting-started/mynode/mynode.md similarity index 59% rename from docs/getting-started/mynode.md rename to docs/getting-started/mynode/mynode.md index a838f0c5..8bad68a1 100644 --- a/docs/getting-started/mynode.md +++ b/docs/getting-started/mynode/mynode.md @@ -4,7 +4,7 @@ sidebar_position: 3 # Using your Gaia Node -When you [start a Gaia node](quick-start), or you find a node on the web, you could use it as a +When you [start a Gaia node](../quick-start/quick-start.md), or you find a node on the web, you could use it as a web-based chatbot UI and an OpenAI compatible web service. Just load the node's public URL in the browser to open its dashboard. Let's say the URL is as follows. @@ -12,18 +12,18 @@ Let's say the URL is as follows. https://0x1234...xyz.gaia.domains/ ``` -> Please refer to the [agent apps](../agent-integrations/intro) section to see how to use the Gaia node API in your favorite agent frameworks or apps. +> Please refer to the [agent apps](../../agent-integrations/intro) section to see how to use the Gaia node API in your favorite agent frameworks or apps. ## Web-based chatbot On the Gaia node dashboard, you will see a "Chat with this node" button. -![](chat_button.png) +![](../chat_button/chat_button.png) ## OpenAI API replacement -The Gaia node is a drop-in replacement for OpenAI API in [agent and LLM apps](../agent-integrations/intro). +The Gaia node is a drop-in replacement for OpenAI API in [agent and LLM apps](../../agent-integrations/intro). On the Gaia node dashboard, you will see a table that shows how to replace OpenAI parameters in those apps. -![](openai_api_options.png) +![](../openai/openai_api_options.png) diff --git a/docs/getting-started/node-register.png b/docs/getting-started/mynode/node-register.png similarity index 100% rename from docs/getting-started/node-register.png rename to docs/getting-started/mynode/node-register.png diff --git a/docs/getting-started/what-is-a-node.md b/docs/getting-started/mynode/what-is-a-node.md similarity index 98% rename from docs/getting-started/what-is-a-node.md rename to docs/getting-started/mynode/what-is-a-node.md index f84f852d..aef0b6d5 100644 --- a/docs/getting-started/what-is-a-node.md +++ b/docs/getting-started/mynode/what-is-a-node.md @@ -31,4 +31,4 @@ The Gaia node API service is fully compatible with the OpenAI JSON spec, and hen The Gaia protocol connects and incentivizes Gaia nodes and domains to form a coherent network of web services for AI agents. It provides a mechanism to discover, connect to, and pay for Gaia node services through a decentralized marketplace. It also incentivizes domains to manage node agents through a staking program. Furthermore, the Gaia protocol connects model creators (i.e., people who have skills to finetune models) and knowledge providers to node operators through a marketplace. -![Gaia Protocol](./gaia-protocol.png) \ No newline at end of file +![Gaia Protocol](../gaia-protocol/gaia-protocol.png) \ No newline at end of file diff --git a/docs/getting-started/openai_api_options.png b/docs/getting-started/openai/openai_api_options.png similarity index 100% rename from docs/getting-started/openai_api_options.png rename to docs/getting-started/openai/openai_api_options.png diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start/quick-start.md similarity index 90% rename from docs/getting-started/quick-start.md rename to docs/getting-started/quick-start/quick-start.md index 5e61a9ac..774e8b10 100644 --- a/docs/getting-started/quick-start.md +++ b/docs/getting-started/quick-start/quick-start.md @@ -14,7 +14,7 @@ Before you get started, ensure that you have the following on your system: | Ubuntu Linux 20.04 with Nvidia CUDA 12 SDK | 8GB VRAM on GPU | | Azure/AWS | Nvidia T4 GPU Instance | -Learn more about [system requirements](system-requirements). +Learn more about [system requirements](../system-requirements/). **For Windows Users: Important Note on WSL (Windows Subsystem for Linux)** If you are using a Windows system, you **must** have [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install) installed and configured with an Ubuntu distribution. The installation commands for the Gaia node are Linux-based and require a Linux environment to run, which WSL provides on Windows. @@ -61,13 +61,13 @@ gaianet start ## Next steps -- [Customize](customize.md) your node. Here are some knowledge bases you can try by customizing your node: +- [Customize](../customize) your node. Here are some knowledge bases you can try by customizing your node: - [Rust](https://huggingface.co/datasets/gaianet/learn-rust) - [Solidity](https://huggingface.co/datasets/harishkotra/solidity) - [Paris](https://huggingface.co/datasets/gaianet/paris) - [Vyper Lang Developer Docs](https://huggingface.co/datasets/meowy-ai/vyper-lang) - [Monad Developer Docs](https://huggingface.co/datasets/harishkotra/monad-docs) - [Web3 Knowledge Base](https://huggingface.co/datasets/meowy-ai/web3-knowledge-base) -- [Join the Gaia Protocol](register.md) and join the Gaia protocol network to receive payments. -- [Ensure Node Reliability](advanced-deployment-options/protect.md) the node server to ensure stable service. +- [Join the Gaia Protocol](../register) and join the Gaia protocol network to receive payments. +- [Ensure Node Reliability](../advanced-deployment-options/protect.md) the node server to ensure stable service. diff --git a/docs/getting-started/quick-start.png b/docs/getting-started/quick-start/quick-start.png similarity index 100% rename from docs/getting-started/quick-start.png rename to docs/getting-started/quick-start/quick-start.png diff --git a/docs/getting-started/register-01.png b/docs/getting-started/register/register-01.png similarity index 100% rename from docs/getting-started/register-01.png rename to docs/getting-started/register/register-01.png diff --git a/docs/getting-started/register.md b/docs/getting-started/register/register.md similarity index 99% rename from docs/getting-started/register.md rename to docs/getting-started/register/register.md index a54c44b0..60f60f17 100644 --- a/docs/getting-started/register.md +++ b/docs/getting-started/register/register.md @@ -27,7 +27,7 @@ To receive rewards, bind your node and device IDs with a Metamask account using 3. Hover on your profile and click **"Setting"** and click **"Nodes."** 4. Click **"Connect new node"** and enter your node and device IDs in the boxes. 5. Click **"Join"** -![](node-register.png) +![](../mynode/node-register.png) After your node has successfully joined the network, it will be displayed in the list of nodes on the Node Page. diff --git a/docs/getting-started/settings-for-api-keys.png b/docs/getting-started/settings-for-api/settings-for-api-keys.png similarity index 100% rename from docs/getting-started/settings-for-api-keys.png rename to docs/getting-started/settings-for-api/settings-for-api-keys.png diff --git a/docs/getting-started/settings-for-api.png b/docs/getting-started/settings-for-api/settings-for-api.png similarity index 100% rename from docs/getting-started/settings-for-api.png rename to docs/getting-started/settings-for-api/settings-for-api.png diff --git a/docs/getting-started/system-requirements.md b/docs/getting-started/system-requirements/system-requirements.md similarity index 92% rename from docs/getting-started/system-requirements.md rename to docs/getting-started/system-requirements/system-requirements.md index a2b685ab..822e0c85 100644 --- a/docs/getting-started/system-requirements.md +++ b/docs/getting-started/system-requirements/system-requirements.md @@ -9,7 +9,7 @@ You can install the Gaia on a wide variety of devices and operating systems with * Mac desktop or server computers (i.e., iMac, Mini, Studio or Pro) with Apple Silicon (M1 to M4), and at least 16GB of RAM (32GB or more recommended). * Ubuntu Linux 22.04 server with NVIDIA CUDA 12 SDK installed. At least 8GB of VRAM on the GPU is required (24GB or more recommended). On AWS and Azure, that means GPU instances with at least the Nvidia T4 GPU installed. -> Check out our [tutorial](advanced-deployment-options/cuda) on how to install the NVIDIA driver and the CUDA toolkit on a Ubuntu 22.04 machine. +> Check out our [tutorial](../advanced-deployment-options/cuda) on how to install the NVIDIA driver and the CUDA toolkit on a Ubuntu 22.04 machine. If you are hosting the node in your home or office, it needs access to the public Internet to join the Gaia network. diff --git a/docs/getting-started/troubleshooting-01.png b/docs/getting-started/troubleshooting/troubleshooting-01.png similarity index 100% rename from docs/getting-started/troubleshooting-01.png rename to docs/getting-started/troubleshooting/troubleshooting-01.png diff --git a/docs/getting-started/troubleshooting.md b/docs/getting-started/troubleshooting/troubleshooting.md similarity index 99% rename from docs/getting-started/troubleshooting.md rename to docs/getting-started/troubleshooting/troubleshooting.md index 02e7dbfe..e11d470c 100644 --- a/docs/getting-started/troubleshooting.md +++ b/docs/getting-started/troubleshooting/troubleshooting.md @@ -42,7 +42,7 @@ The solution is to disable the `autoMemoryReclaim` feature in WSL. Step to turn 1. Edit `C:\Users.wslconfig` 2. Remove or comment out `autoMemoryReclaim` in `[experimental]` section. -![](disable_autoMemoryReclaim_wsl.png) +![](../disable-automemory/disable_autoMemoryReclaim_wsl.png) Thanks to [RoggeOhta](https://github.com/RoggeOhta) for discovering this. You can learn more about it [here](https://github.com/GaiaNet-AI/gaianet-node/issues/46). diff --git a/docs/knowledge-bases/how-to/csv.md b/docs/knowledge-bases/how-to/csv/csv.md similarity index 92% rename from docs/knowledge-bases/how-to/csv.md rename to docs/knowledge-bases/how-to/csv/csv.md index 043355cf..965933cd 100644 --- a/docs/knowledge-bases/how-to/csv.md +++ b/docs/knowledge-bases/how-to/csv/csv.md @@ -10,7 +10,7 @@ In this section, we will discuss how to create a vector collection snapshot for * The long-form source text is difficult to search. The second column is a "search-friendly" summary of the source text. It could contain a list of questions that can be answered by the first column source text. We will create a vector snapshot where each vector is computed from the summary text (second column), but the retrieved source text for that vector is from the first column. -The snapshot file can then be [loaded by a Gaia node as its knowledge base](../../getting-started/customize#select-a-knowledge-base). +The snapshot file can then be [loaded by a Gaia node as its knowledge base](../../../getting-started/customize#select-a-knowledge-base). > We have a simple Python script to build properly formatted CSV files from a set of articles or chapters. [See how it works](https://github.com/GaiaNet-AI/embedding-tools/tree/main/csv_embed#create-a-csv-file). @@ -33,7 +33,7 @@ The embedding model is a special kind of LLM that turns sentences into vectors. ## Start a vector database By default, we use Qdrant as the vector database. You can start a Qdrant instance -by [starting a Gaia node with a knowledge snapshot](../../getting-started/quick-start). +by [starting a Gaia node with a knowledge snapshot](../../../getting-started/quick-start). :::note Or, you can start a Qdrant server using Docker. The following command starts it in the background. @@ -120,9 +120,9 @@ We also recommend you to compress the snapshot file. tar czvf my.snapshot.tar.gz my.snapshot ``` -Finally, upload the `my.snapshot.tar.gz` file to Huggingface so that the [Gaia node can download and use it](../../getting-started/customize#select-a-knowledge-base). +Finally, upload the `my.snapshot.tar.gz` file to Huggingface so that the [Gaia node can download and use it](../../../getting-started/customize#select-a-knowledge-base). ## Next steps -* [Start](../../getting-started/quick-start) a new Gaia node -* [Customize](../../getting-started/customize) the Gaia node +* [Start](../../../getting-started/quick-start) a new Gaia node +* [Customize](../../../getting-started/customize) the Gaia node diff --git a/docs/knowledge-bases/how-to/firecrawl-01.png b/docs/knowledge-bases/how-to/firecrawl/firecrawl-01.png similarity index 100% rename from docs/knowledge-bases/how-to/firecrawl-01.png rename to docs/knowledge-bases/how-to/firecrawl/firecrawl-01.png diff --git a/docs/knowledge-bases/how-to/firecrawl.md b/docs/knowledge-bases/how-to/firecrawl/firecrawl.md similarity index 88% rename from docs/knowledge-bases/how-to/firecrawl.md rename to docs/knowledge-bases/how-to/firecrawl/firecrawl.md index 5df8af73..36f21acb 100644 --- a/docs/knowledge-bases/how-to/firecrawl.md +++ b/docs/knowledge-bases/how-to/firecrawl/firecrawl.md @@ -4,7 +4,7 @@ sidebar_position: 12 # Knowledge base from a URL -In this section, we will discuss how to create a vector collection snapshot from a Web URL. First, we will parse the URL to a structured markdown file. Then, we will follow the steps from [Knowledge base from a markdown file](markdown.md) to create embedding for your URL. +In this section, we will discuss how to create a vector collection snapshot from a Web URL. First, we will parse the URL to a structured markdown file. Then, we will follow the steps from [Knowledge base from a markdown file](../markdown/markdown.md) to create embedding for your URL. ## Parse the URL content to a markdown file @@ -45,4 +45,4 @@ The output markdown file will be located in this folder named `output.md`. ## Create embeddings from the markdown files -Please follow the tutorial [Knowledge base from a markdown file](markdown.md) to convert your markdown file to a snapshot of embeddings that can be imported into a GaiaNet node. +Please follow the tutorial [Knowledge base from a markdown file](../markdown/markdown.md) to convert your markdown file to a snapshot of embeddings that can be imported into a GaiaNet node. diff --git a/docs/knowledge-bases/how-to/markdown.md b/docs/knowledge-bases/how-to/markdown/markdown.md similarity index 92% rename from docs/knowledge-bases/how-to/markdown.md rename to docs/knowledge-bases/how-to/markdown/markdown.md index ef131385..851afb96 100644 --- a/docs/knowledge-bases/how-to/markdown.md +++ b/docs/knowledge-bases/how-to/markdown/markdown.md @@ -4,7 +4,7 @@ sidebar_position: 4 # Knowledge base from a markdown file -In this section, we will discuss how to create a vector collection snapshot from a markdown file. The snapshot file can then be [loaded by a Gaia node as its knowledge base](../../getting-started/customize#select-a-knowledge-base). +In this section, we will discuss how to create a vector collection snapshot from a markdown file. The snapshot file can then be [loaded by a Gaia node as its knowledge base](../../../getting-started/customize#select-a-knowledge-base). The markdown file is segmented into multiple sections by headings. [See an example](https://huggingface.co/datasets/gaianet/paris/raw/main/paris.md). Each section is turned into a vector, and when retrieved, added to the prompt context for the LLM. @@ -27,7 +27,7 @@ The embedding model is a special kind of LLM that turns sentences into vectors. ## Start a vector database By default, we use Qdrant as the vector database. You can start a Qdrant instance -by [starting a Gaia node with a knowledge snapshot](../../getting-started/quick-start). +by [starting a Gaia node with a knowledge snapshot](../../../getting-started/quick-start). :::note Or, you can start a Qdrant server using Docker. The following command starts it in the background. @@ -114,7 +114,7 @@ We also recommend you to compress the snapshot file. tar czvf my.snapshot.tar.gz my.snapshot ``` -Finally, upload the `my.snapshot.tar.gz` file to Huggingface so that the [Gaia node can download and use it](../../getting-started/customize#select-a-knowledge-base). +Finally, upload the `my.snapshot.tar.gz` file to Huggingface so that the [Gaia node can download and use it](../../../getting-started/customize#select-a-knowledge-base). ## Video Guide @@ -122,5 +122,5 @@ Finally, upload the `my.snapshot.tar.gz` file to Huggingface so that the [Gaia n ## Next steps -* [Start](../../getting-started/quick-start) a new Gaia node -* [Customize](../../getting-started/customize) the Gaia node \ No newline at end of file +* [Start](../../../getting-started/quick-start) a new Gaia node +* [Customize](../../../getting-started/customize) the Gaia node \ No newline at end of file diff --git a/docs/knowledge-bases/how-to/pdf.md b/docs/knowledge-bases/how-to/pdf/pdf.md similarity index 87% rename from docs/knowledge-bases/how-to/pdf.md rename to docs/knowledge-bases/how-to/pdf/pdf.md index 7ba96259..ecd1050f 100644 --- a/docs/knowledge-bases/how-to/pdf.md +++ b/docs/knowledge-bases/how-to/pdf/pdf.md @@ -4,7 +4,7 @@ sidebar_position: 11 # Knowledge base from a PDF file -In this section, we will discuss how to create a vector collection snapshot from a PDF file. First, we will parse the unstructured PDF file to a structured markdown file. Then, we will follow the steps from [Knowledge base from a markdown file](markdown.md) to create embedding for your PDF files. +In this section, we will discuss how to create a vector collection snapshot from a PDF file. First, we will parse the unstructured PDF file to a structured markdown file. Then, we will follow the steps from [Knowledge base from a markdown file](../markdown/markdown.md) to create embedding for your PDF files. ## Tools to convert a PDF file to a markdown file @@ -61,4 +61,4 @@ The output markdown files called `output.md` will be located in your root direct ## Create embeddings from the markdown files -Please follow the tutorial [Knowledge base from a markdown file](markdown.md) to convert your markdown file to a snapshot of embeddings that can be imported into a GaiaNet node. +Please follow the tutorial [Knowledge base from a markdown file](../markdown/markdown.md) to convert your markdown file to a snapshot of embeddings that can be imported into a GaiaNet node. diff --git a/docs/knowledge-bases/how-to/text.md b/docs/knowledge-bases/how-to/text/text.md similarity index 93% rename from docs/knowledge-bases/how-to/text.md rename to docs/knowledge-bases/how-to/text/text.md index a8240611..5cf67775 100644 --- a/docs/knowledge-bases/how-to/text.md +++ b/docs/knowledge-bases/how-to/text/text.md @@ -5,7 +5,7 @@ sidebar_position: 3 # Knowledge base from a plain text file In this section, we will discuss how to create a vector collection snapshot from a plain text file. The -snapshot file can then be [loaded by a Gaia node as its knowledge base](../../getting-started/customize#select-a-knowledge-base). +snapshot file can then be [loaded by a Gaia node as its knowledge base](../../../getting-started/customize#select-a-knowledge-base). The text file is segmented into multiple chunks by blank lines. [See an example](https://huggingface.co/datasets/gaianet/paris/raw/main/paris_chunks.txt). Each chunk is turned into a vector, and when retrieved, added to the prompt context for the LLM. @@ -29,7 +29,7 @@ The embedding model is a special kind of LLM that turns sentences into vectors. ## Start a vector database By default, we use Qdrant as the vector database. You can start a Qdrant instance -by [starting a Gaia node with a knowledge snapshot](../../getting-started/quick-start). +by [starting a Gaia node with a knowledge snapshot](../../../getting-started/quick-start). :::note Or, you can start a Qdrant server using Docker. The following command starts it in the background. @@ -117,7 +117,7 @@ We also recommend you to compress the snapshot file. tar czvf my.snapshot.tar.gz my.snapshot ``` -Finally, upload the `my.snapshot.tar.gz` file to Huggingface so that the [Gaia node can download and use it](../../getting-started/customize#select-a-knowledge-base). +Finally, upload the `my.snapshot.tar.gz` file to Huggingface so that the [Gaia node can download and use it](../../../getting-started/customize#select-a-knowledge-base). ## Video Guide @@ -125,5 +125,5 @@ Finally, upload the `my.snapshot.tar.gz` file to Huggingface so that the [Gaia n ## Next steps -* [Start](../../getting-started/quick-start) a new Gaia node -* [Customize](../../getting-started/customize) the Gaia node \ No newline at end of file +* [Start](../../../getting-started/quick-start) a new Gaia node +* [Customize](../../../getting-started/customize) the Gaia node \ No newline at end of file diff --git a/docs/knowledge-bases/how-to/web-tool.md b/docs/knowledge-bases/how-to/web-tool/web-tool.md similarity index 93% rename from docs/knowledge-bases/how-to/web-tool.md rename to docs/knowledge-bases/how-to/web-tool/web-tool.md index b8d450ec..57aa8076 100644 --- a/docs/knowledge-bases/how-to/web-tool.md +++ b/docs/knowledge-bases/how-to/web-tool/web-tool.md @@ -27,5 +27,5 @@ Blockchain software is like any other software. The first of its kind was Bitcoi Once you have the chunked knowledge base in either `.txt` or `.md` formats, you can follow our tutorials to convert into a Qdrant vector database snapshot: -- [Text to embeddings](/docs/knowledge-bases/how-to/text.md) -- [Markdown to embeddings](/docs/knowledge-bases/how-to/markdown.md) \ No newline at end of file +- [Text to embeddings](../text/text.md) +- [Markdown to embeddings](../markdown/markdown.md) \ No newline at end of file diff --git a/docs/knowledge-bases/how-to/web_tool_input.png b/docs/knowledge-bases/how-to/web-tool/web_tool_input.png similarity index 100% rename from docs/knowledge-bases/how-to/web_tool_input.png rename to docs/knowledge-bases/how-to/web-tool/web_tool_input.png diff --git a/docs/litepaper.md b/docs/litepaper/litepaper.md similarity index 98% rename from docs/litepaper.md rename to docs/litepaper/litepaper.md index e8eb76b9..c3b100f9 100644 --- a/docs/litepaper.md +++ b/docs/litepaper/litepaper.md @@ -25,7 +25,7 @@ Agents are software applications that can complete tasks on its own autonomously * to answer “politically incorrect” questions (e.g., to analyze CVE exploits for an agent in the security domain). * and to answer requests in a specific style (e.g., to mimic a person). -![What is a GaiaNet agent](gaianet_agent.png) +![What is a GaiaNet agent](../gaianet/gaianet_agent.png) Agents are complex software that require significant amount of engineering and resources. Today, most agents are close-source and hosted on SaaS-based LLMs. Popular examples include GPTs and Microsoft/GitHub copilots on OpenAI LLMs, and Duet on Google’s Gemini LLMs. @@ -43,7 +43,7 @@ In this paper, we propose a decentralized software platform and protocol network As of April 2024, there are over 6000 open-source LLMs published on Hugging face. Compared with close-source LLMs, such as GPT-4, open-source LLMs offer advantages in privacy, cost, and systematic bias. Even with general QA performance, open-source LLMs are closing the gap with close-source counterparties quickly. -![Open vs close source LLMs](closed_vs_open.jpg) +![Open vs close source LLMs](../closed_vs_open/closed_vs_open.jpg) For AI agent use cases, it has been demonstrated that smaller but task-specific LLMs often outperform larger general models. @@ -57,7 +57,7 @@ The GaiaNet project provides a cross-platform and highly efficient SDK and runti The basic operational unit in the GaiaNet network is a node. A GaiaNet node is a streamlined software stack that allows any technically competent person to run an AI agent of his own. The software stack on the GaiaNet node consists of the following 7 key components. -![GaiaNet node architecture](gaianet_node.png) +![GaiaNet node architecture](../gaianet/gaianet_node.png) **1 Application runtime.** GaiaNet applications run in a lightweight, secure and high-performance sandbox called WasmEdge. As an open-source project managed by the Linux Foundation and CNCF, WasmEdge runtime works seamlessly with leading cloud native tools such as Docker, containerd, CRI-O, Podman and Kubernetes. It is also the virtual machine of choice by leading public blockchains to securely and efficiently execute on-chain and off-chain smart contracts. @@ -140,7 +140,7 @@ Those challenges have given rise to the GaiaNet domain, which forms the basis of * Getting paid by users. * Pay nodes for their services. -![GaiaNet network architecture](gaianet_eco.png) +![GaiaNet network architecture](../gaianet/gaianet_eco.png) Each GaiaNet node has an unique node ID in the form of an ETH address. The private key associated with the ETH address is stored on the node. Once a node is successfully registered with a domain, it is entitled to receive payments from both service revenue and network awards from the domain. The domain could send payments directly to the node's ETH address. Or, the domain could provide a mechanism for a node operator to register multiple nodes under a single Metamask address, such as signing a challenge phrase using the node private keys. In that case, the node operator will receive aggregated payments in his Metamask account for all associated nodes. diff --git a/docs/node-operators.md b/docs/nodes/node-operators.md similarity index 52% rename from docs/node-operators.md rename to docs/nodes/node-operators.md index 612f3246..502a6819 100644 --- a/docs/node-operators.md +++ b/docs/nodes/node-operators.md @@ -8,45 +8,45 @@ Node Operators focus on setting up, running, and maintaining Gaia nodes without Running a GaiaNet node allows you to participate in the decentralized AI network and potentially earn rewards. The process is straightforward and can be completed in just a few minutes. -Before you begin, ensure your system meets these [minimum requirements](./getting-started/system-requirements) +Before you begin, ensure your system meets these [minimum requirements](../getting-started/system-requirements) Here you'll find everything you need to get started with running and managing your Gaia node. ## Getting Started Learn how to get started with your first GaiaNet node. -[Learn More →](/getting-started/what-is-a-node) +[Learn More →](../getting-started/mynode/what-is-a-node.md) ## Node Setup & Authentication Step-by-step guide for node installation, setup, and security. -- [Setting up your own node](/getting-started/quick-start) -- [Authentication guide](/getting-started/authentication) +- [Setting up your own node](../getting-started/quick-start) +- [Authentication guide](../getting-started/authentication) ## Node Operations Learn about day-to-day operations and customization. -- [Using your Gaia Node](/getting-started/mynode) -- [Customizing Your Gaia Node](/getting-started/customize) +- [Using your Gaia Node](../getting-started/mynode) +- [Customizing Your Gaia Node](../getting-started/customize) ## Network & Protocol Join the network and start earning rewards. -- [Gaia CLI options](/getting-started/cli-options) -- [Joining the Gaia Protocol](/getting-started/register) +- [Gaia CLI options](../getting-started/cli-options) +- [Joining the Gaia Protocol](../getting-started/register) ## System Requirements & Troubleshooting Make sure your system is ready and get help when needed. -- [System requirements](/getting-started/system-requirements) -- [Troubleshooting guide](/getting-started/troubleshooting) +- [System requirements](../getting-started/system-requirements) +- [Troubleshooting guide](../getting-started/troubleshooting) ## Advanced Deployment Options Learn about different deployment options. -- [Install or Uninstall the CLI](/getting-started/install) -- [Install multiple nodes](/getting-started/advanced-deployment-options/multiple) -- [Run a local-only node](/getting-started/advanced-deployment-options/local) -- [Protect the server process](/getting-started/advanced-deployment-options/protect) \ No newline at end of file +- [Install or Uninstall the CLI](../getting-started/install) +- [Install multiple nodes](../getting-started/advanced-deployment-options/multiple) +- [Run a local-only node](../getting-started/advanced-deployment-options/local) +- [Protect the server process](../getting-started/advanced-deployment-options/protect) diff --git a/docs/nodes.md b/docs/nodes/nodes.md similarity index 70% rename from docs/nodes.md rename to docs/nodes/nodes.md index 0803e4c3..edead1f5 100644 --- a/docs/nodes.md +++ b/docs/nodes/nodes.md @@ -5,7 +5,7 @@ sidebar_position: 6 # 🌐 Public Gaia Domain Each Gaia node provides a web-based chatbot UI and an OpenAI compatible web service. -Here are some popular nodes. Please refer to the [agent apps](./agent-integrations/intro) section to see how +Here are some popular nodes. Please refer to the [agent apps](../agent-integrations/intro) section to see how to use the Gaia API in your favorite agent frameworks or apps. Gaia nodes are organized into Gaia domains to provide public services. Each domain has a single API endpoint that load-balances across multiple nodes to ensure service availability. @@ -17,13 +17,13 @@ Below are some Gaia domains we offer developers for free. **However, you must ap ### Voice-to-text: Whisper v2 large This domain runs Whisper v2 Large agent nodes for voice to text transcription and translation. -Replace OpenAI configuration in [your app](./agent-integrations/intro) with the following. +Replace OpenAI configuration in [your app](../agent-integrations/intro) with the following. |Config option | Value | |-----|--------| | API endpoint URL | https://whisper.gaia.domains/v1 | | Model Name | whisper | -| API key | [Get your API Key here](/docs/getting-started/authentication.md) | +| API key | [Get your API Key here](../getting-started/authentication/authentication.md) | ### Text-to-image: Realistic vision @@ -39,28 +39,28 @@ Coming soon! A general coding agent running a STOA coder LLM. It is a highly capable but slow model. -[Chat with it](https://coder.gaia.domains/chatbot-ui/index.html) or use it from an IDE tool, such as [Cursor AI](./agent-integrations/cursor) or [Zed](./agent-integrations/zed). -Replace OpenAI configuration in [your app](./agent-integrations/intro) with the following. +[Chat with it](https://coder.gaia.domains/chatbot-ui/index.html) or use it from an IDE tool, such as [Cursor AI](../agent-integrations/cursor/cursor.md) or [Zed](../agent-integrations/zed/zed.md). +Replace OpenAI configuration in [your app](../agent-integrations/intro.md) with the following. |Config option | Value | |-----|--------| | API endpoint URL | https://coder.gaia.domains/v1 | | Model Name (for LLM) | coder | | Model Name (for Text embedding) | nomic-embed | -| API key | [Get your API Key here](/docs/getting-started/authentication.md) | +| API key | [Get your API Key here](../getting-started/authentication/authentication.md) | ### Rust Coder A coding agent supplemented with open-source [Rust content](https://huggingface.co/datasets/gaianet/learn-rust) from the Rust Foundation and published books. -[Chat with it](https://rustcoder.gaia.domains/chatbot-ui/index.html) or use it from an IDE tool, such as [Cursor AI](./agent-integrations/cursor) or [Zed](./agent-integrations/zed). -Replace OpenAI configuration in [your app](./agent-integrations/intro) with the following. +[Chat with it](https://rustcoder.gaia.domains/chatbot-ui/index.html) or use it from an IDE tool, such as [Cursor AI](../agent-integrations/cursor/cursor.md) or [Zed](../agent-integrations/zed/zed.md). +Replace OpenAI configuration in [your app](../agent-integrations/intro) with the following. |Config option | Value | |-----|--------| | API endpoint URL | https://rustcoder.gaia.domains/v1 | | Model Name (for LLM) | rustcoder | | Model Name (for Text embedding) | nomic-embed | -| API key | [Get your API Key here](/docs/getting-started/authentication.md) | +| API key | [Get your API Key here](../getting-started/authentication/authentication.md) | ## Alternative LLM domains @@ -82,26 +82,26 @@ This domain runs plain Llama 3.2 3b agent nodes without any additional knowledge ### Qwen 7b The Qwen 7b LLM is great for non-English tasks such as translation. -[Chat with it](https://qwen7b.gaia.domains/chatbot-ui/index.html) or use it from another app. Replace OpenAI configuration in [your app](./agent-integrations/intro) with the following. +[Chat with it](https://qwen7b.gaia.domains/chatbot-ui/index.html) or use it from another app. Replace OpenAI configuration in [your app](../agent-integrations/intro) with the following. |Config option | Value | |-----|--------| | API endpoint URL | https://qwen7b.gaia.domains/v1 | | Model Name (for LLM) | qwen7b | | Model Name (for Text embedding) | nomic-embed | -| API key | [Get your API Key here](/docs/getting-started/authentication.md) | +| API key | [Get your API Key here](../getting-started/authentication/authentication.md) | ### Qwen 72b The Qwen 72b LLM is a top open source LLM. It is very capable but could also be slow. It is capable of tool / function calling. -[Learn more](../tutorial/tool-call) how to use tool call models in your agent app. -[Chat with it](https://qwen72b.gaia.domains/chatbot-ui/index.html) or use it from another app. Replace OpenAI configuration in [your app](./agent-integrations/intro) with the following. +[Learn more](../tutorial/tool-call/tool-call.md) how to use tool call models in your agent app. +[Chat with it](https://qwen72b.gaia.domains/chatbot-ui/index.html) or use it from another app. Replace OpenAI configuration in [your app](../agent-integrations/intro) with the following. |Config option | Value | |-----|--------| | API endpoint URL | https://qwen72b.gaia.domains/v1 | | Model Name (for LLM) | qwen72b | | Model Name (for Text embedding) | nomic-embed | -| API key | [Get your API Key here](/docs/getting-started/authentication.md) | +| API key | [Get your API Key here](../getting-started/authentication/authentication.md) | diff --git a/docs/templates-and-examples/examples/base-token-generator.md b/docs/templates-and-examples/examples/base-token-generator/base-token-generator.md similarity index 100% rename from docs/templates-and-examples/examples/base-token-generator.md rename to docs/templates-and-examples/examples/base-token-generator/base-token-generator.md diff --git a/docs/templates-and-examples/examples/cdp-image.png b/docs/templates-and-examples/examples/cdp/cdp-image.png similarity index 100% rename from docs/templates-and-examples/examples/cdp-image.png rename to docs/templates-and-examples/examples/cdp/cdp-image.png diff --git a/docs/templates-and-examples/examples/celo-token-generator.md b/docs/templates-and-examples/examples/celo-token-generator/celo-token-generator.md similarity index 100% rename from docs/templates-and-examples/examples/celo-token-generator.md rename to docs/templates-and-examples/examples/celo-token-generator/celo-token-generator.md diff --git a/docs/templates-and-examples/examples/coinbase-agentkit-starter.md b/docs/templates-and-examples/examples/coinbase-agentkit-starter/coinbase-agentkit-starter.md similarity index 99% rename from docs/templates-and-examples/examples/coinbase-agentkit-starter.md rename to docs/templates-and-examples/examples/coinbase-agentkit-starter/coinbase-agentkit-starter.md index f933efc5..30e04700 100644 --- a/docs/templates-and-examples/examples/coinbase-agentkit-starter.md +++ b/docs/templates-and-examples/examples/coinbase-agentkit-starter/coinbase-agentkit-starter.md @@ -10,7 +10,7 @@ This template shows an onchain agent powered by Coinbase's AgentKit with the Nex AgentKit handles these interactions by using a Gaia node for Large Language Model (LLM) inferencing. -![cdp-image](./cdp-image.png) +![cdp-image](../cdp/cdp-image.png) ## Features diff --git a/docs/templates-and-examples/examples/dynamic-rag.md b/docs/templates-and-examples/examples/dynamic-rag/dynamic-rag.md similarity index 100% rename from docs/templates-and-examples/examples/dynamic-rag.md rename to docs/templates-and-examples/examples/dynamic-rag/dynamic-rag.md diff --git a/docs/templates-and-examples/examples/gaia-dtk-2.gif b/docs/templates-and-examples/examples/gaia-supavec/gaia-dtk-2.gif similarity index 100% rename from docs/templates-and-examples/examples/gaia-dtk-2.gif rename to docs/templates-and-examples/examples/gaia-supavec/gaia-dtk-2.gif diff --git a/docs/templates-and-examples/examples/gaia-supavec.md b/docs/templates-and-examples/examples/gaia-supavec/gaia-supavec.md similarity index 100% rename from docs/templates-and-examples/examples/gaia-supavec.md rename to docs/templates-and-examples/examples/gaia-supavec/gaia-supavec.md diff --git a/docs/templates-and-examples/examples/metamask-gaia-starter.md b/docs/templates-and-examples/examples/metamask-gaia-starter/metamask-gaia-starter.md similarity index 99% rename from docs/templates-and-examples/examples/metamask-gaia-starter.md rename to docs/templates-and-examples/examples/metamask-gaia-starter/metamask-gaia-starter.md index ff67b1b9..64a04e76 100644 --- a/docs/templates-and-examples/examples/metamask-gaia-starter.md +++ b/docs/templates-and-examples/examples/metamask-gaia-starter/metamask-gaia-starter.md @@ -8,7 +8,7 @@ sidebar_position: 1 The MetaMask Gaia DTK Starter is a powerful Next.js template that seamlessly integrates Gaia's advanced capabilities with MetaMask's Develegation Toolkit (DTK). This project allows developers to build sophisticated blockchain applications with AI-enhanced functionalities while leveraging MetaMask's secure wallet infrastructure. -![Gaia Delegation Toolkit Gif](./gaia-dtk-2.gif) +![Gaia Delegation Toolkit Gif](../gaia-supavec/gaia-dtk-2.gif) The starter includes a full ERC20 token creation system through an integrated factory contract, allowing users to deploy custom tokens directly through the application. Combined with AI-powered interactions, this creates a powerful platform for building next-generation decentralized applications. diff --git a/docs/templates-and-examples/examples/nubila.md b/docs/templates-and-examples/examples/nubila/nubila.md similarity index 100% rename from docs/templates-and-examples/examples/nubila.md rename to docs/templates-and-examples/examples/nubila/nubila.md diff --git a/docs/templates-and-examples/examples/pdf-rag-1.png b/docs/templates-and-examples/examples/pdf-rag/pdf-rag-1.png similarity index 100% rename from docs/templates-and-examples/examples/pdf-rag-1.png rename to docs/templates-and-examples/examples/pdf-rag/pdf-rag-1.png diff --git a/docs/templates-and-examples/examples/pdf-rag-2.png b/docs/templates-and-examples/examples/pdf-rag/pdf-rag-2.png similarity index 100% rename from docs/templates-and-examples/examples/pdf-rag-2.png rename to docs/templates-and-examples/examples/pdf-rag/pdf-rag-2.png diff --git a/docs/templates-and-examples/examples/pdf-rag-3.png b/docs/templates-and-examples/examples/pdf-rag/pdf-rag-3.png similarity index 100% rename from docs/templates-and-examples/examples/pdf-rag-3.png rename to docs/templates-and-examples/examples/pdf-rag/pdf-rag-3.png diff --git a/docs/templates-and-examples/examples/pdf-rag-4.png b/docs/templates-and-examples/examples/pdf-rag/pdf-rag-4.png similarity index 100% rename from docs/templates-and-examples/examples/pdf-rag-4.png rename to docs/templates-and-examples/examples/pdf-rag/pdf-rag-4.png diff --git a/docs/templates-and-examples/examples/pdf-rag-5.png b/docs/templates-and-examples/examples/pdf-rag/pdf-rag-5.png similarity index 100% rename from docs/templates-and-examples/examples/pdf-rag-5.png rename to docs/templates-and-examples/examples/pdf-rag/pdf-rag-5.png diff --git a/docs/templates-and-examples/examples/pdf-rag-6.png b/docs/templates-and-examples/examples/pdf-rag/pdf-rag-6.png similarity index 100% rename from docs/templates-and-examples/examples/pdf-rag-6.png rename to docs/templates-and-examples/examples/pdf-rag/pdf-rag-6.png diff --git a/docs/templates-and-examples/examples/pdf-rag.md b/docs/templates-and-examples/examples/pdf-rag/pdf-rag.md similarity index 100% rename from docs/templates-and-examples/examples/pdf-rag.md rename to docs/templates-and-examples/examples/pdf-rag/pdf-rag.md diff --git a/docs/templates-and-examples/examples/story-weaver.md b/docs/templates-and-examples/examples/story-weaver/story-weaver.md similarity index 100% rename from docs/templates-and-examples/examples/story-weaver.md rename to docs/templates-and-examples/examples/story-weaver/story-weaver.md diff --git a/docs/templates-and-examples/examples/zerion-tool-call.md b/docs/templates-and-examples/examples/zerion-tool-call/zerion-tool-call.md similarity index 100% rename from docs/templates-and-examples/examples/zerion-tool-call.md rename to docs/templates-and-examples/examples/zerion-tool-call/zerion-tool-call.md diff --git a/docs/templates-and-examples/templates/ai-voting.gif b/docs/templates-and-examples/templates/ai-voting/ai-voting.gif similarity index 100% rename from docs/templates-and-examples/templates/ai-voting.gif rename to docs/templates-and-examples/templates/ai-voting/ai-voting.gif diff --git a/docs/templates-and-examples/templates/chatbot-widget.md b/docs/templates-and-examples/templates/chatbot-widget/chatbot-widget.md similarity index 100% rename from docs/templates-and-examples/templates/chatbot-widget.md rename to docs/templates-and-examples/templates/chatbot-widget/chatbot-widget.md diff --git a/docs/templates-and-examples/templates/developer-docs-ai-agent.md b/docs/templates-and-examples/templates/developer-docs-ai-agent/developer-docs-ai-agent.md similarity index 100% rename from docs/templates-and-examples/templates/developer-docs-ai-agent.md rename to docs/templates-and-examples/templates/developer-docs-ai-agent/developer-docs-ai-agent.md diff --git a/docs/templates-and-examples/templates/gaia-web3-voting-starter.md b/docs/templates-and-examples/templates/gaia-web3-voting-starter/gaia-web3-voting-starter.md similarity index 99% rename from docs/templates-and-examples/templates/gaia-web3-voting-starter.md rename to docs/templates-and-examples/templates/gaia-web3-voting-starter/gaia-web3-voting-starter.md index 39a02b2c..335eb83e 100644 --- a/docs/templates-and-examples/templates/gaia-web3-voting-starter.md +++ b/docs/templates-and-examples/templates/gaia-web3-voting-starter/gaia-web3-voting-starter.md @@ -6,7 +6,7 @@ sidebar_position: 2 # Gaia Web3 Voting Starter -![Gaia AI Voting](./ai-voting.gif) +![Gaia AI Voting](../ai-voting//ai-voting.gif) A decentralized voting application built with Next.js, Hardhat, and [Gaia](https://docs.gaianet.ai/intro/). You can create voting situation and select the choices you want to vote and vote it with the AI Agent. diff --git a/docs/templates-and-examples/templates/notion-gaia-assistant.md b/docs/templates-and-examples/templates/notion-gaia-assistant/notion-gaia-assistant.md similarity index 100% rename from docs/templates-and-examples/templates/notion-gaia-assistant.md rename to docs/templates-and-examples/templates/notion-gaia-assistant/notion-gaia-assistant.md diff --git a/docs/tutorial/coinbase.md b/docs/tutorial/coinbase/coinbase.md similarity index 98% rename from docs/tutorial/coinbase.md rename to docs/tutorial/coinbase/coinbase.md index dad6e8fc..ce5da080 100644 --- a/docs/tutorial/coinbase.md +++ b/docs/tutorial/coinbase/coinbase.md @@ -5,7 +5,7 @@ sidebar_position: 3 # Working with Coinbase AgentKit You can use a Gaia node to power the [Coinbase AgentKit](https://github.com/coinbase/agentkit). -The Gaia node must run an LLM that is optimized for [tool calling](tool-call.md). +The Gaia node must run an LLM that is optimized for [tool calling](../tool-call/tool-call.md). Or, you could simply use our public Gaia domain as follows. | Attribute | Value | diff --git a/docs/tutorial/concepts.md b/docs/tutorial/concepts/concepts.md similarity index 95% rename from docs/tutorial/concepts.md rename to docs/tutorial/concepts/concepts.md index 2638a504..446b91b1 100644 --- a/docs/tutorial/concepts.md +++ b/docs/tutorial/concepts/concepts.md @@ -18,7 +18,7 @@ A Gaia node is an OpenAI compatible LLM service that is grounded by long-term kn > For example, if you ask ChatGPT the question What is Layer 2, the answer is that Layer 2 is a concept from the computer network. However, if you ask a blockchain person, they answer that Layer 2 is a way to scale the original Ethereum network. That's the difference between a generic LLM and knowledge-supplemented LLMs. -We will cover the external knowledge preparation and how a knowledge-supplemented LLM completes a conversation. If you have learned how a RAG application works, go to [Build a RAG application with Gaia](../knowledge-bases/how-to/web-tool) to start building one. +We will cover the external knowledge preparation and how a knowledge-supplemented LLM completes a conversation. If you have learned how a RAG application works, go to [Build a RAG application with Gaia](../../knowledge-bases/how-to/web-tool) to start building one. 1. Create embeddings for your own knowledge as the long-term memory. 2. Lifecycle of a user query on a knowledge-supplemented LLM. @@ -42,7 +42,7 @@ After chunking the document, we can convert these chunks into embeddings leverag Additionally, we will need a vector DB to store the embeddings so that we can retrieve these embeddings quickly at any time. -On a Gaia node, we will get a database snapshot with the embeddings to use at last. Check out how to create your embeddings [from a plain text file](../knowledge-bases/how-to/text), and [from a markdown file](../knowledge-bases/how-to/markdown). +On a Gaia node, we will get a database snapshot with the embeddings to use at last. Check out how to create your embeddings [from a plain text file](../../knowledge-bases/how-to/text), and [from a markdown file](../../knowledge-bases/how-to/markdown). ## Lifecycle of a user query on a knowledge-supplemented LLM diff --git a/docs/tutorial/cursor-settings.png b/docs/tutorial/cursor/cursor-settings.png similarity index 100% rename from docs/tutorial/cursor-settings.png rename to docs/tutorial/cursor/cursor-settings.png diff --git a/docs/tutorial/deepseek-cursor.md b/docs/tutorial/deepseek-cursor/deepseek-cursor.md similarity index 93% rename from docs/tutorial/deepseek-cursor.md rename to docs/tutorial/deepseek-cursor/deepseek-cursor.md index 930407a3..c50230b0 100644 --- a/docs/tutorial/deepseek-cursor.md +++ b/docs/tutorial/deepseek-cursor/deepseek-cursor.md @@ -57,18 +57,18 @@ We start the DeepSeek R1 model with an 8k context window by default. If your mac 1. Open Cursor settings -![Cursor Settings](cursor-settings.png) +![Cursor Settings](../cursor/cursor-settings.png) 2. Locate the LLM Backend configuration -![LLM Backend configuration](model-config.png) +![LLM Backend configuration](../model-config/model-config.png) 3. Configure the following: - Base API URL: Your Gaia node HTTPS URL - Model Name: `DeepSeek-R1-Distill-Llama-8B` - - API Key: Make sure to replace `YOUR_API_KEY_GOES_HERE` with your **own API key**. To get your own API key, follow [this](../getting-started/authentication) tutorial. + - API Key: Make sure to replace `YOUR_API_KEY_GOES_HERE` with your **own API key**. To get your own API key, follow [this](../../getting-started/authentication) tutorial. -![DeepSeek-R1 Setup](deepseek-setup.png) +![DeepSeek-R1 Setup](../deepseek-cursor/deepseek-setup.png) ## Technical Details diff --git a/docs/tutorial/deepseek-setup.png b/docs/tutorial/deepseek-cursor/deepseek-setup.png similarity index 100% rename from docs/tutorial/deepseek-setup.png rename to docs/tutorial/deepseek-cursor/deepseek-setup.png diff --git a/docs/tutorial/eliza.md b/docs/tutorial/eliza/eliza.md similarity index 100% rename from docs/tutorial/eliza.md rename to docs/tutorial/eliza/eliza.md diff --git a/docs/tutorial/llamacpp.md b/docs/tutorial/llamacpp/llamacpp.md similarity index 100% rename from docs/tutorial/llamacpp.md rename to docs/tutorial/llamacpp/llamacpp.md diff --git a/docs/tutorial/model-config.png b/docs/tutorial/model-config/model-config.png similarity index 100% rename from docs/tutorial/model-config.png rename to docs/tutorial/model-config/model-config.png diff --git a/docs/tutorial/prompt-engineering-tool.md b/docs/tutorial/prompt-engineering-tool/prompt-engineering-tool.md similarity index 100% rename from docs/tutorial/prompt-engineering-tool.md rename to docs/tutorial/prompt-engineering-tool/prompt-engineering-tool.md diff --git a/docs/tutorial/tool-call.md b/docs/tutorial/tool-call/tool-call.md similarity index 87% rename from docs/tutorial/tool-call.md rename to docs/tutorial/tool-call/tool-call.md index c9060501..6d1c9ed9 100644 --- a/docs/tutorial/tool-call.md +++ b/docs/tutorial/tool-call/tool-call.md @@ -15,8 +15,8 @@ In this tutorial, we will show you a simple Python program that allows a local L You will need a Gaia node ready to provide LLM services through a public URL. You can -* [run your own node](../getting-started/quick-start). You will need to start a Gaia node for the [Llama 3.3 70B model](https://github.com/GaiaNet-AI/node-configs/tree/main/llama-3.3-70b-instruct) or the [Llama 3.1 8B model](https://github.com/GaiaNet-AI/node-configs/tree/main/llama-3.1-8b-instruct) or the [Llama 3 Groq 8B model](https://github.com/GaiaNet-AI/node-configs/tree/main/llama-3-groq-8b-tool). You can then use the node's API URL endpoint and model name in your tool call apps. -* [use a public node](../nodes) +* [run your own node](../../getting-started/quick-start). You will need to start a Gaia node for the [Llama 3.3 70B model](https://github.com/GaiaNet-AI/node-configs/tree/main/llama-3.3-70b-instruct) or the [Llama 3.1 8B model](https://github.com/GaiaNet-AI/node-configs/tree/main/llama-3.1-8b-instruct) or the [Llama 3 Groq 8B model](https://github.com/GaiaNet-AI/node-configs/tree/main/llama-3-groq-8b-tool). You can then use the node's API URL endpoint and model name in your tool call apps. +* [use a public node](../../nodes) In this tutorial, we will use a public Llama 3.3 node with the function call support. diff --git a/docs/tutorial/translator-agent.md b/docs/tutorial/translator-agent/translator-agent.md similarity index 98% rename from docs/tutorial/translator-agent.md rename to docs/tutorial/translator-agent/translator-agent.md index 199bbc19..86d51b1e 100644 --- a/docs/tutorial/translator-agent.md +++ b/docs/tutorial/translator-agent/translator-agent.md @@ -23,7 +23,7 @@ cd translation-agent git checkout use_llamaedge ``` -Next, we will install a local Gaia node, which provides the backend API services required by the agent. You can, of course, use [Gaia nodes from the community](../nodes) if you do not want to start your own. +Next, we will install a local Gaia node, which provides the backend API services required by the agent. You can, of course, use [Gaia nodes from the community](../../nodes) if you do not want to start your own. ``` curl -sSfL 'https://github.com/GaiaNet-AI/gaianet-node/releases/latest/download/install.sh' | bash @@ -39,7 +39,7 @@ export OPENAI_API_KEY="GAIANET" pip install python-dotenv pip install openai tiktoken icecream langchain_text_splitters ``` -> If you're using a Domain service, you will [need to get an API key from Gaia](../getting-started/authentication.md). +> If you're using a Domain service, you will [need to get an API key from Gaia](../../getting-started/authentication). ## Demo 1: Running Translation Agents with Llama-3-8B diff --git a/docusaurus.config.js b/docusaurus.config.js index f638400d..4bb869ab 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -60,20 +60,20 @@ const config = { { from: '/user-guide/apps/anything_llm', to: '/agent-integrations/anything_llm' }, { from: '/user-guide/apps/cursor', to: '/agent-integrations/cursor' }, { from: '/user-guide/apps/stockbot', to: '/agent-integrations/stockbot' }, - { from: '/user-guide/apps/flowiseai', to: '/agent-integrations/flowiseai' }, - { from: '/user-guide/apps/flowiseai-tool-call', to: '/agent-integrations/flowiseai-tool-call' }, + { from: '/user-guide/apps/flowiseai', to: '/agent-integrations/flowise/flowiseai' }, + { from: '/user-guide/apps/flowiseai-tool-call', to: '/agent-integrations/flowise/flowiseai-tool-call' }, { from: '/user-guide/apps/lobechat', to: '/agent-integrations/lobechat' }, - { from: '/user-guide/apps/llamaparse', to: '/agent-integrations/llamaparse' }, + { from: '/user-guide/apps/llamaparse', to: '/agent-integrations/llama/llamaparse' }, { from: '/user-guide/apps/zed', to: '/agent-integrations/zed' }, { from: '/user-guide/apps/obsidian', to: '/agent-integrations/obsidian' }, { from: '/user-guide/apps/codegpt', to: '/agent-integrations/codegpt' }, { from: '/user-guide/apps/continue', to: '/agent-integrations/continue' }, - { from: '/user-guide/apps/llamacoder', to: '/agent-integrations/llamacoder' }, + { from: '/user-guide/apps/llamacoder', to: '/agent-integrations/llama/llamacoder' }, { from: '/user-guide/apps/agent-zero', to: '/agent-integrations/agent-zero' }, { from: '/user-guide/apps/translation-agent', to: '/agent-integrations/translation-agent' }, { from: '/user-guide/apps/gpt-planner', to: '/agent-integrations/gpt-planner' }, - { from: '/user-guide/apps/llamaedge-book', to: '/agent-integrations/llamaedgebook' }, - { from: '/user-guide/apps/llamatutor', to: '/agent-integrations/llamatutor' }, + { from: '/user-guide/apps/llamaedge-book', to: '/agent-integrations/llama/llamaedgebook' }, + { from: '/user-guide/apps/llamatutor', to: '/agent-integrations/llama/llamatutor' }, { from: '/user-guide/api-reference', to: '/getting-started/api-reference' }, { from: '/category/node-operator-guide', to: '/getting-started' }, { from: '/node-guide/quick-start', to: '/getting-started/quick-start' }, diff --git a/versioned_docs/version-1.0.0/creator-guide/knowledge/concepts.md b/versioned_docs/version-1.0.0/creator-guide/knowledge/concepts.md index 4fce2f60..b24ba594 100644 --- a/versioned_docs/version-1.0.0/creator-guide/knowledge/concepts.md +++ b/versioned_docs/version-1.0.0/creator-guide/knowledge/concepts.md @@ -21,7 +21,7 @@ domain or background. > For example, if you ask ChatGPT the question What is Layer 2, the answer is that Layer 2 is a concept from the computer network. However, if you ask a blockchain person, they answer that Layer 2 is a way to scale the original Ethereum network. That's the difference between a generic LLM and knowledge-supplemented LLMs. -We will cover the external knowledge preparation and how a knowledge-supplemented LLM completes a conversation. If you have learned how a RAG application works, go to [Build a RAG application with Gaia](/docs/getting-started/quick-start.md) to start building one. +We will cover the external knowledge preparation and how a knowledge-supplemented LLM completes a conversation. If you have learned how a RAG application works, go to [Build a RAG application with Gaia](/docs/getting-started/quick-start/quick-start.md) to start building one. 1. Create embeddings for your own knowledge as the long-term memory. 2. Lifecycle of a user query on a knowledge-supplemented LLM.