Huggingface model deployer support #157

sanskriti2005 · 2024-06-13T09:53:07Z

Describe changes

Added support for the use of huggingface model deployer.
closes #151

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
If my change requires a change to docs, I have updated the documentation
accordingly.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting
develop. If your branch wasn't based on develop read
Contribution guide on rebasing branch to develop.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to
change)
Other (add details above)

coderabbitai · 2024-06-13T09:53:12Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

strickvl

First off, thank you for contributing! Started going through this, but the initial feedback is basically that I think we don't need most of these changes on the .tf files since the Hugging Face model deployer is serverless and doesn't rely on having a Kubernetes cluster to work.

So the output_file.tf changes are good, as are the variables updates, and the constants / enums, but all the rest is probably unneeded. You also probably want to allow the user to pass in a huggingface_token as a variable since then you can set that up already in the file (as described here https://docs.zenml.io/stack-components/model-deployers/huggingface). Maybe the namespace as well.

I think those would be the next changes I'd make here to bring you closer to having this ready.

strickvl · 2024-06-21T12:32:08Z

src/mlstacks/terraform/aws-modular/istio.tf

@@ -1,7 +1,7 @@
 module "istio" {
  source = "../modules/istio-module"

-  count = (var.enable_model_deployer_seldon) ? 1 : 0
+  count = (var.enable_model_deployer_huggingface || var.enable_model_deployer_seldon) ? 1 : 0


I think this change is unneeded. We don't need istio for the HF deployer.

sanskriti2005 · 2024-06-22T02:54:38Z

Thanks for the review! I will make these changes. Thank you so much for being patient with me on this.

… variables

sanskriti2005 · 2024-07-12T02:09:57Z

Hello! @strickvl
Please review the changes I made.

strickvl

I made some more comments. There are still things in the terraform files that don't need to be there, IMO. I made the comments for one provider, but you can apply the same comments to the rest of the changed files.

strickvl · 2024-07-12T06:15:46Z

src/mlstacks/constants.py

@@ -38,7 +38,7 @@
        "vertex",
    ],
    "mlops_platform": ["zenml"],
-    "model_deployer": ["seldon"],
+    "model_deployer": ["seldon","huggingface"],


Suggested change

"model_deployer": ["seldon","huggingface"],

"model_deployer": ["seldon", "huggingface"],

strickvl · 2024-07-12T06:16:01Z

src/mlstacks/enums.py

@@ -31,6 +31,7 @@ class ComponentTypeEnum(str, Enum):
    FEATURE_STORE = "feature_store"
    ANNOTATOR = "annotator"
    IMAGE_BUILDER = "image_builder"
+


Suggested change

strickvl · 2024-07-12T06:16:37Z

src/mlstacks/enums.py

@@ -50,6 +51,7 @@ class ComponentFlavorEnum(str, Enum):
    VERTEX = "vertex"
    ZENML = "zenml"
    DEFAULT = "default"
+    HUGGINGFACE = "huggingface"


Probably insert this in the alphabetical order...

strickvl · 2024-07-12T06:17:17Z

src/mlstacks/terraform/aws-modular/locals.tf

+  } 
+
+  huggingface = {
+    version              = "4.41.3"
+    name                 = "huggingface"
+    namespace            = "huggingface-system"
+    workloads_namespace  = "zenml-workloads-huggingface"
+    service_account_name = "huggingface"


I think we don't need this?

strickvl · 2024-07-12T06:17:46Z

src/mlstacks/terraform/aws-modular/output_file.tf

+        name: eks_huggingface_model_deployer
+        configuration: {"kubernetes_context": "${aws_eks_cluster.cluster[0].arn}", "kubernetes_namespace": "${local.huggingface.workloads_namespace}", "base_url": "http://${module.istio[0].ingress-hostname}:${module.istio[0].ingress-port}"}}


This needs updating as we're no longer using EKS for this etc..

@strickvl Thank you for the review! I understood everything else but for this part, Could you please provide more guidance or resources on how to do this part?

strickvl · 2024-07-12T06:18:51Z

src/mlstacks/terraform/aws-modular/outputs.tf

Same theme here... we're not using a cluster any more for the HF deployment so no need to include all that stuff here..

…ttps://github.com/sanskriti2005/mlstacks into huggingface-model-deployer-support

sanskriti2005 added 2 commits June 13, 2024 09:35

updated docs

2f145d8

defined interfaces

77acb20

updated aws-modular recipe for huggingface deployment

1eca041

sanskriti2005 marked this pull request as ready for review June 17, 2024 14:19

sanskriti2005 marked this pull request as draft June 17, 2024 14:19

strickvl self-requested a review June 17, 2024 14:20

strickvl added the enhancement New feature or request label Jun 17, 2024

updated all recipes

3f7cac8

sanskriti2005 marked this pull request as ready for review June 21, 2024 05:43

strickvl requested changes Jun 21, 2024

View reviewed changes

removed unnecessary changes and added huggingface token and namespace…

3fedc39

… variables

strickvl linked an issue Jul 11, 2024 that may be closed by this pull request

Add huggingface model deployer support #151

Open

Merge branch 'develop' into huggingface-model-deployer-support

b634d36

strickvl requested changes Jul 12, 2024

View reviewed changes

sanskriti2005 added 2 commits July 12, 2024 08:49

removed unnecessary changes

21a6120

updated branch: Merge branch 'huggingface-model-deployer-support' of h…

7296aa3

…ttps://github.com/sanskriti2005/mlstacks into huggingface-model-deployer-support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Huggingface model deployer support #157

Huggingface model deployer support #157

sanskriti2005 commented Jun 13, 2024 •

edited

Loading

coderabbitai bot commented Jun 13, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

strickvl left a comment •

edited

Loading

strickvl Jun 21, 2024

sanskriti2005 commented Jun 22, 2024

sanskriti2005 commented Jul 12, 2024

strickvl left a comment

strickvl Jul 12, 2024

strickvl Jul 12, 2024

strickvl Jul 12, 2024

strickvl Jul 12, 2024

strickvl Jul 12, 2024

sanskriti2005 Jul 12, 2024

strickvl Jul 12, 2024

	"model_deployer": ["seldon","huggingface"],
	"model_deployer": ["seldon", "huggingface"],

		name: eks_huggingface_model_deployer
		configuration: {"kubernetes_context": "${aws_eks_cluster.cluster[0].arn}", "kubernetes_namespace": "${local.huggingface.workloads_namespace}", "base_url": "http://${module.istio[0].ingress-hostname}:${module.istio[0].ingress-port}"}}

Huggingface model deployer support #157

Are you sure you want to change the base?

Huggingface model deployer support #157

Conversation

sanskriti2005 commented Jun 13, 2024 • edited Loading

Describe changes

Pre-requisites

Types of changes

coderabbitai bot commented Jun 13, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

strickvl left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sanskriti2005 commented Jun 22, 2024

sanskriti2005 commented Jul 12, 2024

strickvl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sanskriti2005 commented Jun 13, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

strickvl left a comment •

edited

Loading