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.

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

add examples to docstings #1010

Merged
merged 2 commits into from
Aug 22, 2021
Merged

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Aug 21, 2021

Directly copied from doc/inference/python.md.

@codecov-commenter
Copy link

Codecov Report

Merging #1010 (fbdd401) into devel (472d7c4) will decrease coverage by 10.31%.
The diff coverage is n/a.

❗ Current head fbdd401 differs from pull request most recent head 9165b3f. Consider uploading reports for the commit 9165b3f to get more accurate results
Impacted file tree graph

@@             Coverage Diff             @@
##            devel    #1010       +/-   ##
===========================================
- Coverage   74.59%   64.28%   -10.32%     
===========================================
  Files          86        5       -81     
  Lines        6921       14     -6907     
===========================================
- Hits         5163        9     -5154     
+ Misses       1758        5     -1753     
Impacted Files Coverage Δ
source/op/_tabulate_grad.py
deepmd/entrypoints/config.py
deepmd/fit/ener.py
deepmd/train/run_options.py
deepmd/__main__.py
source/op/_prod_force_se_r_grad.py
deepmd/loss/__init__.py
deepmd/entrypoints/test.py
source/op/_prod_force_grad.py
deepmd/fit/dipole.py
... and 69 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 472d7c4...9165b3f. Read the comment docs.

@amcadmus amcadmus merged commit e9edec6 into deepmodeling:devel Aug 22, 2021
@njzjz njzjz deleted the docstring-example branch August 22, 2021 03:18
gzq942560379 pushed a commit to HPC-AI-Team/deepmd-kit that referenced this pull request Sep 2, 2021
* add examples to `DeepPot`'s docstring

* add an example to `calc_model_devi`'s docstring
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants