Skip to content

[doc] add booster docstring and fix autodoc#3789

Merged
ver217 merged 2 commits intohpcaitech:mainfrom
ver217:doc/booster
May 22, 2023
Merged

[doc] add booster docstring and fix autodoc#3789
ver217 merged 2 commits intohpcaitech:mainfrom
ver217:doc/booster

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

📝 What does this PR do?

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

  1. Some methods of booster misses docstring. Added them.
  2. Fix autodoc for class. It will show all methods of a class. No need to refer its function.

💥 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 the documentation Improvements or additions to documentation label May 19, 2023
@github-actions
Copy link
Copy Markdown
Contributor

The code coverage for the changed files is 84%.

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

@ver217 ver217 merged commit 72688ad into hpcaitech:main May 22, 2023
@ver217 ver217 deleted the doc/booster branch May 22, 2023 02:56
FrankLeeeee pushed a commit that referenced this pull request May 24, 2023
* [doc] add docstr for booster methods

* [doc] fix autodoc
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants