From cb75dd8b5dc8a9ce59be8a7a2fcd9730826c9285 Mon Sep 17 00:00:00 2001 From: vizsatiz Date: Sun, 17 Nov 2024 19:36:42 +0530 Subject: [PATCH] Doc changes for 0.0.4 release --- CONTRIBUTING.md | 2 ++ README.md | 2 +- ROADMAP.md | 13 ++++++------- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b9ea1bcd..6b34e688 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,7 @@ Fork the repository. Create a new branch for your feature. Add your feature or improvement. Send a pull request. + We appreciate your input! ## Installing Dependencies @@ -13,4 +14,5 @@ We appreciate your input! ```cmd poetry lock poetry install +pre-commit install ``` diff --git a/README.md b/README.md index 3533fb6a..b7fa9e5d 100644 --- a/README.md +++ b/README.md @@ -157,7 +157,7 @@ for response in flo.stream("Write about recent AI developments"): ``` **Note:** You can make each of the above agents including the router to different models, giving flexibility to combine the power of different LLMs. -To know more, check multi-model integration in detailed [documentation](https://flo-ai.rootflo.ai) +To know more, check multi-model integration in detailed [documentation](https://flo-ai.rootflo.ai/advanced/model-switching) ### Lets Create a AI team using code diff --git a/ROADMAP.md b/ROADMAP.md index 636e9343..e5fc8189 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -8,13 +8,7 @@ Core features improve the library itself to cater wider range of functionalities | Name | Description | Status | Release version | |------|-------------|--------|-----------------| -| Full composability | Right now teams can only be combined with teams and agents with agents. We want to extend this to team + agent composibility | ✅ | 0.0.4 | -| Error handling | Ability to handle errors autonomously | ✅ | 0.0.4| -|LLM Extensibilty| Ability to different LLMs across different agents and teams| ✅ | 0.0.4| -|Async Tools| Ability create tools easily within asyncio | ✅ | 0.0.4| -|Observer| Observer framework for raising agent decision events and other important events | ✅ | 0.0.4| |Output formatter| Ability to templatize output format using pydantic| Yet to start| 0.0.4| -|Auto-Query RAG| Ability to make metadata query within the agentic, which can automatically add metadata while rag query runs, like timestamp or other data|Yet to start|TBD| |Parellel Router| A router to execute tasks or agents in parallel if the tasks are independent | Yet to start | TBD ## Observability @@ -24,7 +18,6 @@ These features improve logging and debugging abilities while building. | Name | Description | Status | Release version | |------|-------------|--------|-----------------| |Recursion control| Expose parameters like recursion control to limit recursions and policy in case of recursion etc | Yet to start | 0.0.5 -|Set up tests| Create a framework for unit-testing flo-ai and its internal functionalities| ✅ | 0.0.4 ## Community @@ -47,6 +40,12 @@ The community is welcome to suggest changes to the roadmap, through a pull reque |Reflection| Reflection lets you build a component that can make the AI retrospectively look at the current output and retry or work again on the task at hand| ✅ | 0.0.3| |Delegator| Delegator lets you build a component that can help delegate a flo to a particular agent, by some condition| ✅ | 0.0.3| |Logging Framework|Better logging framework which can be extended to parent application (with log level control)| ✅|0.0.3| +| Full composability | Right now teams can only be combined with teams and agents with agents. We want to extend this to team + agent composibility | ✅ | 0.0.4 | +| Error handling | Ability to handle errors autonomously | ✅ | 0.0.4| +|LLM Extensibilty| Ability to different LLMs across different agents and teams| ✅ | 0.0.4| +|Async Tools| Ability create tools easily within asyncio | ✅ | 0.0.4| +|Observer| Observer framework for raising agent decision events and other important events | ✅ | 0.0.4| +|Set up tests| Create a framework for unit-testing flo-ai and its internal functionalities| ✅ | 0.0.4