versionhq 1.1.12.2__tar.gz → 1.1.12.4__tar.gz

versionhq-1.1.12.4/.github/workflows/deploy_docs.yml

@@ -0,0 +1,38 @@
+name: Deploy Docs
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Setup cache
+        run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+        uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+
+      - name: Install Requirements
+        run: |
+          pip install mkdocs-material mkdocs-material-extensions pillow
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+
+      - name: Build and deploy MkDocs
+        run: mkdocs gh-deploy --force

{versionhq-1.1.12.2 → versionhq-1.1.12.4}/.gitignore

@@ -5,6 +5,9 @@ entity_memory.py
 
 train.py
 
+# mkdocs.yml
+# docs/
+
 dist/
 lib/
 build/
@@ -20,6 +23,7 @@ temp/*
 .vscode/*
 assets/*
 memo.txt
+site/
 
 __pycache__
 .ruff_cache/

{versionhq-1.1.12.2 → versionhq-1.1.12.4}/.pre-commit-config.yaml

@@ -41,3 +41,4 @@ repos:
   rev: v2.2.0
   hooks:
     - id: doctoc
+      files: README.md

versionhq-1.1.12.4/CNAME

@@ -0,0 +1 @@
+docs.versi0n.io

{versionhq-1.1.12.2 → versionhq-1.1.12.4}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.2
 Name: versionhq
-Version: 1.1.12.2
-Summary: Agentic orchestration framework for task automation
+Version: 1.1.12.4
+Summary: An agentic orchestration framework for multi-agent system that shares memory, knowledge base, and RAG tools.
 Author-email: Kuriko Iwai <kuriko@versi0n.io>
 License: MIT License
         
@@ -26,7 +26,7 @@ License: MIT License
         SOFTWARE.
         
 Project-URL: Homepage, https://versi0n.io
-Project-URL: Documentation, https://chief-oxygen-8a2.notion.site/Documentation-17e923685cf98001a5fad5c4b2acd79b?pvs=73
+Project-URL: Documentation, https://docs.versi0n.io
 Project-URL: Repository, https://github.com/versionHQ/multi-agent-system
 Project-URL: Issues, https://github.com/versionHQ/multi-agent-system/issues
 Keywords: orchestration framework,orchestration,ai agent,multi-agent system,RAG,agent,agentic orchestration,llm
@@ -91,7 +91,7 @@ Agentic orchestration framework to deploy agent network and handle complex task
 - [PyPI](https://pypi.org/project/versionhq/)
 - [Github (LLM orchestration framework)](https://github.com/versionHQ/multi-agent-system)
 - [Use case](https://versi0n.io/) / [Quick demo](https://res.cloudinary.com/dfeirxlea/video/upload/v1737732977/pj_m_home/pnsyh5mfvmilwgt0eusa.mov)
-- [Documentation](https://chief-oxygen-8a2.notion.site/Documentation-17e923685cf98001a5fad5c4b2acd79b?pvs=4) *Some components are under review.
+- [Docs](https://docs.versi0n.io)
 
 
 <hr />
@@ -103,13 +103,16 @@ Agentic orchestration framework to deploy agent network and handle complex task
 - [Key Features](#key-features)
   - [Agent formation](#agent-formation)
 - [Quick Start](#quick-start)
-  - [Case 1. Solo Agent:](#case-1-solo-agent)
+  - [Generate agent networks and launch task execution:](#generate-agent-networks-and-launch-task-execution)
+  - [Solo Agent:](#solo-agent)
     - [Return a structured output with a summary in string.](#return-a-structured-output-with-a-summary-in-string)
-  - [Case 2. Supervising:](#case-2-supervising)
+  - [Supervising:](#supervising)
 - [Technologies Used](#technologies-used)
 - [Project Structure](#project-structure)
 - [Setup](#setup)
+- [Set up a project](#set-up-a-project)
 - [Contributing](#contributing)
+  - [Documentation](#documentation)
   - [Customizing AI Agents](#customizing-ai-agents)
   - [Modifying RAG Functionality](#modifying-rag-functionality)
   - [Package Management with uv](#package-management-with-uv)
@@ -123,9 +126,9 @@ Agentic orchestration framework to deploy agent network and handle complex task
 
 ## Key Features
 
-Generate multi-agent systems based on the task complexity, execute tasks, and evaluate output based on the given criteria.
+`versionhq` is a Python framework for agent networks that handle complex task automation without human interaction.
 
-Agents are model-agnostic, and can handle and share RAG tools, knowledge, memory, and callbacks among other agents. (self-learn)
+Agents are model-agnostic, and will improve task output, while oprimizing token cost and job latency, by sharing their memory, knowledge base, and RAG tools with other agents in the network.
 
 
 ###  Agent formation
@@ -137,7 +140,7 @@ You can specify a desired formation or allow the agents to determine it autonomo
 
 |  | **Solo Agent** | **Supervising** | **Network** | **Random** |
 | :--- | :--- | :--- | :--- | :--- |
-| **Formation** | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1737893140/pj_m_agents/tglrxoiuv7kk7nzvpe1z.jpg" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1737893141/pj_m_agents/hxngdvnn5b5qdxo0ayl5.jpg" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1737893142/pj_m_agents/kyc6neg8m6keyizszcpi.jpg" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1737893139/pj_m_agents/hzpchlcpnpwxwaapu1hr.jpg" alt="solo" width="200"> |
+| **Formation** | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1738818211/pj_m_agents/rbgxttfoeqqis1ettlfz.png" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1738818211/pj_m_agents/zhungor3elxzer5dum10.png" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1738818211/pj_m_agents/dnusl7iy7kiwkxwlpmg8.png" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1738818211/pj_m_agents/sndpczatfzbrosxz9ama.png" alt="solo" width="200"> |
 | **Usage** | <ul><li>A single agent with tools, knowledge, and memory.</li><li>When self-learning mode is on - it will turn into **Random** formation.</li></ul> | <ul><li>Leader agent gives directions, while sharing its knowledge and memory.</li><li>Subordinates can be solo agents or networks.</li></ul> | <ul><li>Share tasks, knowledge, and memory among network members.</li></ul> | <ul><li>A single agent handles tasks, asking help from other agents without sharing its memory or knowledge.</li></ul> |
 | **Use case** | An email agent drafts promo message for the given audience. | The leader agent strategizes an outbound campaign plan and assigns components such as media mix or message creation to subordinate agents. | An email agent and social media agent share the product knowledge and deploy multi-channel outbound campaign. | 1. An email agent drafts promo message for the given audience, asking insights on tones from other email agents which oversee other clusters. 2. An agent calls the external agent to deploy the campaign. |
 
@@ -153,8 +156,22 @@ You can specify a desired formation or allow the agents to determine it autonomo
 
 (Python 3.11 or higher)
 
+### Generate agent networks and launch task execution:
 
-### Case 1. Solo Agent:
+   ```
+   from versionhq import form_agent_network
+
+   network = form_agent_network(
+      task="YOUR AMAZING TASK OVERVIEW",
+      expected_outcome="YOUR OUTCOME EXPECTATION",
+   )
+   res = network.launch()
+   ```
+
+   This will form a network with multiple agents on `Formation` and return `TaskOutput` object with output in JSON, plane text, Pydantic model format with evaluation.
+
+
+### Solo Agent:
 
 #### Return a structured output with a summary in string.
 
@@ -197,7 +214,7 @@ This will return `TaskOutput` instance that stores a response in plane text, JSO
    )
    ```
 
-### Case 2. Supervising:
+### Supervising:
 
    ```
    from versionhq import Agent, Task, ResponseField, Team, TeamMember
@@ -291,19 +308,24 @@ src/
 
 ## Setup
 
+
+
+## Set up a project
+
 1. Install `uv` package manager:
 
-   For MacOS:
+      For MacOS:
 
-   ```
-   brew install uv
-   ```
+      ```
+      brew install uv
+      ```
 
-   For Ubuntu/Debian:
+      For Ubuntu/Debian:
+
+      ```
+      sudo apt-get install uv
+      ```
 
-   ```
-   sudo apt-get install uv
-   ```
 
 2. Install dependencies:
    ```
@@ -325,11 +347,11 @@ src/
 3. Set up environment variables:
    Create a `.env` file in the project root and add the following:
    ```
-   OPENAI_API_KEY=your-openai-api-key
    LITELLM_API_KEY=your-litellm-api-key
-   UPSTAGE_API_KEY=your-upstage-api-key
+   OPENAI_API_KEY=your-openai-api-key
    COMPOSIO_API_KEY=your-composio-api-key
    COMPOSIO_CLI_KEY=your-composio-cli-key
+   [LLM_INTERFACE_PROVIDER_OF_YOUR_CHOICE]_API_KEY=your-api-key
    ```
 
 <hr />
@@ -363,16 +385,25 @@ src/
 **Optional**
 * Flag with `#! REFINEME` for any improvements needed and `#! FIXME` for any errors.
 
-* Run a React demo app: [React demo app](https://github.com/versionHQ/test-client-app) to check it on the client endpoint.
+<!-- * Run a React demo app: [React demo app](https://github.com/versionHQ/test-client-app) to check it on the client endpoint.
    ```
    npm i
    npm start
    ```
-   The frontend will be available at `http://localhost:3000`.
+   The frontend will be available at `http://localhost:3000`. -->
 
 * `production` use case is available at `https://versi0n.io`. Currently, we are running alpha test.
 
 
+### Documentation
+* To edit the documentation, see `docs` repository and edit the respective component.
+
+* We use `mkdocs` to update the docs. You can run the doc locally at http://127.0.0.1:8000/:
+
+   ```
+   uv run python3 -m mkdocs serve --clean
+   ```
+
 
 ### Customizing AI Agents
 

{versionhq-1.1.12.2 → versionhq-1.1.12.4}/README.md

@@ -14,7 +14,7 @@ Agentic orchestration framework to deploy agent network and handle complex task
 - [PyPI](https://pypi.org/project/versionhq/)
 - [Github (LLM orchestration framework)](https://github.com/versionHQ/multi-agent-system)
 - [Use case](https://versi0n.io/) / [Quick demo](https://res.cloudinary.com/dfeirxlea/video/upload/v1737732977/pj_m_home/pnsyh5mfvmilwgt0eusa.mov)
-- [Documentation](https://chief-oxygen-8a2.notion.site/Documentation-17e923685cf98001a5fad5c4b2acd79b?pvs=4) *Some components are under review.
+- [Docs](https://docs.versi0n.io)
 
 
 <hr />
@@ -26,13 +26,16 @@ Agentic orchestration framework to deploy agent network and handle complex task
 - [Key Features](#key-features)
   - [Agent formation](#agent-formation)
 - [Quick Start](#quick-start)
-  - [Case 1. Solo Agent:](#case-1-solo-agent)
+  - [Generate agent networks and launch task execution:](#generate-agent-networks-and-launch-task-execution)
+  - [Solo Agent:](#solo-agent)
     - [Return a structured output with a summary in string.](#return-a-structured-output-with-a-summary-in-string)
-  - [Case 2. Supervising:](#case-2-supervising)
+  - [Supervising:](#supervising)
 - [Technologies Used](#technologies-used)
 - [Project Structure](#project-structure)
 - [Setup](#setup)
+- [Set up a project](#set-up-a-project)
 - [Contributing](#contributing)
+  - [Documentation](#documentation)
   - [Customizing AI Agents](#customizing-ai-agents)
   - [Modifying RAG Functionality](#modifying-rag-functionality)
   - [Package Management with uv](#package-management-with-uv)
@@ -46,9 +49,9 @@ Agentic orchestration framework to deploy agent network and handle complex task
 
 ## Key Features
 
-Generate multi-agent systems based on the task complexity, execute tasks, and evaluate output based on the given criteria.
+`versionhq` is a Python framework for agent networks that handle complex task automation without human interaction.
 
-Agents are model-agnostic, and can handle and share RAG tools, knowledge, memory, and callbacks among other agents. (self-learn)
+Agents are model-agnostic, and will improve task output, while oprimizing token cost and job latency, by sharing their memory, knowledge base, and RAG tools with other agents in the network.
 
 
 ###  Agent formation
@@ -60,7 +63,7 @@ You can specify a desired formation or allow the agents to determine it autonomo
 
 |  | **Solo Agent** | **Supervising** | **Network** | **Random** |
 | :--- | :--- | :--- | :--- | :--- |
-| **Formation** | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1737893140/pj_m_agents/tglrxoiuv7kk7nzvpe1z.jpg" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1737893141/pj_m_agents/hxngdvnn5b5qdxo0ayl5.jpg" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1737893142/pj_m_agents/kyc6neg8m6keyizszcpi.jpg" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1737893139/pj_m_agents/hzpchlcpnpwxwaapu1hr.jpg" alt="solo" width="200"> |
+| **Formation** | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1738818211/pj_m_agents/rbgxttfoeqqis1ettlfz.png" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1738818211/pj_m_agents/zhungor3elxzer5dum10.png" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1738818211/pj_m_agents/dnusl7iy7kiwkxwlpmg8.png" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1738818211/pj_m_agents/sndpczatfzbrosxz9ama.png" alt="solo" width="200"> |
 | **Usage** | <ul><li>A single agent with tools, knowledge, and memory.</li><li>When self-learning mode is on - it will turn into **Random** formation.</li></ul> | <ul><li>Leader agent gives directions, while sharing its knowledge and memory.</li><li>Subordinates can be solo agents or networks.</li></ul> | <ul><li>Share tasks, knowledge, and memory among network members.</li></ul> | <ul><li>A single agent handles tasks, asking help from other agents without sharing its memory or knowledge.</li></ul> |
 | **Use case** | An email agent drafts promo message for the given audience. | The leader agent strategizes an outbound campaign plan and assigns components such as media mix or message creation to subordinate agents. | An email agent and social media agent share the product knowledge and deploy multi-channel outbound campaign. | 1. An email agent drafts promo message for the given audience, asking insights on tones from other email agents which oversee other clusters. 2. An agent calls the external agent to deploy the campaign. |
 
@@ -76,8 +79,22 @@ You can specify a desired formation or allow the agents to determine it autonomo
 
 (Python 3.11 or higher)
 
+### Generate agent networks and launch task execution:
 
-### Case 1. Solo Agent:
+   ```
+   from versionhq import form_agent_network
+
+   network = form_agent_network(
+      task="YOUR AMAZING TASK OVERVIEW",
+      expected_outcome="YOUR OUTCOME EXPECTATION",
+   )
+   res = network.launch()
+   ```
+
+   This will form a network with multiple agents on `Formation` and return `TaskOutput` object with output in JSON, plane text, Pydantic model format with evaluation.
+
+
+### Solo Agent:
 
 #### Return a structured output with a summary in string.
 
@@ -120,7 +137,7 @@ This will return `TaskOutput` instance that stores a response in plane text, JSO
    )
    ```
 
-### Case 2. Supervising:
+### Supervising:
 
    ```
    from versionhq import Agent, Task, ResponseField, Team, TeamMember
@@ -214,19 +231,24 @@ src/
 
 ## Setup
 
+
+
+## Set up a project
+
 1. Install `uv` package manager:
 
-   For MacOS:
+      For MacOS:
 
-   ```
-   brew install uv
-   ```
+      ```
+      brew install uv
+      ```
 
-   For Ubuntu/Debian:
+      For Ubuntu/Debian:
+
+      ```
+      sudo apt-get install uv
+      ```
 
-   ```
-   sudo apt-get install uv
-   ```
 
 2. Install dependencies:
    ```
@@ -248,11 +270,11 @@ src/
 3. Set up environment variables:
    Create a `.env` file in the project root and add the following:
    ```
-   OPENAI_API_KEY=your-openai-api-key
    LITELLM_API_KEY=your-litellm-api-key
-   UPSTAGE_API_KEY=your-upstage-api-key
+   OPENAI_API_KEY=your-openai-api-key
    COMPOSIO_API_KEY=your-composio-api-key
    COMPOSIO_CLI_KEY=your-composio-cli-key
+   [LLM_INTERFACE_PROVIDER_OF_YOUR_CHOICE]_API_KEY=your-api-key
    ```
 
 <hr />
@@ -286,16 +308,25 @@ src/
 **Optional**
 * Flag with `#! REFINEME` for any improvements needed and `#! FIXME` for any errors.
 
-* Run a React demo app: [React demo app](https://github.com/versionHQ/test-client-app) to check it on the client endpoint.
+<!-- * Run a React demo app: [React demo app](https://github.com/versionHQ/test-client-app) to check it on the client endpoint.
    ```
    npm i
    npm start
    ```
-   The frontend will be available at `http://localhost:3000`.
+   The frontend will be available at `http://localhost:3000`. -->
 
 * `production` use case is available at `https://versi0n.io`. Currently, we are running alpha test.
 
 
+### Documentation
+* To edit the documentation, see `docs` repository and edit the respective component.
+
+* We use `mkdocs` to update the docs. You can run the doc locally at http://127.0.0.1:8000/:
+
+   ```
+   uv run python3 -m mkdocs serve --clean
+   ```
+
 
 ### Customizing AI Agents
 

versionhq-1.1.12.4/docs/CNAME

@@ -0,0 +1 @@
+docs.versi0n.io