fix: docs

Author: unsafecode

tasks.py

@@ -1,4 +1,4 @@
-from invoke import task, run
+from invoke import task
 
 @task
 def build(c, version: str):
@@ -7,7 +7,7 @@ def build(c, version: str):
 @task
 def test(c, test_path: str = "vanilla_aiagents/tests/", test_case: str = ""):
     test_case_option = f"-k {test_case}" if test_case else ""
-    coverage_option = f"--cov-append" if test_case else ""
+    coverage_option = "--cov-append" if test_case else ""
 
     # Run tests with coverage
     c.run(f"pytest --cov=vanilla_aiagents --cov-report=term-missing --cov-report=html {coverage_option} --cov-config=.coveragerc {test_case_option} {test_path}")
@@ -23,12 +23,10 @@ def build_grpc(c):
     proto_path = "vanilla_aiagents/vanilla_aiagents/remote"
     proto_file = f"{proto_path}/remote.proto"
     c.run(f"python -m grpc_tools.protoc -I{proto_path} --python_out={proto_path} --grpc_python_out={proto_path} {proto_file}")
-    # Replace the import in remote_pb2_grpc.py
-    # c.run("sed -i 's/from vanilla_aiagents.vanilla_aiagents.remote import remote_pb2/from vanilla_aiagents.remote import remote_pb2/' vanilla_aiagents/vanilla_aiagents/remote/remote_pb2_grpc.py")
 
 @task
 def docs(c):
-    c.run("cd vanilla_aiagents && pdoc --output-dir docs -d markdown vanilla_aiagents !vanilla_aiagents.remote.grpc")
+    c.run("cd vanilla_aiagents && pdoc --output-dir docs -d markdown --logo https://raw.githubusercontent.com/Azure-Samples/vanilla-aiagents/main/logo.png vanilla_aiagents !vanilla_aiagents.remote.grpc")
 
 @task
 def check_lint(c):

vanilla_aiagents/README.md

@@ -1,6 +1,6 @@
 # Vanilla AI Agents
 
-Sample package demonstrating how to create a simple agenting application without using any specific framework.
+A library demonstrating how to create a simple agenting application without using any specific framework.
 
 ## Features
 

vanilla_aiagents/vanilla_aiagents/__init__.py

@@ -0,0 +1,121 @@
+"""
+Lightweight library demonstrating how to create a simple agenting application without using any specific framework.
+
+## Table of Contents
+
+- [Features](#features)
+- [Future work](#future-work)
+- [Getting Started](#getting-started)
+- [Demos](#demos)
+- [Testing](#testing)
+- [License](#license)
+- [Contributing](#contributing)
+
+## Features
+
+This project framework provides the following features:
+
+- Multi-agent chat
+- Agent routing (including option to look for available tools to decide)
+- Agent state management
+- Custom stop conditions
+- Interactive or unattended user input
+- Chat resumability
+- Function calling on agents
+- Constrained agent routing
+- Sub-workflows
+- Simple RAG via function calls
+- Image input support
+- Ability to run pre and post steps via Sequence
+- Conversation context "hidden" variables, which are not displayed to the user but agents can read and write to access additional information
+- Usage metrics tracking per conversation, plus internal log for debuggability
+- Multiple strategies for agent to filter conversation messages (All, last N, top K and Last N, summarize, etc..)
+- LLMLingua (`extras` module) support to compress system prompts via strategies
+- LLM support for Structured Output
+- Remoting support ((`remote` module)), allowing agents to be run on a remote server and accessed elsewhere
+  - REST and gRPC channels supported
+  - Default implementation to run hosts with agent discovery and registration
+- Generated Code execution locally and via ACA Dynamic Sessions
+- Streaming support, even over REST or gRPC agents
+
+## Future work
+
+- Plugins
+  - Azure AI Search plugin
+  - DB plugin
+  - API plugin
+- DAPR integration
+- Multi-agent chat with multiple users
+
+## Getting Started
+
+### Prerequisites
+
+Python 3.11 or later is required to run this project.
+
+### Quickstart
+
+```powershell
+git clone https://github.com/Azure-Samples/vanilla-aiagents
+
+cd "vanilla-aiagents"
+
+# Create a virtual environment
+python -m venv .venv
+
+# Activate the virtual environment
+
+# On Windows
+.\.venv\Scripts\activate
+# On Unix or MacOS
+source .venv/bin/activate
+
+# Install the required dependencies
+pip install -r requirements.txt
+
+# Clone .env.sample to .env and update the values
+cp .env.sample .env
+```
+
+Here is a simple example of how to use the framework:
+
+```python
+import os
+from vanilla_aiagents.llm import AzureOpenAILLM
+from vanilla_aiagents.agent import Agent
+from vanilla_aiagents.team import Team
+from vanilla_aiagents.workflow import Workflow
+
+llm = AzureOpenAILLM({
+    "azure_deployment": os.getenv("AZURE_OPENAI_MODEL"),
+    "azure_endpoint": os.getenv("AZURE_OPENAI_ENDPOINT"),
+    "api_key": os.getenv("AZURE_OPENAI_KEY"),
+    "api_version": os.getenv("AZURE_OPENAI_API_VERSION"),
+})
+
+# Initialize agents and team
+sales = Agent(id="sales", llm=llm, description="A sales agent", system_message=\"""
+You are a sales assistant. You provide information about our products and services.
+
+# PRODUCTS
+- Product 1: $100, description
+- Product 2: $200, description
+- Product 3: $300, description
+\""")
+support = Agent(id="support", llm=llm, description="A support agent", system_message=\"""
+You are a support assistant. You provide help with technical issues and account management.
+
+# SUPPORT GUIDELINES
+- For technical issues, please provide the following information: ...
+- For account management, please provide the following information: ...
+\""")
+team = Team(id="team", description="Contoso team", members=[sales, support], llm=llm)
+
+# Create a workflow
+workflow = Workflow(askable=team)
+
+# Run the workflow
+result = workflow.run("Hello, I'd like to know more about your products.")
+print(workflow.conversation.messages)
+```
+"""