Skip to content

add doc: create a model#1143

Merged
amcadmus merged 2 commits intodeepmodeling:develfrom
njzjz:doc-create-a-new-model
Sep 14, 2021
Merged

add doc: create a model#1143
amcadmus merged 2 commits intodeepmodeling:develfrom
njzjz:doc-create-a-new-model

Conversation

@njzjz
Copy link
Member

@njzjz njzjz commented Sep 13, 2021

No description provided.


## Design a new component

When creating a new component, take descriptor as the example, you should inherit [`Descriptor`](deepmd.descriptor.descriptor.Descriptor) class and override several methods. Abstract methods such as [`build`](deepmd.descriptor.descriptor.Descriptor.build) must be implemented and others are not. You should keep arguments of these methods unchanged.
Copy link
Member

Choose a reason for hiding this comment

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

The links are broken in markdown

Copy link
Member Author

Choose a reason for hiding this comment

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

The links will be parsed in sphinx. I have no idea how to make it also work in GitHub, so I change to {py:class}deepmd.descriptor.descriptor.Descriptor which will also generate links in sphinx.

@codecov-commenter
Copy link

Codecov Report

Merging #1143 (a0a603a) into devel (76bc05c) will decrease coverage by 11.37%.
The diff coverage is n/a.

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

@@             Coverage Diff             @@
##            devel    #1143       +/-   ##
===========================================
- Coverage   75.66%   64.28%   -11.38%     
===========================================
  Files          88        5       -83     
  Lines        7034       14     -7020     
===========================================
- Hits         5322        9     -5313     
+ Misses       1712        5     -1707     
Impacted Files Coverage Δ
deepmd/loss/ener.py
deepmd/entrypoints/convert.py
deepmd/utils/data.py
source/op/_tabulate_grad.py
deepmd/descriptor/se_a.py
deepmd/cluster/__init__.py
deepmd/utils/graph.py
deepmd/infer/deep_pot.py
deepmd/infer/__init__.py
deepmd/utils/type_embed.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 76bc05c...00d0ce3. Read the comment docs.

@amcadmus amcadmus merged commit b032878 into deepmodeling:devel Sep 14, 2021
@njzjz njzjz deleted the doc-create-a-new-model branch September 14, 2021 02:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants