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 profiling section for trainer API UG [MD-373] #9177

Merged
merged 2 commits into from
Apr 18, 2024

Conversation

azhou-determined
Copy link
Contributor

@azhou-determined azhou-determined commented Apr 16, 2024

Ticket

Description

Test Plan

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.

@cla-bot cla-bot bot added the cla-signed label Apr 16, 2024
@determined-ci determined-ci added the documentation Improvements or additions to documentation label Apr 16, 2024
@determined-ci determined-ci requested a review from a team April 16, 2024 16:57
Copy link

netlify bot commented Apr 16, 2024

Deploy Preview for determined-ui ready!

Name Link
🔨 Latest commit d271358
🔍 Latest deploy log https://app.netlify.com/sites/determined-ui/deploys/662144746d937f00089b4490
😎 Deploy Preview https://deploy-preview-9177--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.

trainer.fit(
...,
+ profiling_enabled=True
)
Copy link
Member

Choose a reason for hiding this comment

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

Profiling

When training on cluster, you can enable the system metrics profiler by adding a parameter to your fit() call:

.. code:: diff
trainer.fit(
...,

  • profiling_enabled=True
    )

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.

added suggestion

@azhou-determined azhou-determined changed the title docs: add profiling section for trainer API UG docs: add profiling section for trainer API UG [MD-373] Apr 18, 2024
@determined-ci determined-ci requested a review from a team April 18, 2024 16:04
@azhou-determined azhou-determined merged commit dd7f4b5 into main Apr 18, 2024
69 of 81 checks passed
@azhou-determined azhou-determined deleted the trainer-api-profiling-docs branch April 18, 2024 16:21
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.

3 participants