Skip to content

[doc] Update booster user documents.#4669

Merged
Fridge003 merged 5 commits intohpcaitech:mainfrom
Fridge003:doc
Sep 12, 2023
Merged

[doc] Update booster user documents.#4669
Fridge003 merged 5 commits intohpcaitech:mainfrom
Fridge003:doc

Conversation

@Fridge003
Copy link
Copy Markdown
Contributor

📌 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

#4628

📝 What does this PR do?

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

  • Rewrite some docstrings in booster.py
  • Update user documents of booster, including booster_api.md, booster_checkpoint.md and booster_plugins.md

💥 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.

@Fridge003 Fridge003 requested review from FrankLeeeee and ver217 and removed request for ver217 September 8, 2023 08:14
Comment thread colossalai/booster/booster.py Outdated
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Sep 8, 2023

The code coverage for the changed files is 85%.

Click me to view the complete report
Name                                Stmts   Miss  Cover
-------------------------------------------------------
colossalai/booster/booster.py          69     12    83%
colossalai/checkpoint_io/utils.py     321     46    86%
-------------------------------------------------------
TOTAL                                 390     58    85%

Comment thread docs/source/en/basics/booster_plugins.md Outdated
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Sep 8, 2023

The code coverage for the changed files is 81%.

Click me to view the complete report
Name                                Stmts   Miss  Cover
-------------------------------------------------------
colossalai/booster/booster.py          69     12    83%
colossalai/checkpoint_io/utils.py     321     61    81%
-------------------------------------------------------
TOTAL                                 390     73    81%

@Fridge003 Fridge003 enabled auto-merge (squash) September 11, 2023 03:47
Comment thread docs/source/en/basics/booster_plugins.md Outdated
@github-actions
Copy link
Copy Markdown
Contributor

The code coverage for the changed files is 83%.

Click me to view the complete report
Name                            Stmts   Miss  Cover
---------------------------------------------------
colossalai/booster/booster.py      69     12    83%
---------------------------------------------------
TOTAL                              69     12    83%

@Fridge003 Fridge003 merged commit 1d45473 into hpcaitech:main Sep 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants