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: adds a known_errors.rst to improve UX #332

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

terrykong
Copy link
Collaborator

What does this PR do ?

Add a one line overview of what this PR aims to accomplish.

Changelog

  • Please update the CHANGELOG.md under next version with high level changes in this PR.

Usage

  • You can potentially add a usage example below
# Add a code snippet demonstrating how to use this 

Before your PR is "Ready for review"

Pre checks:

Checklist when contributing a new algorithm

  • Does the trainer resume and restore model state all states?
  • Does the trainer support all parallelism techniques(PP, TP, DP)?
  • Does the trainer support max_steps=-1 and validation?
  • Does the trainer only call APIs defined in alignable_interface.py?
  • Does the trainer have proper logging?

Additional Information

  • Related to # (issue)

@terrykong terrykong requested review from ko3n1g and jgerh October 2, 2024 00:21
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 2, 2024
@terrykong terrykong added r0.5.0 creates cherry-pick PR after merge and removed documentation Improvements or additions to documentation labels Oct 2, 2024
Signed-off-by: Terry Kong <[email protected]>
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 2, 2024
@terrykong
Copy link
Collaborator Author

Note to self: re-home known_errors.rst

@terrykong terrykong marked this pull request as draft October 4, 2024 23:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation r0.5.0 creates cherry-pick PR after merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant