Skip to content

Commit

Permalink
docs(README.md): update setup section to provide more information on …
Browse files Browse the repository at this point in the history
…vendor configuration and options

docs(README.md): add links for OpenAI and AWS Bedrock setup instructions for convenience
  • Loading branch information
maciejmajek committed Sep 8, 2024
1 parent 5fab9e1 commit 2f4c80b
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The RAI framework aims to:
## Table of Contents

- [Features](#features)
- [Quick Start](#quick-start)
- [Setup](#setup)
- [Usage examples (demos)](#planned-demos)
- [Further documentation](#further-documentation)
- [ROSCon 2024 Talk](#roscon-2024)
Expand Down Expand Up @@ -111,17 +111,16 @@ source ./setup_shell.sh

### 3. Setting up vendors

RAI is fully vendor-agnostic, however the beta development work currently utilizes OpenAI models.
RAI is fully vendor-agnostic, however the beta development work currently utilizes OpenAI models (mostly).
Most of the RAI modules, will use the configuration from [config.toml](./config.toml) file in which you can set up your vendor of choice.

#### OpenAI
> [!NOTE]
> Some of the RAI modules still are hardcoded to OpenAI models. An effort is underway to make them configurable via [config.toml](./config.toml) file.
If you do not have a key, see how to generate one [here](https://platform.openai.com/docs/quickstart).
If you do not have a vendor's key, follow the instructions below:

```
export OPENAI_API_KEY=""
```

It is best to put this command into your `~/.bashrc` file for convenience, so it is effective for each new console.
**OpenAI:** [link](https://platform.openai.com/docs/quickstart).
**AWS Bedrock:** [link](https://console.aws.amazon.com/bedrock/home?#/overview).

Congratulations, your installation is now completed!

Expand Down

0 comments on commit 2f4c80b

Please sign in to comment.