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

Add codegen sample guide for Gaudi deployment #248

Merged
merged 11 commits into from
Nov 19, 2024

Conversation

alexsin368
Copy link
Collaborator

Targeting v1.1 release

@alexsin368
Copy link
Collaborator Author

This is a new document. Not sure how to address this issue in the Check Online Document Building test:

make: *** [Makefile:65: html] Error 2
/home/runner/work/docs/docs/_build/rst/examples/CodeGen/deploy/gaudi.md: WARNING: document isn't included in any toctree

examples/CodeGen/deploy/gaudi.md Outdated Show resolved Hide resolved
examples/CodeGen/deploy/gaudi.md Outdated Show resolved Hide resolved
examples/CodeGen/deploy/gaudi.md Outdated Show resolved Hide resolved
examples/CodeGen/deploy/gaudi.md Outdated Show resolved Hide resolved
examples/CodeGen/deploy/gaudi.md Outdated Show resolved Hide resolved
examples/CodeGen/deploy/gaudi.md Outdated Show resolved Hide resolved
@ashahba
Copy link
Collaborator

ashahba commented Nov 15, 2024

This is a new document. Not sure how to address this issue in the Check Online Document Building test:

make: *** [Makefile:65: html] Error 2 /home/runner/work/docs/docs/_build/rst/examples/CodeGen/deploy/gaudi.md: WARNING: document isn't included in any toctree

Don't worry about this. Just make sure the file is actually there.
CI gatekeepers would whitelist it once the PR is approved and merged.

@ashahba ashahba added this to the v1.1 milestone Nov 15, 2024
@ashahba ashahba added the r1.1 v1.1 release label Nov 15, 2024
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
Copy link
Collaborator

ashahba commented Nov 16, 2024

This is a new document. Not sure how to address this issue in the Check Online Document Building test:

make: *** [Makefile:65: html] Error 2 /home/runner/work/docs/docs/_build/rst/examples/CodeGen/deploy/gaudi.md: WARNING: document isn't included in any toctree

Actually if you make a small change like this:

$ git diff
diff --git a/examples/index.rst b/examples/index.rst
index 6524dc1..283693f 100644
--- a/examples/index.rst
+++ b/examples/index.rst
@@ -12,6 +12,8 @@ GenAIExamples are designed to give developers an easy entry into generative AI,
    ChatQnA/deploy/index
    AgentQnA/AgentQnA_Guide
    AgentQnA/deploy/index
+   CodeGen/deploy/gaudi.md
+   CodeGen/deploy/index
 
 ----

and then create this file: examples/CodeGen/deploy/index.rst with the following content:


CodeGen Example Deployment Options
###################################

Here are some deployment options, depending on your hardware and environment:

Single Node
***********

.. toctree::
   :maxdepth: 1

   Gaudi AI Accelerator <gaudi>

This should fix that issue 🤞

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.

Please update the examples/index.rst as mentioned in comments.

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!

@chensuyue
Copy link
Collaborator

@tomlenth @NeoZhangJianyu please review.

@yinghu5 yinghu5 self-requested a review November 19, 2024 02:07
Copy link
Collaborator

@yinghu5 yinghu5 left a comment

Choose a reason for hiding this comment

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

LGTM

@yinghu5 yinghu5 merged commit 1ec71a5 into opea-project:main Nov 19, 2024
4 checks passed
@alexsin368 alexsin368 deleted the codegen_doc branch November 19, 2024 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
r1.1 v1.1 release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants