Skip to content
This repository was archived by the owner on Nov 19, 2025. It is now read-only.

docs: adds a known_errors.rst to improve UX - #332

Draft
terrykong wants to merge 2 commits into
mainfrom
tk/0.5/ckpt-strict-doc
Draft

terrykong wants to merge 2 commits into
mainfrom
tk/0.5/ckpt-strict-doc

Conversation

@terrykong

Copy link
Copy Markdown
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)

Signed-off-by: Terry Kong <terryk@nvidia.com>
@terrykong
terrykong requested review from jgerh and ko3n1g 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 (add before Run CICD label) and removed documentation Improvements or additions to documentation labels Oct 2, 2024
Signed-off-by: Terry Kong <terryk@nvidia.com>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 2, 2024
@terrykong

Copy link
Copy Markdown
Collaborator Author

Note to self: re-home known_errors.rst

@terrykong
terrykong marked this pull request as draft October 4, 2024 23:59

This branch has not been deployed

No deployments
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation r0.5.0 creates cherry-pick PR after merge (add before Run CICD label)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant