Skip to content

add type-embedding developer doc#762

Merged
amcadmus merged 3 commits intodeepmodeling:develfrom
tuoping:doc-typeembeddevel
Jun 19, 2021
Merged

add type-embedding developer doc#762
amcadmus merged 3 commits intodeepmodeling:develfrom
tuoping:doc-typeembeddevel

Conversation

@tuoping
Copy link
Collaborator

@tuoping tuoping commented Jun 17, 2021

Copied from wiki. #753

@tuoping tuoping requested review from amcadmus, njzjz and yhliu918 June 17, 2021 02:40
@codecov-commenter
Copy link

codecov-commenter commented Jun 17, 2021

Codecov Report

Merging #762 (75e2591) into devel (5e9648e) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##            devel     #762   +/-   ##
=======================================
  Coverage   74.21%   74.21%           
=======================================
  Files          82       82           
  Lines        6520     6520           
=======================================
  Hits         4839     4839           
  Misses       1681     1681           

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 5e9648e...75e2591. Read the comment docs.

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.

It is better to ref to the development doc in train-se-e2-a-tebd.md

@tuoping
Copy link
Collaborator Author

tuoping commented Jun 17, 2021

Should we add a link to train-se-e2-a-tebd.md in getting-started.md?

The difference between two variants above is whether using the information of centric atom when generating the descriptor. Users can choose by modifying the `type_one_side` hyper-parameter in the input json file.

## How to use
A detailed introduction can be found at [`se_e2_a_tebd`](https://github.com/deepmodeling/deepmd-kit/blob/v2.0.0.b1/doc/train-se-e2-a-tebd.md). Looking for a fast start up, you can simply add a `type_embedding` section in the input json file as displayed in the following, and the algorithm will adopt atom type embedding algorithm automatically.
Copy link
Member

Choose a reason for hiding this comment

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

Could you use the relative link here?

@njzjz njzjz linked an issue Jun 17, 2021 that may be closed by this pull request
@amcadmus amcadmus merged commit 0c7f490 into deepmodeling:devel Jun 19, 2021
gzq942560379 pushed a commit to HPC-AI-Team/deepmd-kit that referenced this pull request Sep 1, 2021
* add type-embedding developer doc

* add link to development/type-embedding.md in train-se-e2-a-tebd.md

* changed the link in doc/development/type-embedding.md to relative.

Co-authored-by: tuoping <abby@DESKTOP-LV5KL0D.localdomain>
njzjz added a commit to njzjz/deepmd-kit that referenced this pull request Sep 21, 2023
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.

Wiki page needs update

5 participants