chore(trainer): improve get_job_logs docstring

[pandu992003]

This PR improves the documentation for the get_job_logs method in TrainerClient.

Changes:

• Enhanced docstring with clearer explanations
• Added usage example for real-time log streaming
• Improved readability and formatting

This helps developers better understand how to use the log retrieval functionality.

[google-oss-prow]

[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 electronic-waste 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:

• OWNERS

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

[github-actions]

🎉 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:

• Slack: Join our #kubeflow-ml-experience and #kubeflow-trainer Slack channels
• Meetings: Attend the Kubeflow SDK and ML Experience bi-weekly meetings

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

[Copilot]

Pull request overview

This PR updates the TrainerClient.get_job_logs docstring to better explain log retrieval and provide a streaming usage example for developers using the Kubeflow Trainer Python API.

Changes:

• Rewrote the get_job_logs docstring for improved clarity and formatting.
• Added an inline usage example demonstrating real-time log streaming with follow=True.
• Updated parameter/return descriptions and added a note about empty output.

[Copilot]

The docstring starts with a blank line (the opening triple-quote is on its own line), which introduces an empty first line in generated docs/help(); align with the rest of this file by putting the one-line summary immediately after the opening """.

Suggested change

	"""
	Retrieve logs from a specific step of a TrainJob.
	"""Retrieve logs from a specific step of a TrainJob.

[Copilot]

The Args section switches to "name (str):" style, but other TrainerClient methods in this file consistently use Google-style "name:" without repeating types; please keep the Args formatting consistent within the module (either revert here or update the surrounding methods for the same style).

Suggested change

	name (str): Name of the TrainJob.
	step (str): Step of the TrainJob to collect logs from
	(e.g., dataset-initializer or node-0).
	follow (bool, optional): If True, streams logs in real-time.
	Defaults to False.
	name: Name of the TrainJob.
	step: Step of the TrainJob to collect logs from
	(e.g., dataset-initializer or node-0).
	follow: If True, streams logs in real-time. Defaults to False.

[Copilot]

This docstring removed the Raises section, but get_job_logs can still raise (e.g., Kubernetes backend surfaces TimeoutError/RuntimeError via get_job, and LocalProcess backend raises ValueError when the job name is unknown); please document the relevant exceptions again so callers know what to handle.

Suggested change

	Raises:
	ValueError: The TrainJob with the given name does not exist (e.g., LocalProcess backend).
	TimeoutError: Timeout while retrieving the TrainJob or its logs (e.g., Kubernetes backend).
	RuntimeError: Failed to retrieve the TrainJob or its logs (e.g., Kubernetes backend).

[Copilot]

The docstring says logs are retrieved "from a specific step", but several backends treat the default step==node-0 as a sentinel to return logs from multiple steps/nodes (not just node-0); please clarify the default/step semantics so users know what output to expect.

[pandu992003]

Hi, thank you for reviewing! Please let me know if any changes are needed.

[pandu992003]

Hi, thank you for reviewing! I’ve addressed all checks and updated the PR. Please let me know if any further improvements are needed.