Skip to content

[doc] add tutorial for booster checkpoint#3785

Merged
ver217 merged 9 commits intohpcaitech:mainfrom
ver217:doc/booster-ckpt
May 19, 2023
Merged

[doc] add tutorial for booster checkpoint#3785
ver217 merged 9 commits intohpcaitech:mainfrom
ver217:doc/booster-ckpt

Conversation

@ver217
Copy link
Copy Markdown
Contributor

@ver217 ver217 commented May 19, 2023

📌 Checklist before creating the PR

  • I have created an issue for this PR for traceability
  • The title follows the standard format: [doc/gemini/tensor/...]: A concise description
  • I have added relevant tags if possible for us to better distinguish different PRs

🚨 Issue number

Link this PR to your issue with words like fixed to automatically close the linked issue upon merge

e.g. fixed #1234, closed #1234, resolved #1234

Closes #3784

📝 What does this PR do?

Summarize your work here.
if you have any plots/diagrams/screenshots/tables, please attach them here.

  1. Add docstring of Booster about checkpoint
  2. Add a tutorial for booster checkpoint
  3. Add cuation about ckpt for plugins

💥 Checklist before requesting a review

  • I have linked my PR to an issue (instruction)
  • My issue clearly describes the problem/feature/proposal, with diagrams/charts/table/code if possible
  • I have performed a self-review of my code
  • I have added thorough tests.
  • I have added docstrings for all the functions/methods I implemented

⭐️ Do you enjoy contributing to Colossal-AI?

  • 🌝 Yes, I do.
  • 🌚 No, I don't.

Tell us more if you don't enjoy contributing to Colossal-AI.

@ver217 ver217 added documentation Improvements or additions to documentation API related to API changes labels May 19, 2023
@ver217 ver217 requested a review from FrankLeeeee May 19, 2023 09:19
@github-actions
Copy link
Copy Markdown
Contributor

The code coverage for the changed files is 76%.

Click me to view the complete report
Name                            Stmts   Miss  Cover
---------------------------------------------------
colossalai/booster/booster.py      63     15    76%
---------------------------------------------------
TOTAL                              63     15    76%

@ver217 ver217 merged commit 60e6a15 into hpcaitech:main May 19, 2023
@ver217 ver217 deleted the doc/booster-ckpt branch May 19, 2023 10:05
FrankLeeeee pushed a commit that referenced this pull request May 24, 2023
* [doc] add checkpoint related docstr for booster

* [doc] add en checkpoint doc

* [doc] add zh checkpoint doc

* [doc] add booster checkpoint doc in sidebar

* [doc] add cuation about ckpt for plugins

* [doc] add doctest placeholder

* [doc] add doctest placeholder

* [doc] add doctest placeholder
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

API related to API changes documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[doc] add tutorial for booster checkpoint

2 participants