Skip to content

Add troubleshooting guide and enhance error messages for ADS Forecast Operator #1248

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

codeloop
Copy link
Member

This PR improves the developer experience by providing clear, actionable guidance when errors occur during forecast operator usage.

  • Added comprehensive troubleshooting guide (troubleshooting.MD) for ADS Forecast Operator
  • Enhanced error messages across multiple files to point users to the troubleshooting documentation
  • Added links to troubleshooting guide in key error classes:
    • ForecastSchemaYamlError
    • ForecastInputDataError
    • UnSupportedModelError
    • ValueError (AutoMLX explanation mode)
    • InsufficientDataError

@codeloop codeloop requested a review from prasankh August 13, 2025 16:49
@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Aug 13, 2025
ahosler
ahosler previously approved these changes Aug 14, 2025
Copy link
Member

@ahosler ahosler left a comment

Choose a reason for hiding this comment

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

Awesome!

mrDzurb
mrDzurb previously approved these changes Aug 15, 2025
@@ -23,4 +24,5 @@ def __init__(self, error: str):
"Invalid input data. Check the input data and ensure it "
"complies with the validation criteria. \n"
f"{error}"
"\nPlease refer to the troubleshooting guide at https://github.com/oracle/accelerated-data-science/blob/main/ads/opctl/operator/lowcode/forecast/model/troubleshooting.MD for resolution steps."
Copy link
Member

Choose a reason for hiding this comment

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

I'm wondering if it would be better to have such docs in the https://github.com/oracle-samples/oci-data-science-ai-samples repo

Copy link
Member Author

Choose a reason for hiding this comment

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

Moved to ai-samples.

prasankh
prasankh previously approved these changes Aug 19, 2025
Copy link
Member

@prasankh prasankh left a comment

Choose a reason for hiding this comment

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

Nit: the troubleshooting link is repeated in exceptions, maybe we can define it as a constant (e.g. TROUBLESHOOTING_GUIDE) and reuse it.

@codeloop codeloop dismissed stale reviews from mrDzurb, prasankh, and ahosler via 2400e11 August 21, 2025 14:27
@codeloop codeloop enabled auto-merge August 21, 2025 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants