Skip to content

chore(docs): add SparkClient to SDK API reference#355

Open
khanavi272-spec wants to merge 2 commits intokubeflow:mainfrom
khanavi272-spec:docs-add-sparkclient
Open

chore(docs): add SparkClient to SDK API reference#355
khanavi272-spec wants to merge 2 commits intokubeflow:mainfrom
khanavi272-spec:docs-add-sparkclient

Conversation

@khanavi272-spec
Copy link

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, in Fixes #<issue number>, #<issue number>, ... format, will close the issue(s) when PR gets merged):

Fixes #

Checklist:

  • Docs included if any changes are user facing

Copilot AI review requested due to automatic review settings March 4, 2026 16:49
@google-oss-prow
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign astefanutti for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@github-actions
Copy link
Contributor

github-actions bot commented Mar 4, 2026

🎉 Welcome to the Kubeflow SDK! 🎉

Thanks for opening your first PR! We're happy to have you as part of our community 🚀

Here's what happens next:

  • If you haven't already, please check out our Contributing Guide for repo-specific guidelines and the Kubeflow Contributor Guide for general community standards
  • Our team will review your PR soon! cc @kubeflow/kubeflow-sdk-team

Join the community:

Feel free to ask questions in the comments if you need any help or clarification!
Thanks again for contributing to Kubeflow! 🙏

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

Adds SparkClient to the SDK’s Sphinx API reference so it appears alongside existing Trainer API documentation.

Changes:

  • Extend docs/source/train/api.rst to include an autodoc section for kubeflow.spark.SparkClient.

Comment on lines +44 to +46
.. autoclass:: kubeflow.spark.SparkClient
:members:
:show-inheritance:
Copy link

Copilot AI Mar 4, 2026

Choose a reason for hiding this comment

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

Adding .. autoclass:: kubeflow.spark.SparkClient will cause the docs CI job (uv sync --group docs) to import kubeflow.spark.api.spark_client, which imports pyspark at module import time; since pyspark isn’t installed in the docs dependency group, Sphinx will fail to build the docs. Fix by either mocking pyspark for autodoc (e.g., via autodoc_mock_imports in docs/source/conf.py) or ensuring the docs build installs the spark extra / pyspark dependency.

Suggested change
.. autoclass:: kubeflow.spark.SparkClient
:members:
:show-inheritance:
.. note::
The ``SparkClient`` API reference is not built in this documentation
configuration because it depends on the optional ``pyspark``/``spark``
extra, which is not installed for the docs build.

Copilot uses AI. Check for mistakes.
@google-oss-prow google-oss-prow bot added size/S and removed size/XS labels Mar 4, 2026
Copy link
Contributor

@astefanutti astefanutti left a comment

Choose a reason for hiding this comment

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

Thanks @khanavi272-spec!

/retitle chore(docs): add SparkClient to SDK API reference

/ok-to-test

fixes #354

@google-oss-prow google-oss-prow bot changed the title docs: add SparkClient to SDK API reference chore(docs): add SparkClient to SDK API reference Mar 5, 2026
@astefanutti
Copy link
Contributor

@khanavi272-spec can you sign the commit please.

/assign @andreyvelich @kramaranya @Shekharrajak @tariq-hasan

@google-oss-prow
Copy link
Contributor

@astefanutti: GitHub didn't allow me to assign the following users: tariq-hasan.

Note that only kubeflow members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

Details

In response to this:

@khanavi272-spec can you sign the commit please.

/assign @andreyvelich @kramaranya @Shekharrajak @tariq-hasan

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants