You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Move ADK above composition framework in 'What Eino provides' list
- Reorder 'Key Features' section to put ADK before Orchestration
- Update both English and Chinese README files consistently
- Adjust intro text to better position ADK as a primary feature
Change-Id: I27b41b8051f45900af63290f3c92711e2120b0fe
Copy file name to clipboardExpand all lines: README.md
+18-11Lines changed: 18 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,8 +18,8 @@ English | [中文](README.zh_CN.md)
18
18
19
19
What Eino provides are:
20
20
- a carefully curated list of **component** abstractions and implementations that can be easily reused and combined to build LLM applications
21
-
- a powerful **composition** framework that does the heavy lifting of strong type checking, stream processing, concurrency management, aspect injection, option assignment, etc. for the user.
22
21
- an **Agent Development Kit (ADK)** that provides high-level abstractions for building AI agents with multi-agent orchestration, human-in-the-loop interrupts, and prebuilt agent patterns.
22
+
- a powerful **composition** framework that does the heavy lifting of strong type checking, stream processing, concurrency management, aspect injection, option assignment, etc. for the user.
23
23
- a set of meticulously designed **API** that obsesses on simplicity and clarity.
24
24
- an ever-growing collection of best practices in the form of bundled **flows** and **examples**.
25
25
- a useful set of tools that covers the entire development cycle, from visualized development and debugging to online tracing and evaluation.
- ReAct Agent, MultiQueryRetriever, Host MultiAgent, etc. They consist of multiple components and non-trivial business logic.
287
287
- They are still transparent from the outside. A MultiQueryRetriever can be used anywhere that accepts a Retriever.
288
288
289
-
## Powerful Orchestration
290
-
291
-
- Data flows from Retriever / Document Loaders / ChatTemplate to ChatModel, then flows to Tools and parsed as Final Answer. This directed, controlled flow of data through multiple components can be implemented through **graph orchestration**.
292
-
- Component instances are graph nodes, and edges are data flow channels.
293
-
- Graph orchestration is powerful and flexible enough to implement complex business logic:
294
-
- type checking, stream processing, concurrency management, aspect injection and option assignment are handled by the framework.
295
-
- branch out execution at runtime, read and write global state, or do field level data mapping using workflow(currently in alpha stage).
296
-
-**Aspects (Callbacks)** handle cross-cutting concerns such as logging, tracing, and metrics. Five aspects are supported: OnStart, OnEnd, OnError, OnStartWithStreamInput, OnEndWithStreamOutput. Custom callback handlers can be added during graph run via options.
297
-
298
289
## Agent Development Kit (ADK)
299
290
300
-
While graph orchestration gives you fine-grained control, the **ADK** package provides higher-level abstractions optimized for building AI agents:
291
+
The **ADK** package provides high-level abstractions optimized for building AI agents:
301
292
302
293
-**ChatModelAgent**: A ReAct-style agent that handles tool calling, conversation state, and the reasoning loop automatically.
303
294
-**Multi-Agent with Context Engineering**: Build hierarchical agent systems where conversation history is automatically managed across agent transfers and agent-as-tool invocations, enabling seamless context sharing between specialized agents.
@@ -306,6 +297,22 @@ While graph orchestration gives you fine-grained control, the **ADK** package pr
306
297
-**Prebuilt Patterns**: Ready-to-use implementations including Deep Agent (task orchestration), Supervisor (hierarchical coordination), and Plan-Execute-Replan.
307
298
-**Agent Middlewares**: Extensible middleware system for adding tools (filesystem operations) and managing context (token reduction).
308
299
300
+
## Powerful Orchestration
301
+
302
+
For fine-grained control, Eino provides **graph orchestration** where data flows from Retriever / Document Loaders / ChatTemplate to ChatModel, then flows to Tools and parsed as Final Answer.
303
+
304
+
- Component instances are graph nodes, and edges are data flow channels.
305
+
- Graph orchestration is powerful and flexible enough to implement complex business logic:
306
+
- type checking, stream processing, concurrency management, aspect injection and option assignment are handled by the framework.
307
+
- branch out execution at runtime, read and write global state, or do field level data mapping using workflow.
308
+
309
+
## Aspects (Callbacks)
310
+
311
+
**Aspects** handle cross-cutting concerns such as logging, tracing, and metrics. They can be applied to components directly, orchestrated graphs, or ADK agents.
312
+
313
+
- Five aspect types are supported: OnStart, OnEnd, OnError, OnStartWithStreamInput, OnEndWithStreamOutput.
314
+
- Custom callback handlers can be added at runtime via options.
315
+
309
316
## Complete Stream Processing
310
317
311
318
- Stream processing is important because ChatModel outputs chunks of messages in real time as it generates them. It's especially important with orchestration because more components need to handle streaming data.
0 commit comments