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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add databricks deployments client skeleton + example #10421

Merged
merged 3 commits into from Nov 16, 2023

Conversation

harupy
Copy link
Member

@harupy harupy commented Nov 16, 2023

馃洜 DevTools 馃洜

Open in GitHub Codespaces

Install mlflow from this PR

pip install git+https://github.com/mlflow/mlflow.git@refs/pull/10421/merge

Checkout with GitHub CLI

gh pr checkout 10421

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Title

How is this PR tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests

Does this PR require documentation update?

  • No. You can skip the rest of this section.
  • Yes. I've updated:
    • Examples
    • API references
    • Instructions

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/artifacts: Artifact stores and artifact logging
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages
  • area/examples: Example code
  • area/gateway: AI Gateway service, Gateway client APIs, third-party Gateway integrations
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/recipes: Recipes, Recipe APIs, Recipe configs, Recipe Templates
  • area/projects: MLproject format, project running backends
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/server-infra: MLflow Tracking server backend
  • area/tracking: Tracking Service, tracking client APIs, autologging

Interface

  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
  • area/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registry
  • area/windows: Windows support

Language

  • language/r: R APIs and clients
  • language/java: Java APIs and clients
  • language/new: Proposals for new client languages

Integrations

  • integrations/azure: Azure and Azure ML integrations
  • integrations/sagemaker: SageMaker integrations
  • integrations/databricks: Databricks integrations

How should the PR be classified in the release notes? Choose one:

  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
@github-actions github-actions bot added the rn/none List under Small Changes in Changelogs. label Nov 16, 2023
Copy link

github-actions bot commented Nov 16, 2023

Documentation preview for 8ab1694 will be available here when this CircleCI job completes successfully.

More info

@harupy harupy requested a review from dbczumar November 16, 2023 01:22
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
Comment on lines +23 to +36
def create_endpoint(self, name, config=None):
raise NotImplementedError("TODO")

def update_endpoint(self, endpoint, config=None):
raise NotImplementedError("TODO")

def delete_endpoint(self, endpoint):
raise NotImplementedError("TODO")

def list_endpoints(self):
raise NotImplementedError("TODO")

def get_endpoint(self, endpoint):
raise NotImplementedError("TODO")
Copy link
Member Author

Choose a reason for hiding this comment

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

I'll implement these later in a follow-up PR.

@harupy harupy mentioned this pull request Nov 16, 2023
37 tasks
def update_deployment(self, name, model_uri=None, flavor=None, config=None, endpoint=None):
raise NotImplementedError

def delete_deployment(self, name, config=None, endpoint=None):
Copy link
Member

Choose a reason for hiding this comment

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

Curious what values would be in config or endpoint here? Is there an option to delete an endpoint referenced by name but not the entire named deployment?

Copy link
Member Author

@harupy harupy Nov 16, 2023

Choose a reason for hiding this comment

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

I don't think we need xxx_deployment methods. They are abstract methods and need to be overridden. Users won't touch them.



class DatabricksDeploymentClient(BaseDeploymentClient):
def create_deployment(self, name, model_uri, flavor=None, config=None, endpoint=None):
Copy link
Member

Choose a reason for hiding this comment

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

Is the model_uri going to be required if we're creating a gateway route, or is gateway route creation purely going to be handled with create_endpoint() ?

Copy link
Member

Choose a reason for hiding this comment

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

do we need the flavor designator here? If we're using model_uri, can it read the configured flavor information from the MLmodel file?

Copy link
Member Author

Choose a reason for hiding this comment

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

is gateway route creation purely going to be handled with create_endpoint() ?

yes

Copy link
Member

Choose a reason for hiding this comment

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

perfect!

raise NotImplementedError("TODO")


def run_local(name, model_uri, flavor=None, config=None):
Copy link
Member

Choose a reason for hiding this comment

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

Build a local serving container and validate the capacity to return inference predictions? Is that what this is? (if so, this is awesome)

Copy link
Member Author

@harupy harupy Nov 16, 2023

Choose a reason for hiding this comment

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

I'm actually not sure what this is for. A deployment plugin must define target_help and run_local. We can update them if necessary.

Copy link
Member

Choose a reason for hiding this comment

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

The target_help implementation as explained in the ABC is definitely out of scope for a Databricks plugin (not entirely sure what that would return even if there was an available endpoint to target?). The run_local might also be a "maybe nice to have in the far-off future", but definitely something that would be rather challenging to simulate model serving behavior from within OSS.

Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
Copy link
Member

@BenWilson2 BenWilson2 left a comment

Choose a reason for hiding this comment

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

LGTM!

@harupy harupy merged commit dce3cb6 into mlflow:gateway-migration Nov 16, 2023
16 of 34 checks passed
@harupy harupy deleted the databricks-client branch November 16, 2023 02:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gateway-migration rn/none List under Small Changes in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants