Files
google--adk-python/README.md
T
Yuktha Gangadhari 225fafc6d5 docs: add beginner explanation for single agent example
Merge https://github.com/google/adk-python/pull/4099

### Description of the change

**Problem:**
New users may find it unclear what an “agent” represents in ADK before encountering the first code example in the README.

**Solution:**
Added a short beginner-friendly explanation before the single-agent example to clarify what an ADK agent is and what the example demonstrates. This improves readability and onboarding without changing any existing behavior or code.

---

### Testing Plan

This change is documentation-only and does not affect runtime behavior. No tests were required or run.

---

### Checklist

- [x] I have read the CONTRIBUTING.md document.
- [x] I have performed a self-review of my own change.
- [ ] I have commented my code, particularly in hard-to-understand areas. (Not applicable – documentation only)
- [ ] I have added tests that prove my fix is effective or that my feature works. (Not applicable – documentation only)
- [ ] New and existing unit tests pass locally with my changes. (Not applicable – documentation only)
- [ ] I have manually tested my changes end-to-end. (Not applicable – documentation only)
- [ ] Any dependent changes have been merged and published in downstream modules. (Not applicable)

---

### Additional context

This change is intended to improve the onboarding experience for users exploring ADK for the first time.

Co-authored-by: Shangjie Chen <deanchen@google.com>
COPYBARA_INTEGRATE_REVIEW=https://github.com/google/adk-python/pull/4099 from yukthagangadhari5:docs-beginner-note ec2e677812d6d7f73afc777c43c229b63c7b7d02
PiperOrigin-RevId: 932731929
2026-06-15 16:29:45 -07:00

3.8 KiB

Agent Development Kit (ADK) 2.0

License PyPI version Python versions PyPI downloads Unit Tests Docs

An open-source, code-first Python framework for building, evaluating, and deploying sophisticated AI agents with flexibility and control.


⚠️ BREAKING CHANGES FROM 1.x

This release includes breaking changes to the agent API, event model, and session schema. Sessions generated by ADK 2.0 are readable by ADK 1.28+ (extra fields will be ignored), but are incompatible with older 1.x versions.


🔥 What's New in 2.0

  • Workflow Runtime: A graph-based execution engine for composing deterministic execution flows for agentic apps, with support for routing, fan-out/fan-in, loops, retry, state management, dynamic nodes, human-in-the-loop, and nested workflows.

  • Task API: Structured agent-to-agent delegation with multi-turn task mode, single-turn controlled output, mixed delegation patterns, human-in-the-loop, and task agents as workflow nodes.

🚀 Installation

pip install google-adk

Requirements: Python 3.10+.

To install optional integrations, you can use the following command:

pip install "google-adk[extensions]"

The release cadence is roughly bi-weekly.

Quick Start

Beginner Note: ADK applications are built using two main classes: Agent (defines an AI's instructions, tools, and behavior) and Workflow (orchestrates agents and tasks in a graph-based flow).

Agent

from google.adk import Agent

root_agent = Agent(
    name="greeting_agent",
    model="gemini-2.5-flash",
    instruction="You are a helpful assistant. Greet the user warmly.",
)

Workflow

from google.adk import Agent, Workflow

generate_fruit_agent = Agent(
    name="generate_fruit_agent",
    instruction="Return the name of a random fruit. Return only the name.",
)

generate_benefit_agent = Agent(
    name="generate_benefit_agent",
    instruction="Tell me a health benefit about the specified fruit.",
)

root_agent = Workflow(
    name="root_agent",
    edges=[("START", generate_fruit_agent, generate_benefit_agent)],
)

Run Locally

# Interactive CLI
adk run path/to/my_agent

# Web UI (supports multi-agent directories or pointing directly to a single agent folder)
adk web path/to/agents_dir

📚 Documentation

🤝 Contributing

See CONTRIBUTING.md for details.

📄 License

This project is licensed under the Apache 2.0 License — see the LICENSE file for details.