diff --git a/README.md b/README.md index 20b279c..7fc03d4 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,8 @@ A lightweight library for code-action based agents. ## Contents - [Introduction](#introduction) -- [Key Capabilities](#key-capabilities) +- [Key capabilities](#key-capabilities) +- [Supported models](#supported-models) - [Quickstart](#quickstart) - [Evaluation](#evaluation) @@ -26,7 +27,7 @@ The `freeact` documentation is available [here](https://gradion-ai.github.io/fre The library builds upon [recent](https://arxiv.org/abs/2402.01030) [research](https://arxiv.org/abs/2411.01747) demonstrating that code-based actions significantly outperform traditional agent approaches, with studies showing up to 20% higher success rates compared to conventional methods. While existing solutions often restrict agents to predefined tool sets, `freeact` removes these limitations by allowing agents to leverage the full power of the Python ecosystem, dynamically installing and utilizing any required libraries as needed. -## Key Capabilities +## Key capabilities `freeact` agents can autonomously improve their actions through learning from environmental feedback, execution results, and human guidance. A prominent feature is their ability to store and reuse successful code actions as custom skills in long-term memory. These skills can be composed and interactively refined to build increasingly sophisticated capabilities, enabling efficient scaling to complex tasks. @@ -34,6 +35,10 @@ The library's architecture emphasizes extensibility and transparency, avoiding t `freeact` executes all code actions within [`ipybox`](https://gradion-ai.github.io/ipybox/), a secure execution environment built on IPython and Docker that can also be deployed locally. This ensures safe execution of dynamically generated code while maintaining full access to the Python ecosystem. Combined with its lightweight and extensible architecture, `freeact` provides a robust foundation for building adaptable AI agents that can tackle real-world challenges requiring dynamic problem-solving approaches. +## Supported models + +In addition to the models we [evaluated](#evaluation), `freeact` also supports any model from any provider that is compatible with the [OpenAI Python SDK](https://github.com/openai/openai-python), including open models deployed locally on [ollama](https://ollama.com/) or [TGI](https://huggingface.co/docs/text-generation-inference/index), for example. See [Model integration](https://gradion-ai.github.io/freeact/models/#model-integration) for details. + ## Quickstart Install `freeact` using pip: diff --git a/docs/models.md b/docs/models.md index a7f5198..82ca93f 100644 --- a/docs/models.md +++ b/docs/models.md @@ -1,5 +1,7 @@ # Supported models +In addition to the models we evaluated, `freeact` also supports any model from any provider that is compatible with the [OpenAI Python SDK](https://github.com/openai/openai-python), including open models deployed locally on [ollama](https://ollama.com/) or [TGI](https://huggingface.co/docs/text-generation-inference/index), for example. See [Model integration](#model-integration) for details. + ## Evaluated models The following models have been [evaluated](evaluation.md) with `freeact`: