Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/agent-integrations/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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**.

Expand All @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
![](../book/book-03.png)
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
20 changes: 10 additions & 10 deletions docs/getting-started/advanced-deployment-options/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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!
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand All @@ -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

Expand All @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -59,15 +59,15 @@ 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.

### Select a knowledge base

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.
Expand Down Expand Up @@ -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!

Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,26 @@ 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.

```
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)

Original file line number Diff line number Diff line change
Expand Up @@ -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)
![Gaia Protocol](../gaia-protocol/gaia-protocol.png)
Loading