deepmodeling / dpgen2

2nd generation of the Deep Potential GENerator
https://docs.deepmodeling.com/projects/dpgen2/
GNU Lesser General Public License v3.0
33 stars 25 forks source link

fix the docstring styles #128

Closed njzjz closed 1 year ago

njzjz commented 1 year ago

Follow the Numpydoc style guide.

codecov-commenter commented 1 year ago

Codecov Report

Base: 84.41% // Head: 84.41% // No change to project coverage :thumbsup:

Coverage data is based on head (d3530b2) compared to base (b35becb). Patch has no changes to coverable lines.

:mega: This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #128 +/- ## ======================================= Coverage 84.41% 84.41% ======================================= Files 74 74 Lines 3445 3445 ======================================= Hits 2908 2908 Misses 537 537 ``` | [Impacted Files](https://codecov.io/gh/deepmodeling/dpgen2/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepmodeling) | Coverage Δ | | |---|---|---| | [dpgen2/conf/alloy\_conf.py](https://codecov.io/gh/deepmodeling/dpgen2/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepmodeling#diff-ZHBnZW4yL2NvbmYvYWxsb3lfY29uZi5weQ==) | `86.79% <ø> (ø)` | | | [dpgen2/conf/conf\_generator.py](https://codecov.io/gh/deepmodeling/dpgen2/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepmodeling#diff-ZHBnZW4yL2NvbmYvY29uZl9nZW5lcmF0b3IucHk=) | `93.75% <ø> (ø)` | | | [dpgen2/entrypoint/main.py](https://codecov.io/gh/deepmodeling/dpgen2/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepmodeling#diff-ZHBnZW4yL2VudHJ5cG9pbnQvbWFpbi5weQ==) | `53.60% <ø> (ø)` | | | [dpgen2/exploration/render/traj\_render.py](https://codecov.io/gh/deepmodeling/dpgen2/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepmodeling#diff-ZHBnZW4yL2V4cGxvcmF0aW9uL3JlbmRlci90cmFqX3JlbmRlci5weQ==) | `78.57% <ø> (ø)` | | | [dpgen2/exploration/report/report.py](https://codecov.io/gh/deepmodeling/dpgen2/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepmodeling#diff-ZHBnZW4yL2V4cGxvcmF0aW9uL3JlcG9ydC9yZXBvcnQucHk=) | `75.00% <ø> (ø)` | | | [dpgen2/exploration/report/report\_adaptive\_lower.py](https://codecov.io/gh/deepmodeling/dpgen2/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepmodeling#diff-ZHBnZW4yL2V4cGxvcmF0aW9uL3JlcG9ydC9yZXBvcnRfYWRhcHRpdmVfbG93ZXIucHk=) | `97.35% <ø> (ø)` | | | [dpgen2/exploration/report/report\_trust\_levels.py](https://codecov.io/gh/deepmodeling/dpgen2/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepmodeling#diff-ZHBnZW4yL2V4cGxvcmF0aW9uL3JlcG9ydC9yZXBvcnRfdHJ1c3RfbGV2ZWxzLnB5) | `98.37% <ø> (ø)` | | | [dpgen2/exploration/scheduler/scheduler.py](https://codecov.io/gh/deepmodeling/dpgen2/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepmodeling#diff-ZHBnZW4yL2V4cGxvcmF0aW9uL3NjaGVkdWxlci9zY2hlZHVsZXIucHk=) | `98.40% <ø> (ø)` | | | [dpgen2/exploration/scheduler/stage\_scheduler.py](https://codecov.io/gh/deepmodeling/dpgen2/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepmodeling#diff-ZHBnZW4yL2V4cGxvcmF0aW9uL3NjaGVkdWxlci9zdGFnZV9zY2hlZHVsZXIucHk=) | `76.00% <ø> (ø)` | | | [dpgen2/exploration/selector/conf\_filter.py](https://codecov.io/gh/deepmodeling/dpgen2/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepmodeling#diff-ZHBnZW4yL2V4cGxvcmF0aW9uL3NlbGVjdG9yL2NvbmZfZmlsdGVyLnB5) | `95.23% <ø> (ø)` | | | ... and [13 more](https://codecov.io/gh/deepmodeling/dpgen2/pull/128?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepmodeling) | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepmodeling). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=deepmodeling)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.