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

Agents docs updates #1475

Closed
wants to merge 10 commits into from
Closed

Agents docs updates #1475

wants to merge 10 commits into from

Conversation

neverett
Copy link
Contributor

@neverett neverett commented Jan 31, 2024

Updated agents docs, structured as a guide aimed at end user and contributor audiences.

Staging docs

https://flyte--1475.org.readthedocs.build/projects/cookbook/en/1475/getting_started/agents.html

Related PRs

flyteorg/flyte#4822

Signed-off-by: nikki everett <[email protected]>
@neverett neverett self-assigned this Jan 31, 2024
@neverett neverett marked this pull request as ready for review February 1, 2024 21:44
@neverett neverett requested review from EngHabu, pingsutw and ppiegaze and removed request for wild-endeavor and kumare3 February 1, 2024 21:45
@neverett neverett changed the title [WIP] Agents docs updates Agents docs updates Feb 1, 2024
nikki everett added 2 commits February 1, 2024 16:06
Signed-off-by: nikki everett <[email protected]>
nikki everett added 2 commits February 1, 2024 16:44
Signed-off-by: nikki everett <[email protected]>

# Using Flyte agents in tasks

If you need to connect to an external service in your workflow, we recommend using the corresponding agent rather than a web API plugin. Unlike web API plugins, agents do not require creating a Kubernetes pod for each task. Agents are designed to be scalable and can handle large workloads efficiently, and decrease load on FlytePropeller, since they run outside of it. Finally, you can test agents locally without having to change the Flyte backend configuration, streamlining development.
Copy link
Member

Choose a reason for hiding this comment

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

web API plugin also won't create a Kubernetes pod for each task, but it has some drawbacks

  • it's difficult to write a new plugin since data scientists or engineers are not familiar with Golang. (agent is written in Python)
  • It's difficult to test the plugin locally. People have to update/build/deploy FlytePropeller, and deploy it to a remote cluster to test it.
  • having to change the Flyte backend configuration (as you mentioned above)

Signed-off-by: nikki everett <[email protected]>
@neverett
Copy link
Contributor Author

neverett commented Feb 6, 2024

Closing this PR and adding these docs to this Flyte PR, since the contents of the /docs/getting_started directory have been moved to Flyte (see flyteorg/flyte#4814).

@neverett neverett closed this Feb 6, 2024
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.

2 participants