Skip to content
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.

Sign up for GitHub

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

Jump to bottom

add docstring for EnerFitting #1024

Merged
merged 2 commits into from
Aug 25, 2021
Merged

add docstring for EnerFitting #1024

merged 2 commits into from
Aug 25, 2021

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Aug 24, 2021 •
edited
Loading

Screenshot from 2021-08-24 18-34-05

@codecov-commenter
Copy link

codecov-commenter commented Aug 24, 2021 •
edited
Loading

Codecov Report

Merging #1024 (233b8cc) into devel (c0874f0) will decrease coverage by 7.85%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##            devel    #1024      +/-   ##
==========================================
- Coverage   82.86%   75.01%   -7.86%     
==========================================
  Files         119       86      -33     
  Lines       10110     6924    -3186     
==========================================
- Hits         8378     5194    -3184     
+ Misses       1732     1730       -2
Impacted Files Coverage Δ
deepmd/fit/ener.py 94.63% <ø> (ø)
source/api_cc/tests/test_deepdipole.cc
source/api_cc/tests/test_deeppot_model_devi.cc
source/lib/tests/test_gelu.cc
source/lib/tests/test_env_mat_a.cc
source/lib/tests/test_neighbor_list.cc
source/lib/tests/test_coord.cc
source/lib/tests/test_prod_virial_grad_a.cc
source/api_cc/tests/test_ewald.cc
source/lib/tests/test_fmt_nlist.cc
... and 24 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c0874f0...233b8cc. Read the comment docs.

@njzjz njzjz requested a review from amcadmus August 24, 2021 22:51
amcadmus
amcadmus reviewed Aug 24, 2021
View reviewed changes
Copy link
Member

@amcadmus amcadmus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you know how a document contributor can quickly preview the document with math?

deepmd/fit/ener.py Outdated Show resolved Hide resolved
deepmd/fit/ener.py Outdated Show resolved Hide resolved
@njzjz
Copy link
Member Author

njzjz commented Aug 25, 2021

Do you know how a document contributor can quickly preview the document with math?

Install with edit mode pip install -e . and regenerate using make html... I don't have other ideas.

@amcadmus amcadmus merged commit fd1f371 into deepmodeling:devel Aug 25, 2021
@njzjz njzjz deleted the docstring-fit-ener branch August 25, 2021 02:27
gzq942560379 pushed a commit to HPC-AI-Team/deepmd-kit that referenced this pull request Sep 2, 2021
@njzjz @amcadmus
add docstring for EnerFitting (deepmodeling#1024)
9394c18 
* add docstring for `EnerFitting`

* Apply suggestions from code review

Co-authored-by: Han Wang <[email protected]>

Co-authored-by: Han Wang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@amcadmus amcadmus amcadmus approved these changes

Assignees
No one assigned
Labels
None yet
Projects
No open projects
Add docstrings
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@njzjz @codecov-commenter @amcadmus