Skip to content

Commit 6b4fb13

Browse files
Merge pull request #29 from NapthaAI/fix-contributing
Update docs
2 parents 34b8c6b + 50d0d26 commit 6b4fb13

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+2845
-1420
lines changed

docs/Examples/GenerateImage.md

+1-21
Original file line numberDiff line numberDiff line change
@@ -17,30 +17,10 @@ naptha run tool:generate_image_tool -p "tool_name='generate_image_tool', tool_in
1717
### 2. Run via an Agent
1818
Use the Generate Image Agent which wraps the tool with additional capabilities:
1919
```bash
20-
naptha run agent:generate_image_agent -p "prompt='expansive landscape rolling greens with gargantuan yggdrasil, intricate world-spanning roots towering under a blue alien sky, masterful, ghibli'" --tool_node_urls "http://localhost:7001"
20+
naptha run agent:generate_image_agent -p "prompt='expansive landscape rolling greens with gargantuan yggdrasil, intricate world-spanning roots towering under a blue alien sky, masterful, ghibli'" --tool_nodes "node.naptha.ai"
2121
```
2222

2323
:::tip
2424
Be descriptive in your prompts! The more detailed your description, the better the results.
2525
:::
2626

27-
### 3. Retrieve Your Image
28-
Once generation is complete, you'll receive a folder ID. Use it to retrieve your image:
29-
```bash
30-
naptha read_storage -id <folder_id>
31-
```
32-
33-
Your generated image will be saved as `./files/output.png`
34-
35-
:::note
36-
Keep track of your folder ID - you'll need it if you want to use this image with other Naptha agents!
37-
:::
38-
39-
## Common Issues
40-
- If you haven't set up your Stability API key, you'll be prompted to add it
41-
- Make sure your prompt is specific and descriptive for better results
42-
43-
## Next Steps
44-
:::info
45-
Try transforming your generated image using our [Image-to-Image](/Examples/Image2Image) agent! You can apply different styles and modifications to your creation.
46-
:::

docs/Examples/HelloWorld.md

-13
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,6 @@ naptha run agent:hello_world_agent -p "firstname=sam surname=altman"
3030
This will run on whichever node you've configured as `NODE_URL` in the .env file of the Naptha SDK.
3131
:::
3232

33-
You can also run agents from docker images (if running your own node, make sure the DOCKER_JOBS=True in the config):
34-
35-
```bash
36-
naptha run docker_hello_world -p "docker_image=hello-world"
37-
```
38-
39-
4033
## Expected Output
4134

4235
The agent will respond with a personalized greeting using the provided name parameters.
@@ -62,12 +55,6 @@ export const nextStepsCards = [
6255
icon: '💬',
6356
link: '/Examples/MultiplayerChat'
6457
},
65-
{
66-
title: 'Simple RAG',
67-
description: 'Run our basic RAG setup',
68-
icon: '🔍',
69-
link: '/Examples/SimpleRAG'
70-
},
7158
{
7259
title: 'Join Our Community',
7360
description: 'Connect with other Naptha developers and builders',

docs/Examples/MultiplayerChat.md

+8
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,14 @@ This multi-agent, multi-node workflow is made of the following components, which
1818
| Multi-Agent Chat Orchestrator | Multi-agent chat across a network of multiple nodes. | [GitHub](https://github.com/NapthaAI/multiagent_chat) |
1919
| Simple Chat Agent | Agent for running simple chat with LLMs. | [GitHub](https://github.com/NapthaAI/simple_chat_agent) |
2020

21+
## Create Deployment
22+
23+
You can download and install the modules for an orchestrator without running first using:
24+
25+
```bash
26+
naptha create orchestrator:multiagent_chat --agent_modules "agent:simple_chat_agent,agent:simple_chat_agent" --agent_nodes "node.naptha.ai,node1.naptha.ai" --kb_modules "kb:groupchat_kb" --kb_nodes "node.naptha.ai"
27+
```
28+
2129
## Run
2230

2331
You can run it using the Naptha SDK on hosted nodes using the following command:

docs/Examples/index.md

-12
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,12 @@ export const exampleCards = [
1515
icon: '👋',
1616
link: 'Examples/HelloWorld'
1717
},
18-
{
19-
title: 'BabyAGI',
20-
description: 'Run a true multi-agent BabyAGI implementation',
21-
icon: '🤖',
22-
link: 'Examples/BabyAGI'
23-
},
2418
{
2519
title: 'Generate Image',
2620
description: 'Create AI-generated images from text descriptions',
2721
icon: '🎨',
2822
link: 'Examples/GenerateImage'
2923
},
30-
{
31-
title: 'Image2Image',
32-
description: 'Transform and modify existing images with AI',
33-
icon: '🖼️',
34-
link: 'Examples/Image2Image'
35-
},
3624
{
3725
title: 'Multiplayer Chat',
3826
description: 'Experience multi-agent chat across different nodes',

docs/GettingStarted/Abstractions.md

-114
This file was deleted.

docs/GettingStarted/Architecture.md

+29-21
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,45 @@
1-
# Architecture
1+
# Overview of the Naptha Stack
22

3-
Our tech stack is made of three things:
3+
Open source AI developers and researchers create multi-agent systems face a number of key challenges:
44

5-
* Naptha SDK
6-
* Naptha Nodes
7-
* Naptha Hub
5+
* **Lack of Interoperability:** Agent and multi-agent frameworks built by different groups don’t interoperate. There are few standards for how agent interactions.
6+
* **Open Source Models use a variety of standards:** Format for tool calling and reasoning, and adherence to structured output, vary depending on the model.
87

9-
This architecture is designed with principles of modularity, scalability, and flexibility in mind. Naptha enables distributed multi-agent systems to grow and support a wide range of AI applications.
8+
The Naptha SDK, Naptha Modules and Naptha Hub make it easy to build and discover multi-agent systems with heterogeneous models, architectures and data. Naptha Nodes make it easy to deploy and run multi-agent systems at scale, and across a network of devices.
109

11-
### Naptha SDK
10+
## Naptha Modules
1211

13-
Our toolkit empowers developers to build agentic solutions on the Naptha web, infrastructure for decentralized AI.
12+
Modules are the building blocks of multi-agent systems. They are designed to be framework-agnostic, allowing developers to implement modules using different agent frameworks. There are currently seven types of modules:
1413

15-
The [Naptha SDK](https://github.com/NapthaAI/naptha-sdk) is used for prototyping and running Ai agents and multi-agent workflows. It also contains a CLI for interacting with Naptha Nodes and the Naptha Hub.
14+
* Agents
15+
* Tools
16+
* Knowledge Bases
17+
* Memories
18+
* Personas
19+
* Orchestrators
20+
* Environments
1621

17-
![](/img/naptha-sdk-diagram.png)
22+
You can learn more about each module type in the [Naptha Modules](/docs/NapthaModules/overview) section.
1823

19-
### Naptha Nodes
24+
## Naptha Hub
2025

21-
Nodes are where the code of a decentralized AI application executes, i.e., they manage task execution, user verification, and storage operations. Our network supports both HTTP and WebSocket communication protocols. Nodes can interact both directly and indirectly (routed).
26+
HuggingFace but for agents! The Naptha Hub allows you to discover modules, other builders, and nodes on the network. The URL and other metadata of modules are registered on the Naptha Hub, with the module code stored on GitHub, HuggingFace, IPFS, or DockerHub.
2227

23-
There are two types of nodes in our network:
28+
You can learn more about the Hub in the [Getting Started](/docs/GettingStarted/NapthaHub) section.
2429

25-
* **Orchestrators:** server, task queue, and database
26-
* **Workers:** local LLM and module manager
30+
## Naptha SDK
2731

32+
The [Naptha SDK](https://github.com/NapthaAI/naptha-sdk) is made up of:
2833

29-
:::info
30-
Our [node repository](https://github.com/NapthaAI/node) demonstrates how we build and scale multi-agent systems. While currently private, we plan to open source it in early 2025.
34+
* Abstractions for the composable building blocks of multi-agent apps like Agent, Orchestrator, Tool, Environment, Persona, Knowledge Base, and Memory (i.e. Naptha Modules). With Naptha, communication between these modules happens via API.
35+
* Decorators for easily onboarding modules from agent frameworks like CrewAI (see our [Integrations](/docs/Integrations/CrewAI) section).
36+
* A client for interacting with the Naptha Hub (like the huggingface_hub library but for multi-agent apps)
37+
* A CLI for interacting with the Naptha Hub and Naptha Nodes
3138

32-
Want early access? [Join our Discord](https://naptha.ai/naptha-community).
33-
:::
39+
You can learn more about the SDK in the [Getting Started](/docs/GettingStarted/InstallSDK) section.
3440

35-
### Naptha Hub
41+
## Naptha Nodes
3642

37-
The Hub involves a registry and storage for modules, along with registries for nodes and tasks. This platform handles user authentication and data management, and it provides methods for listing and managing nodes, modules, tasks, and proposals. Also, it leverages SurrealDB for data persistence.
43+
The [Naptha Node](https://github.com/NapthaAI/naptha-node) packages everything that your need to run agents locally, that interact with other agents in the network. It handles everything from local inference, communication servers, local storage, and orchestration.
44+
45+
You can learn more about the Node and how to run one yourself in the [Naptha Nodes](/docs/NapthaNodes/0-quickstart) section.

docs/GettingStarted/InstallNode.md

-48
This file was deleted.

0 commit comments

Comments
 (0)