Skip to content

Cleanup Prophet docs#18814

Merged
BenWilson2 merged 5 commits intomlflow:masterfrom
BenWilson2:prophet-docs-cleanup
Nov 14, 2025
Merged

Cleanup Prophet docs#18814
BenWilson2 merged 5 commits intomlflow:masterfrom
BenWilson2:prophet-docs-cleanup

Conversation

@BenWilson2
Copy link
Member

@BenWilson2 BenWilson2 commented Nov 12, 2025 •
edited by github-actions bot
Loading

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/18814/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/18814/merge#subdirectory=libs/skinny

For Databricks, use the following command:

%sh curl -LsSf https://raw.githubusercontent.com/mlflow/mlflow/HEAD/dev/install-skinny.sh | sh -s pull/18814/merge

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Cleans up a bunch of junk in the Prophet docs

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/tracking: Tracking Service, tracking client APIs, autologging
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/evaluation: MLflow model evaluation features, evaluation metrics, and evaluation workflows
  • area/gateway: MLflow AI Gateway client APIs, server, and third-party integrations
  • area/prompts: MLflow prompt engineering features, prompt templates, and prompt management
  • area/tracing: MLflow Tracing features, tracing APIs, and LLM tracing functionality
  • area/projects: MLproject format, project running backends
  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages

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

Should this PR be included in the next patch release?

Yes should be selected for bug fixes, documentation updates, and other small changes. No should be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.

What is a minor/patch release?
  • Minor release: a release that increments the second part of the version number (e.g., 1.2.0 -> 1.3.0).
    Bug fixes, doc updates and new features usually go into minor releases.
  • Patch release: a release that increments the third part of the version number (e.g., 1.2.0 -> 1.2.1).
    Bug fixes and doc updates usually go into patch releases.
  • Yes (this PR will be cherry-picked and included in the next patch release)
  • No (this PR will be included in the next minor release)

@BenWilson2
Cleanup Prophet docs
2e8356d 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@github-actions github-actions bot added v3.6.1 area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. labels Nov 12, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 12, 2025 •
edited
Loading

Documentation preview for f9afad1 is available at:

Changed Pages (4)
More info
  • Ignore this comment if this PR does not change the documentation.
  • The preview is updated when a new commit is pushed to this PR.
  • This comment was created by this workflow run.
  • The documentation was built by this workflow run.

Copilot AI reviewed Nov 12, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR significantly cleans up the Prophet documentation by removing verbose marketing-style content and replacing it with concise, technical documentation. The changes reduce the index page from 247 lines to 121 lines and the guide from 1402 lines to 329 lines while maintaining all essential information.

Key Changes:

  • Streamlined documentation to focus on technical content and practical examples
  • Replaced promotional language with straightforward technical descriptions
  • Consolidated code examples to show only essential patterns
  • Added modern UI components (FeatureHighlights, TilesGrid) for better navigation

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/docs/classic-ml/traditional-ml/prophet/index.mdx Condensed overview page with updated component imports, clearer introduction about Prophet and MLflow integration, and focused code examples for model logging
docs/docs/classic-ml/traditional-ml/prophet/guide/index.mdx Streamlined comprehensive guide with practical examples covering model logging, cross-validation, hyperparameter optimization, model registry, and batch forecasting workflows

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

docs/docs/classic-ml/traditional-ml/prophet/guide/index.mdx Outdated
& (merged["y"] <= merged["yhat_upper"])
# Cross-validation
cv_results = cross_validation(
model, initial="365 days", horizon="180 days"
Copy link

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

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

The cross_validation function call is missing the required period parameter. Prophet's cross_validation requires initial, period, and horizon parameters. Add period to specify the spacing between cutoff dates.

Example fix:

cv_results = cross_validation(
    model, initial="365 days", period="90 days", horizon="180 days"
)
Suggested change
model, initial="365 days", horizon="180 days"
model, initial="365 days", period="90 days", horizon="180 days"

Copilot uses AI. Check for mistakes.
Copy link
Member Author

@BenWilson2 BenWilson2 Nov 13, 2025

Choose a reason for hiding this comment

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

They're actually optional parameters. But, in the interests of not showing inferred behavior for unspecified default params, I'll add it.

docs/docs/classic-ml/traditional-ml/prophet/guide/index.mdx Outdated
if large_gaps > 0:
quality_issues.append(f"Large date gaps found: {large_gaps}")
# Collect metrics
cv_results = cross_validation(model, initial="365 days", horizon="90 days")
Copy link

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

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

The cross_validation function call is missing the required period parameter. Prophet's cross_validation requires initial, period, and horizon parameters. Add period to specify the spacing between cutoff dates.

Example fix:

cv_results = cross_validation(model, initial="365 days", period="90 days", horizon="90 days")
Suggested change
cv_results = cross_validation(model, initial="365 days", horizon="90 days")
cv_results = cross_validation(model, initial="365 days", period="90 days", horizon="90 days")

Copilot uses AI. Check for mistakes.
@BenWilson2
nit
fc9651b 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
B-Step62
B-Step62 approved these changes Nov 13, 2025
View reviewed changes
Copy link
Collaborator

@B-Step62 B-Step62 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM, great simplification. Similarly to other PRs, perhaps we can merge two pages for simplification, if it's not too long.

@BenWilson2
consolidate
b7ca385 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@BenWilson2 BenWilson2 enabled auto-merge November 13, 2025 22:35
harupy
harupy reviewed Nov 14, 2025
View reviewed changes
docs/docs/classic-ml/traditional-ml/prophet/index.mdx Outdated
# Log component plots
fig = model.plot_components(forecast)
plt.savefig("forecast_components.png")
mlflow.log_artifact("forecast_components.png")
Copy link
Member

@harupy harupy Nov 14, 2025

Choose a reason for hiding this comment

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

let's use log_figure and an in-memory figure object

Copy link
Member Author

@BenWilson2 BenWilson2 Nov 14, 2025

Choose a reason for hiding this comment

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

good call! Definitely better than using the log artifact API. Thanks Haru!

@BenWilson2 BenWilson2 disabled auto-merge November 14, 2025 02:28
@BenWilson2
Merge branch 'master' into prophet-docs-cleanup
77f48ca 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@BenWilson2
cleanup
f9afad1 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@BenWilson2 BenWilson2 added this pull request to the merge queue Nov 14, 2025
Merged via the queue into mlflow:master with commit abd8bd6 Nov 14, 2025
64 of 66 checks passed
@BenWilson2 BenWilson2 deleted the prophet-docs-cleanup branch November 14, 2025 15:23
jackiehimel pushed a commit to jackiehimel/mlflow that referenced this pull request Nov 21, 2025
@BenWilson2 @jackiehimel
Cleanup Prophet docs (mlflow#18814)
f2f16d5 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
Signed-off-by: Jackie Himel <jacqueline.himel@vanderbilt.edu>
mprahl pushed a commit to opendatahub-io/mlflow that referenced this pull request Nov 21, 2025
@BenWilson2 @mprahl
Cleanup Prophet docs (mlflow#18814)
5716aba 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
Tian-Sky-Lan pushed a commit to Tian-Sky-Lan/mlflow that referenced this pull request Nov 24, 2025
@BenWilson2 @Tian-Sky-Lan
Cleanup Prophet docs (mlflow#18814)
fa3a0c2 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
Signed-off-by: Tian Lan <sky.blue266000@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@harupy harupy harupy approved these changes

@B-Step62 B-Step62 B-Step62 approved these changes

Assignees

No one assigned

Labels

area/docs Documentation issues rn/documentation Mention under Documentation Changes in Changelogs. v3.6.1

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@BenWilson2 @harupy @B-Step62