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.

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

docs: add a python sdk example for log following. #8981

Merged
merged 1 commit into from
Apr 8, 2024
Merged

Conversation

ioga
Copy link
Contributor

@ioga ioga commented Mar 8, 2024

Description

Test Plan

N/A

Commentary (optional)

Checklist

  • Changes have been manually QA'd
  • User-facing API changes need the "User-facing API Change" label.
  • Release notes should be added as a separate file under docs/release-notes/.
    See Release Note for details.
  • Licenses should be included for new code which was copied and/or modified from any external code.

Ticket

@cla-bot cla-bot bot added the cla-signed label Mar 8, 2024
@determined-ci determined-ci requested a review from a team March 8, 2024 20:15
@determined-ci determined-ci added the documentation Improvements or additions to documentation label Mar 8, 2024
Copy link

netlify bot commented Mar 8, 2024

Deploy Preview for determined-ui ready!

Name Link
🔨 Latest commit 03b78c1
🔍 Latest deploy log https://app.netlify.com/sites/determined-ui/deploys/65eb71cd1363620008d04568
😎 Deploy Preview https://deploy-preview-8981--determined-ui.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@wes-turner wes-turner left a comment

Choose a reason for hiding this comment

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

LGTM on content; leaving form for docs to review

<https://github.com/determined-ai/determined-examples/tree/e499000d92a0a973d1f40a419934f393957a3296/blog/python_sdk_demo>`__
to learn how to run and administer experiments using the Python SDK.
exp = client.create_experiment(...)
for logline in exp.await_first_trial().iter_logs():
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it obvious to the reader that this blocks on the production of log lines? If yes, cool. If not, I think that aspect deserves a small comment.

Copy link
Member

@tara-det-ai tara-det-ai left a comment

Choose a reason for hiding this comment

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

LGTM

@ioga ioga merged commit e70d38e into main Apr 8, 2024
72 of 84 checks passed
@ioga ioga deleted the sdk-pro-tips branch April 8, 2024 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants