add docstring for _log_api_usage_once #5273
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
💊 CI failures summary and remediationsAs of commit 250535c (more details on the Dr. CI page): 💚 💚 Looks good so far! There are no failures yet. 💚 💚 This comment was automatically generated by Dr. CI (expand for details).Please report bugs/suggestions to the (internal) Dr. CI Users group. |
kazhang
force-pushed
the
log-doc-string
branch
from
4ef8486 to
dbbf31e
Compare
datumbox
reviewed
Jan 25, 2022
There was a problem hiding this comment.
@kazhang Previously the community raised concerns over the nature of logging. Though the proposed documentation is factually correct, I feel it doesn't adequately explain what this is and how it can be used.
I would recommend to cover the following points within the docstring:
- The function provides similar functionality as the
loggingmodule from the Python stdlib. - It can be used for debugging purposes to log which methods are used and by default it is inactive (no-op), unless the user manually subscribes a logger via the SetAPIUsageLogger method.
- It doesn't collect any data from open-source users and by default is no-op.
datumbox
approved these changes
Jan 26, 2022
|
Hey @datumbox! You merged this PR, but no labels were added. The list of valid labels is available at https://github.com/pytorch/vision/blob/main/.github/process_commit.py |
facebook-github-bot
pushed a commit
that referenced
this pull request
Feb 3, 2022
Summary: * add docstring for _log_api_usage_once * lint * rephrase Reviewed By: kazhang Differential Revision: D33927494 fbshipit-source-id: 95c33f2f0fb8b576ce5528cc98f33661556c4819 Co-authored-by: Vasilis Vryniotis <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes: #4957