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.

Sign up for GitHub

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

Jump to bottom

Exclude model_computed_fields from docs #10943

Merged
merged 1 commit into from Jan 30, 2024
Merged

Exclude model_computed_fields from docs #10943

merged 1 commit into from Jan 30, 2024

Conversation

harupy
Copy link
Member

@harupy harupy commented Jan 30, 2024 •
edited by github-actions bot

馃洜 DevTools 馃洜

Open in GitHub Codespaces

Install mlflow from this PR

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

Checkout with GitHub CLI

gh pr checkout 10943

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Fix https://app.circleci.com/pipelines/github/mlflow/mlflow/32073/workflows/8c7f11ff-3741-4b85-ad3c-e5854281dcda/jobs/87460

/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.AI21LabsConfig.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.AWSBaseConfig.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.AWSBedrockConfig.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.AWSIdAndKey.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.AWSRole.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.AliasedConfigModel.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.AnthropicConfig.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.CohereConfig.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.GatewayConfig.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.HuggingFaceTextGenerationInferenceConfig.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.Limit.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.LimitsConfig.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.MlflowModelServingConfig.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.Model.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.ModelInfo.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.MosaicMLConfig.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.OpenAIConfig.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.PaLMConfig.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.Route.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.RouteConfig.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo
/home/circleci/project/mlflow/gateway/config.py:docstring of mlflow.gateway.config.RouteModelInfo.model_computed_fields:: WARNING: py:class reference target not found: ComputedFieldInfo

Related to pydantic 2.6.0

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

@harupy
Exclude model_computed_fields from docs
511f2b6 
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
@harupy harupy requested a review from a team January 30, 2024 03:04
@github-actions GitHub Actions
Copy link

Documentation preview for 511f2b6 will be available here when this CircleCI job completes successfully.

More info

@github-actions github-actions bot added the rn/none List under Small Changes in Changelogs. label Jan 30, 2024
@mlflow-automation mlflow-automation requested review from B-Step62, BenWilson2, daniellok-db, serena-ruan and WeichenXu123 and removed request for a team January 30, 2024 03:04
harupy
harupy commented Jan 30, 2024
View reviewed changes
docs/source/python_api/mlflow.gateway.rst
@@ -12,3 +12,4 @@ mlflow.gateway
.. automodule:: mlflow.gateway.config
:members:
:undoc-members:
:exclude-members: model_computed_fields
Copy link
Member Author

Choose a reason for hiding this comment

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

Ref: pydantic/pydantic@2171b20

daniellok-db
daniellok-db approved these changes Jan 30, 2024
View reviewed changes
Copy link
Collaborator

@daniellok-db daniellok-db 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 fc515cd into mlflow:master Jan 30, 2024
45 checks passed
@harupy harupy deleted the pydantic-2.6-model_computed_fields branch January 30, 2024 04:47
ernestwong-db pushed a commit to ernestwong-db/mlflow that referenced this pull request Feb 6, 2024
@harupy @ernestwong-db
Exclude model_computed_fields from docs (mlflow#10943)
56e60c8 
Signed-off-by: harupy <17039389+harupy@users.noreply.github.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
Reviewers

@daniellok-db daniellok-db daniellok-db approved these changes

@B-Step62 B-Step62 Awaiting requested review from B-Step62

@BenWilson2 BenWilson2 Awaiting requested review from BenWilson2

@serena-ruan serena-ruan Awaiting requested review from serena-ruan

@WeichenXu123 WeichenXu123 Awaiting requested review from WeichenXu123

Assignees
No one assigned
Labels
rn/none List under Small Changes in Changelogs.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@harupy @daniellok-db