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

[Housekeeping] Remove references to unused plugins in flytekit api docs #4539

Closed
2 tasks done
cosmicBboy opened this issue Dec 6, 2023 · 2 comments
Closed
2 tasks done
Labels
housekeeping Issues that help maintain flyte and keep it tech-debt free

Comments

@cosmicBboy
Copy link
Contributor

cosmicBboy commented Dec 6, 2023

Describe the issue

The purpose of this issue is to remove the awssagemaker and fsspec plugin from the api docs.

  • The current flytekit sagemaker plugin is being deprecated in favor of a sagemaker agent:
    [Core feature] Sagemaker Agent #4079. The purpose of this task is to remove references
    to this plugin in the flytekit api reference docs.
  • The fsspec plugin is also just a stub package for now.

What if we do not do this?

This will cause warnings in the docs build process, since flyteidl.plugins.sagemaker no longer exists.

Related component(s)

No response

Are you sure this issue hasn't been raised already?

  • Yes

Have you read the Code of Conduct?

  • Yes
@cosmicBboy cosmicBboy added the housekeeping Issues that help maintain flyte and keep it tech-debt free label Dec 6, 2023
Copy link

dosubot bot commented Dec 6, 2023

🤖

Hello @cosmicBboy!

I'm Dosu, a bot here to assist you with bugs, answer questions, and guide you on your journey to becoming a contributor. While we wait for a human maintainer to respond, feel free to ask me any questions you may have. I'm here to help!

Based on the information provided, the references to the Sagemaker plugin in the flytekit API reference docs are located in the file docs/deployment/plugins/aws/sagemaker.rst. This file contains instructions on how to set up the Sagemaker plugin with your Flyte deployment, including setting up the AWS Flyte cluster, specifying the plugin configuration, upgrading the Flyte Helm release, registering the Sagemaker plugin example, and launching an execution.

The Sagemaker plugin is specified in the values-override.yaml file under the enabled_plugins section:

configmap:
  enabled_plugins:
    tasks:
      task-plugins:
        enabled-plugins:
          - container
          - sidecar
          - k8s-array
          - sagemaker_training
          - sagemaker_hyperparameter_tuning
        default-for-task-types:
          container: container
          sidecar: sidecar
          container_array: k8s-array

The Sagemaker plugin example is registered using the flytectl command:

flytectl register files https://github.com/flyteorg/flytesnacks/releases/download/v0.3.0/snacks-cookbook-integrations-aws-sagemaker_training.tar.gz --archive -p flytesnacks -d development

And an execution is launched using the flytectl command:

flytectl --config ~/.flyte/flytectl.yaml create execution \
    -p <project> -d <domain> --execFile ~/exec_spec.yaml

To deprecate the Sagemaker plugin, you would need to remove these references from the sagemaker.rst file and any other files that reference the Sagemaker plugin. You would also need to remove the Sagemaker plugin from the enabled_plugins section of the values-override.yaml file.

As for the exact functionality of the Sagemaker plugin in the Flytekit API, I wasn't able to find an answer within the repository. It might be helpful to look at the Sagemaker plugin's source code or documentation for more information.

Please let me know if you need further assistance.

Sources


This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.

@cosmicBboy cosmicBboy changed the title [Housekeeping] Deprecate the awssagemaker plugin in favor of the sagemaker agent [Housekeeping] Remove references to unused plugins in flytekit api docs Dec 6, 2023
@cosmicBboy
Copy link
Contributor Author

Fixed by flyteorg/flytekit#2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
housekeeping Issues that help maintain flyte and keep it tech-debt free
Projects
None yet
Development

No branches or pull requests

1 participant