Skip to content

[doc] Add missing docstrings to zero3 chunk search utilities#3572

Merged
1SAA merged 1 commit intohpcaitech:mainfrom
yhna940:chore/docs-zero3-chunkutils
Apr 17, 2023
Merged

[doc] Add missing docstrings to zero3 chunk search utilities#3572
1SAA merged 1 commit intohpcaitech:mainfrom
yhna940:chore/docs-zero3-chunkutils

Conversation

@yhna940
Copy link
Copy Markdown
Contributor

@yhna940 yhna940 commented Apr 16, 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

N/A

📝 What does this PR do?

This PR adds missing docstrings to the colossalai/zero/gemini/chunk/search_utils.py file. The previous version lacked proper documentation for some functions, making it difficult for users to understand their purpose and usage.

The changes made in this PR include:

  • Added detailed docstrings to _filter_exlarge_params, _get_unused_byte, _tensor_numel, and search_chunk_configuration functions.
  • The docstrings now provide information about the function's purpose, input arguments, and return values.
  • The added documentation will help users understand the implementation and usage of these functions better.

Please review and let me know if any modifications are required.

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

@1SAA 1SAA merged commit d329c29 into hpcaitech:main Apr 17, 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.

2 participants