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.

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

Conversation

dmsuehir
Copy link
Contributor

@dmsuehir dmsuehir commented Aug 6, 2024

Description

This PR makes minor documentation updates for things that I noticed when running this example:

  • There is a "Guide" link that took me to a directory without a README.md, so I changed this to link to the Gaudi and Xeon READMEs that have instructions for building the docker images from source
  • The instructions have me set my HF token env var, but there is no mention of what model is being used and I didn't previously have access CodeLlama.
  • Fixed a typo in the Gaudi driver version

Type of change

List the type of change like below. Please delete options that are not relevant.

  • Others (enhancement, documentation, validation, etc.)

Dependencies

N/A

Tests

N/A

Signed-off-by: dmsuehir <dina.s.jones@intel.com>
Copy link
Collaborator

@ashahba ashahba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ashahba ashahba added the documentation Improvements or additions to documentation label Aug 6, 2024
@ashahba ashahba merged commit 17b9676 into opea-project:main Aug 7, 2024
4 checks passed
yogeshmpandey pushed a commit to hteeyeoh/GenAIExamples that referenced this pull request Aug 12, 2024
Signed-off-by: dmsuehir <dina.s.jones@intel.com>
@dmsuehir dmsuehir deleted the dina/codegen_readme branch August 14, 2024 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants