Skip to content

Commit

Permalink
Docs/add aws bedrock to readme (#78)
Browse files Browse the repository at this point in the history
* Remove redundant links to ARTKIT doc sections: we already link to the docs in the Getting Started text of the README, and we already have overhead navigation to these sections in the HTML docs

* Mention both Google Gemini and Vertex AI since we support both APIs

* Mention AWS Bedrock
  • Loading branch information
rgriff23 authored Oct 23, 2024
1 parent 324f0ec commit 548c6e0
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ Automated Red Teaming (ART) and testing toolkit
**ARTKIT** is a Python framework developed by `BCG X <https://www.bcg.com/x>`_ for automating prompt-based
testing and evaluation of Gen AI applications.

`Documentation <https://bcg-x-official.github.io/artkit/_generated/home.html>`_ | `User Guides <https://bcg-x-official.github.io/artkit/user_guide/index.html>`_ | `Examples <https://bcg-x-official.github.io/artkit/examples/index.html>`_

.. Begin-Badges
|pypi| |conda| |python_versions| |code_style| |made_with_sphinx_doc| |license_badge| |github_actions_build_status| |Contributor_Convenant|
Expand All @@ -19,7 +17,7 @@ testing and evaluation of Gen AI applications.
Getting started
---------------

- See the `ARTKIT Documentation <https://bcg-x-official.github.io/artkit/_generated/home.html>`_ for our User Guide, Examples, API reference, and more.
- See the `ARTKIT Documentation <https://bcg-x-official.github.io/artkit/_generated/home.html>`_ for our `User Guides <https://bcg-x-official.github.io/artkit/user_guide/index.html>`_, `Examples <https://bcg-x-official.github.io/artkit/examples/index.html>`_, `API Reference <hhttps://bcg-x-official.github.io/artkit/apidoc/artkit.html>`_, and more.
- See `Contributing <https://github.com/BCG-X-Official/artkit/blob/HEAD/CONTRIBUTING.md>`_ or visit our `Contributor Guide <https://bcg-x-official.github.io/artkit/contributor_guide/index.html>`_ for information on contributing.
- We have an `FAQ <https://bcg-x-official.github.io/artkit/faq.html>`_ for common questions. For anything else, please reach out to [email protected].

Expand Down Expand Up @@ -97,7 +95,8 @@ Supported Model Providers
ARTKIT provides out-of-the-box support for the following model providers:

- `Anthropic <https://www.anthropic.com/>`_
- `Google Gemini <https://gemini.google.com/>`_
- `AWS Bedrock <https://aws.amazon.com/bedrock/>`_
- Google's `Gemini <https://gemini.google.com/>`_ and `Vertex AI <https://cloud.google.com/vertex-ai?hl=en>`_
- `Grok <https://groq.com/>`_
- `Hugging Face <https://huggingface.co/>`_
- `OpenAI <https://openai.com/>`_
Expand Down

0 comments on commit 548c6e0

Please sign in to comment.