-
Notifications
You must be signed in to change notification settings - Fork 446
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Change docstring location and learning hyperparams for object detection #2699
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we need to select one of options
[option1]
# Copyright (C) 2023 Intel Corporation
# SPDX-License-Identifier: Apache-2.0
"""~~~~~"""
[option2]
# Copyright (C) 2023 Intel Corporation
# SPDX-License-Identifier: Apache-2.0
"""~~~~~"""
[option3]
# Copyright (C) 2023 Intel Corporation
# SPDX-License-Identifier: Apache-2.0
#
"""~~~~~"""
This may not seem like a big deal, but it's something that needs to be taken into account to make our code look neat.
Of course, it doesn't have to be resolved in this PR. I just want to hear your thoughts.
I agree, we need a PR to fix all the docstring and license headers. We will then need to stick to it not to break consistency. I would personally prefer the following: """Docstring Title Here.
Here is some docstring explanation.
This part will be used within the documentation.
"""
# Copyright (C) 2023 Intel Corporation
# SPDX-License-Identifier: Apache-2.0
from package1 import module1
import library
... |
I prefer @samet-akcay's option which is docstring before License. |
…on (openvinotoolkit#2699) Change docstring location and learning hyperparams
Summary
This PR is for changing learning hyperparameters of object detection recipes.
Furthermore this PR also changes some wrong docstring location
How to test
Checklist
License
Feel free to contact the maintainers if that's a concern.