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

[Docs] Testing agents in the development environment #5106

Merged
merged 14 commits into from
Apr 5, 2024

Conversation

Future-Outlier
Copy link
Member

@Future-Outlier Future-Outlier commented Mar 26, 2024

Docs link

index: https://flyte--5106.org.readthedocs.build/en/5106/flyte_agents/index.html
testing_agents_in_the_development_environment: https://flyte--5106.org.readthedocs.build/en/5106/flyte_agents/testing_agents_in_the_development_environment.html
deploying_agents_to_the_flyte_sandbox: https://flyte--5106.org.readthedocs.build/en/5106/flyte_agents/deploying_agents_to_the_flyte_sandbox.html
implementing_agent_metadata_service: https://flyte--5106.org.readthedocs.build/en/5106/flyte_agents/implementing_agent_metadata_service.html

Tracking issue

#3936

Why are the changes needed?

Help users to develop agent service and test it more easily.

What changes were proposed in this pull request?

Add Testing agents in the development environment documentation.

How was this patch tested?

@samhita-alla has tested it when developing the aws sagemaker agent, and it works well

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

flyteorg/static-resources#37

@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. documentation Improvements or additions to documentation labels Mar 26, 2024
@Future-Outlier Future-Outlier changed the title Testing agents in the development environment [Docs] Testing agents in the development environment Mar 26, 2024
Copy link

codecov bot commented Mar 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.60%. Comparing base (524b473) to head (cb61705).
Report is 17 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5106      +/-   ##
==========================================
- Coverage   59.10%   58.60%   -0.50%     
==========================================
  Files         645      568      -77     
  Lines       55574    51112    -4462     
==========================================
- Hits        32846    29955    -2891     
+ Misses      20135    18742    -1393     
+ Partials     2593     2415     -178     
Flag Coverage Δ
unittests 58.60% <ø> (-0.50%) ⬇️

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.

@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels Mar 26, 2024
@neverett
Copy link
Contributor

neverett commented Apr 1, 2024

Hey @Future-Outlier sorry for the delay on reviewing this -- would you be able to add your changes from #5107 to this PR so the combined changes can be reviewed together?

@Future-Outlier
Copy link
Member Author

Hey @Future-Outlier sorry for the delay on reviewing this -- would you be able to add your changes from #5107 to this PR so the combined changes can be reviewed together?

I've just merged it, thank you for reviewing this PR.
I will update your suggestion ASAP.

Future-Outlier and others added 13 commits April 2, 2024 19:28
Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
Co-authored-by: Kevin Su <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
Co-authored-by: Kevin Su <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: Future-Outlier <[email protected]>
@Future-Outlier
Copy link
Member Author

@neverett Hi, will you review these docs recently?
It is really ok that you don't have time to do it.
I am thinking that we can merge this PR first since some users want this documentation to write their own agent.

@neverett
Copy link
Contributor

neverett commented Apr 4, 2024

@Future-Outlier sure thing, I can take a look today!

@neverett
Copy link
Contributor

neverett commented Apr 5, 2024

@Future-Outlier would it be okay if I pushed commits to this branch? I think it will be faster for me to reorganize some of the information that way.

@Future-Outlier
Copy link
Member Author

@Future-Outlier would it be okay if I pushed commits to this branch? I think it will be faster for me to reorganize some of the information that way.

it will be okay

@Future-Outlier
Copy link
Member Author

@Future-Outlier would it be okay if I pushed commits to this branch? I think it will be faster for me to reorganize some of the information that way.

@neverett feel free to do that, thank you!

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Apr 5, 2024
@neverett
Copy link
Contributor

neverett commented Apr 5, 2024

@Future-Outlier I pushed a commit to reorganize and edit the content -- let me know what you think! If my changes look good to you and tests are passing, feel free to merge.

@Future-Outlier
Copy link
Member Author

@Future-Outlier I pushed a commit to reorganize and edit the content -- let me know what you think! If my changes look good to you and tests are passing, feel free to merge.

@neverett It's great, thank you!

@Future-Outlier Future-Outlier merged commit 2eede89 into master Apr 5, 2024
47 of 48 checks passed
@Future-Outlier Future-Outlier deleted the agent-dev-env-guide branch April 5, 2024 23:19
Jeinhaus pushed a commit to Jeinhaus/flyte that referenced this pull request Apr 8, 2024
* Testing agents in the development environment

Signed-off-by: Future-Outlier <[email protected]>

* nit

Signed-off-by: Future-Outlier <[email protected]>

* nit

Signed-off-by: Future-Outlier <[email protected]>

* update

Signed-off-by: Future-Outlier <[email protected]>

* rename

Signed-off-by: Future-Outlier <[email protected]>

* blank

Signed-off-by: Future-Outlier <[email protected]>

* rerun build docs ci

Signed-off-by: Future-Outlier <[email protected]>

* update pingsu's advice

Signed-off-by: Future-Outlier <[email protected]>
Co-authored-by: Kevin Su <[email protected]>

* Update pingsu's advice

Signed-off-by: Future-Outlier <[email protected]>
Co-authored-by: Kevin Su <[email protected]>

* deploying agents in the sandbox

Signed-off-by: Future-Outlier <[email protected]>

* rename

Signed-off-by: Future-Outlier <[email protected]>

* nit

Signed-off-by: Future-Outlier <[email protected]>

* Implementing Agent Metadata Service

Signed-off-by: Future-Outlier <[email protected]>

* reorganize and copyedit new content

Signed-off-by: nikki everett <[email protected]>

---------

Signed-off-by: Future-Outlier <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Co-authored-by: Kevin Su <[email protected]>
Co-authored-by: nikki everett <[email protected]>
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 lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants