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

Google docstring conversion batch 7 #10888

Merged

Conversation

michael-berk
Copy link
Collaborator

@michael-berk michael-berk commented Jan 24, 2024

馃洜 DevTools 馃洜

Open in GitHub Codespaces

Install mlflow from this PR

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

Checkout with GitHub CLI

gh pr checkout 10888

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Google docstring conversion for the following directories

  • langchain
  • lightgbm
  • mleap mleap deprecate decorator incorrectly formats both the current and google style docs. We'll leave these unchanged because mleap will be removed in future versions anyway.
  • onnx
  • pmdarima
  • promptflow
  • prophet
  • pyspark
  • pytorch
  • recipes

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/deployments: MLflow Deployments client APIs, server, and third-party Deployments integrations
  • area/docs: MLflow documentation pages
  • area/examples: Example code
  • 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

Michael Berk added 8 commits January 24, 2024 13:56
Signed-off-by: Michael Berk <michael.berk@databricks.com>
Signed-off-by: Michael Berk <michael.berk@databricks.com>
Signed-off-by: Michael Berk <michael.berk@databricks.com>
Signed-off-by: Michael Berk <michael.berk@databricks.com>
Signed-off-by: Michael Berk <michael.berk@databricks.com>
Signed-off-by: Michael Berk <michael.berk@databricks.com>
Signed-off-by: Michael Berk <michael.berk@databricks.com>
Signed-off-by: Michael Berk <michael.berk@databricks.com>
@github-actions github-actions bot added area/docs Documentation issues rn/none List under Small Changes in Changelogs. labels Jan 24, 2024
Copy link

github-actions bot commented Jan 24, 2024

Documentation preview for 3e2d8c6 will be available here when this CircleCI job completes successfully.

More info

@michael-berk michael-berk changed the title Michaelberk/docstring conversion batch 7 [WIP] Google docstring conversion batch 7 Jan 24, 2024
Signed-off-by: Michael Berk <michael.berk@databricks.com>
@michael-berk michael-berk changed the title [WIP] Google docstring conversion batch 7 Google docstring conversion batch 7 Jan 27, 2024
Michael Berk added 2 commits January 26, 2024 20:08
Signed-off-by: Michael Berk <michael.berk@databricks.com>
Signed-off-by: Michael Berk <michael.berk@databricks.com>
Copy link
Collaborator

@serena-ruan serena-ruan left a comment

Choose a reason for hiding this comment

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

LGTM!

@serena-ruan serena-ruan merged commit 09e1571 into mlflow:master Jan 30, 2024
94 checks passed
ernestwong-db pushed a commit to ernestwong-db/mlflow that referenced this pull request Feb 6, 2024
Signed-off-by: Michael Berk <michael.berk@databricks.com>
Co-authored-by: Michael Berk <michael.berk@databricks.com>
Signed-off-by: ernestwong-db <ernest.wong@databricks.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation issues 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