Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor documentation improvements in the CodeGen README #534

Merged
merged 1 commit into from
Aug 7, 2024
Merged

Minor documentation improvements in the CodeGen README #534

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions CodeGen/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Currently we support two ways of deploying ChatQnA services with docker compose:
docker pull opea/codegen:latest
```

2. Start services using the docker images `built from source`: [Guide](./docker)
2. Start services using the docker images built from source. See the [Gaudi Guide](./docker/gaudi/README.md) or [Xeon Guide](./docker/xeon/README.md) for more information.

### Setup Environment Variable

Expand All @@ -55,6 +55,10 @@ To set up environment variables for deploying ChatQnA services, follow these ste

3. Set up other environment variables:

> Note: By default, the [`docker/set_env.sh`](docker/set_env.sh) file will configure your environment
> variables to use [meta-llama/CodeLlama-7b-hf](https://huggingface.co/meta-llama/CodeLlama-7b-hf). This
> is a gated model that requires submitting an access request through Hugging Face.

```bash
source ./docker/set_env.sh
```
Expand All @@ -70,7 +74,7 @@ cd GenAIExamples/CodeGen/docker/gaudi
docker compose up -d
```

> Notice: Currently only the **Habana Driver 1.16.xi** is supported for Gaudi.
> Notice: Currently only the **Habana Driver 1.16.x** is supported for Gaudi.

Refer to the [Gaudi Guide](./docker/gaudi/README.md) to build docker images from source.

Expand Down