Skip to content

Commit

Permalink
Minor additions to documentation
Browse files Browse the repository at this point in the history
- Intro to supported models
  • Loading branch information
krasserm committed Jan 17, 2025
1 parent 463a2dc commit 6d4df8c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,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:
Expand Down
2 changes: 2 additions & 0 deletions docs/models.md
Original file line number Diff line number Diff line change
@@ -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`:
Expand Down

0 comments on commit 6d4df8c

Please sign in to comment.