From c96a01e43effb2546dd471d65c6ebbf9cba16b02 Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:36:46 +0000 Subject: [PATCH] docs: preserve upstream English README --- README.en.md | 122 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 122 insertions(+) create mode 100644 README.en.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..0eddf28 --- /dev/null +++ b/README.en.md @@ -0,0 +1,122 @@ +# Agent Development Kit (ADK) 2.0 + +[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE) +[![PyPI version](https://img.shields.io/pypi/v/google-adk.svg)](https://pypi.org/project/google-adk/) +[![Python versions](https://img.shields.io/pypi/pyversions/google-adk.svg)](https://pypi.org/project/google-adk/) +[![PyPI downloads](https://static.pepy.tech/badge/google-adk/month)](https://pepy.tech/project/google-adk) +[![Unit Tests](https://github.com/google/adk-python/actions/workflows/python-unit-tests.yml/badge.svg)](https://github.com/google/adk-python/actions/workflows/python-unit-tests.yml) +[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://google.github.io/adk-docs/) + +

+ +

+

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

+

+ Important Links: + Docs, + Samples & + ADK Web. +

+ +______________________________________________________________________ + +> **⚠️ 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 + +```bash +pip install google-adk +``` + +**Requirements:** Python 3.10+. + +To install optional integrations, you can use the following command: + +```bash +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 + +```python +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 + +```python +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 + +```bash +# 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 + +- **Getting Started**: https://google.github.io/adk-docs/ +- **Samples**: See `contributing/workflow_samples/` and + `contributing/task_samples/` for workflow and task API examples. + +## 🤝 Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) for details. + +## 📄 License + +This project is licensed under the Apache 2.0 License — see the +[LICENSE](LICENSE) file for details.