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

openai batch agent backend setup documentation #5291

Merged
merged 3 commits into from
May 21, 2024

Conversation

samhita-alla
Copy link
Contributor

@samhita-alla samhita-alla commented Apr 26, 2024

Tracking issue

Fixes #5274

Why are the changes needed?

To document the openai batch agent backend setup config.

What changes were proposed in this pull request?

Documentation updates.

How was this patch tested?

Setup process

Screenshots

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

Docs link

@samhita-alla samhita-alla marked this pull request as draft April 26, 2024 07:24
neverett
neverett previously approved these changes Apr 26, 2024
Copy link
Contributor

@neverett neverett left a comment

Choose a reason for hiding this comment

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

One small suggestion, otherwise LGTM!

==================

This guide provides an overview of how to set up the OpenAI Batch agent in your Flyte deployment.
Please note that you have to set up the OpenAI API key in the agent server to run the Batch tasks.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think "Please note that you have to set up the OpenAI API key in the agent server to run the Batch tasks" can be removed, since that's described at line 67.

Signed-off-by: Samhita Alla <[email protected]>
Copy link

codecov bot commented May 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.09%. Comparing base (8eb7b0d) to head (29160e5).
Report is 547 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (8eb7b0d) and HEAD (29160e5). Click for more details.

HEAD has 2 uploads less than BASE
Flag BASE (8eb7b0d) HEAD (29160e5)
1 0
unittests 1 0
Additional details and impacted files
@@             Coverage Diff             @@
##           master    #5291       +/-   ##
===========================================
- Coverage   76.78%   61.09%   -15.69%     
===========================================
  Files          18      793      +775     
  Lines        1516    51156    +49640     
===========================================
+ Hits         1164    31256    +30092     
- Misses        288    17028    +16740     
- Partials       64     2872     +2808     
Flag Coverage Δ
unittests ?
unittests-datacatalog 69.31% <ø> (?)
unittests-flyteadmin 58.90% <ø> (?)
unittests-flytecopilot 17.79% <ø> (?)
unittests-flytectl 68.31% <ø> (?)
unittests-flyteidl 79.30% <ø> (?)
unittests-flyteplugins 61.94% <ø> (?)
unittests-flytepropeller 57.32% <ø> (?)
unittests-flytestdlib 65.73% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@samhita-alla samhita-alla marked this pull request as ready for review May 15, 2024 17:53
pingsutw
pingsutw previously approved these changes May 16, 2024
Signed-off-by: Samhita Alla <[email protected]>
@samhita-alla samhita-alla merged commit 458da5c into master May 21, 2024
49 of 50 checks passed
@samhita-alla samhita-alla deleted the add-openai-batch-deployment-doc branch May 21, 2024 16:10
robert-ulbrich-mercedes-benz pushed a commit to robert-ulbrich-mercedes-benz/flyte that referenced this pull request Jul 2, 2024
* add openi batch deployment guide

Signed-off-by: Samhita Alla <[email protected]>

* nit

Signed-off-by: Samhita Alla <[email protected]>

* source code renderer removed

Signed-off-by: Samhita Alla <[email protected]>

---------

Signed-off-by: Samhita Alla <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Integration] OpenAI Batch API Agent
3 participants